Share via

@azure/arm-resources-profile-2020-09-01-hybrid package

  • Reference

Classes

ResourceManagementClient

Interfaces

Alias

The alias type.
AliasPath

The type of the paths for alias.
AliasPattern

The type of the pattern for an alias path.
BasicDependency

Deployment dependency information.
CloudError

An error response for a resource management request.
DebugSetting

The debug setting.
Dependency

Deployment dependency information.
Deployment

Deployment operation parameters.
DeploymentExportResult

The deployment export result.
DeploymentExtended

Deployment information.
DeploymentExtendedFilter

Deployment filter.
DeploymentListResult

List of deployments.
DeploymentOperation

Deployment operation information.
DeploymentOperationProperties

Deployment operation properties.
DeploymentOperations

Interface representing a DeploymentOperations.
DeploymentOperationsGetAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentOperationsGetAtScopeOptionalParams

Optional parameters.
DeploymentOperationsGetAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentOperationsGetAtTenantScopeOptionalParams

Optional parameters.
DeploymentOperationsGetOptionalParams

Optional parameters.
DeploymentOperationsListAtManagementGroupScopeNextOptionalParams

Optional parameters.
DeploymentOperationsListAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentOperationsListAtScopeNextOptionalParams

Optional parameters.
DeploymentOperationsListAtScopeOptionalParams

Optional parameters.
DeploymentOperationsListAtSubscriptionScopeNextOptionalParams

Optional parameters.
DeploymentOperationsListAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentOperationsListAtTenantScopeNextOptionalParams

Optional parameters.
DeploymentOperationsListAtTenantScopeOptionalParams

Optional parameters.
DeploymentOperationsListNextOptionalParams

Optional parameters.
DeploymentOperationsListOptionalParams

Optional parameters.
DeploymentOperationsListResult

List of deployment operations.
DeploymentProperties

Deployment properties.
DeploymentPropertiesExtended

Deployment properties with additional details.
DeploymentValidateResult

Information from validate template deployment response.
DeploymentWhatIf

Deployment What-if operation parameters.
DeploymentWhatIfProperties

Deployment What-if properties.
DeploymentWhatIfSettings

Deployment What-If operation settings.
Deployments

Interface representing a Deployments.
DeploymentsCalculateTemplateHashOptionalParams

Optional parameters.
DeploymentsCancelAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsCancelAtScopeOptionalParams

Optional parameters.
DeploymentsCancelAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsCancelAtTenantScopeOptionalParams

Optional parameters.
DeploymentsCancelOptionalParams

Optional parameters.
DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsCheckExistenceAtScopeOptionalParams

Optional parameters.
DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsCheckExistenceAtTenantScopeOptionalParams

Optional parameters.
DeploymentsCheckExistenceOptionalParams

Optional parameters.
DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsCreateOrUpdateAtScopeOptionalParams

Optional parameters.
DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

Optional parameters.
DeploymentsCreateOrUpdateOptionalParams

Optional parameters.
DeploymentsDeleteAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsDeleteAtScopeOptionalParams

Optional parameters.
DeploymentsDeleteAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsDeleteAtTenantScopeOptionalParams

Optional parameters.
DeploymentsDeleteOptionalParams

Optional parameters.
DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsExportTemplateAtScopeOptionalParams

Optional parameters.
DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsExportTemplateAtTenantScopeOptionalParams

Optional parameters.
DeploymentsExportTemplateOptionalParams

Optional parameters.
DeploymentsGetAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsGetAtScopeOptionalParams

Optional parameters.
DeploymentsGetAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsGetAtTenantScopeOptionalParams

Optional parameters.
DeploymentsGetOptionalParams

Optional parameters.
DeploymentsListAtManagementGroupScopeNextOptionalParams

Optional parameters.
DeploymentsListAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsListAtScopeNextOptionalParams

Optional parameters.
DeploymentsListAtScopeOptionalParams

Optional parameters.
DeploymentsListAtSubscriptionScopeNextOptionalParams

Optional parameters.
DeploymentsListAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsListAtTenantScopeNextOptionalParams

Optional parameters.
DeploymentsListAtTenantScopeOptionalParams

Optional parameters.
DeploymentsListByResourceGroupNextOptionalParams

Optional parameters.
DeploymentsListByResourceGroupOptionalParams

Optional parameters.
DeploymentsValidateAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsValidateAtScopeOptionalParams

Optional parameters.
DeploymentsValidateAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsValidateAtTenantScopeOptionalParams

Optional parameters.
DeploymentsValidateOptionalParams

Optional parameters.
DeploymentsWhatIfAtManagementGroupScopeHeaders

Defines headers for Deployments_whatIfAtManagementGroupScope operation.
DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Optional parameters.
DeploymentsWhatIfAtSubscriptionScopeHeaders

Defines headers for Deployments_whatIfAtSubscriptionScope operation.
DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Optional parameters.
DeploymentsWhatIfAtTenantScopeHeaders

Defines headers for Deployments_whatIfAtTenantScope operation.
DeploymentsWhatIfAtTenantScopeOptionalParams

Optional parameters.
DeploymentsWhatIfHeaders

Defines headers for Deployments_whatIf operation.
DeploymentsWhatIfOptionalParams

Optional parameters.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
ExportTemplateRequest

Export resource group template request parameters.
GenericResource

Resource information.
GenericResourceExpanded

Resource information.
GenericResourceFilter

Resource filter.
HttpMessage

HTTP message.
Identity

Identity for the resource.
IdentityUserAssignedIdentitiesValue
OnErrorDeployment

Deployment on error behavior.
OnErrorDeploymentExtended

Deployment on error behavior with additional details.
Operation

Microsoft.Resources operation
OperationDisplay

The object that represents the operation.
OperationListResult

Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.
Operations

Interface representing a Operations.
OperationsListNextOptionalParams

Optional parameters.
OperationsListOptionalParams

Optional parameters.
ParametersLink

Entity representing the reference to the deployment parameters.
Plan

Plan for the resource.
Provider

Resource provider information.
ProviderListResult

List of resource providers.
ProviderResourceType

Resource type managed by the resource provider.
Providers

Interface representing a Providers.
ProvidersGetAtTenantScopeOptionalParams

Optional parameters.
ProvidersGetOptionalParams

Optional parameters.
ProvidersListAtTenantScopeNextOptionalParams

Optional parameters.
ProvidersListAtTenantScopeOptionalParams

Optional parameters.
ProvidersListNextOptionalParams

Optional parameters.
ProvidersListOptionalParams

Optional parameters.
ProvidersRegisterOptionalParams

Optional parameters.
ProvidersUnregisterOptionalParams

Optional parameters.
Resource

Specified resource.
ResourceGroup

Resource group information.
ResourceGroupExportResult

Resource group export result.
ResourceGroupFilter

Resource group filter.
ResourceGroupListResult

List of resource groups.
ResourceGroupPatchable

Resource group information.
ResourceGroupProperties

The resource group properties.
ResourceGroups

Interface representing a ResourceGroups.
ResourceGroupsCheckExistenceOptionalParams

Optional parameters.
ResourceGroupsCreateOrUpdateOptionalParams

Optional parameters.
ResourceGroupsDeleteOptionalParams

Optional parameters.
ResourceGroupsExportTemplateOptionalParams

Optional parameters.
ResourceGroupsGetOptionalParams

Optional parameters.
ResourceGroupsListNextOptionalParams

Optional parameters.
ResourceGroupsListOptionalParams

Optional parameters.
ResourceGroupsUpdateOptionalParams

Optional parameters.
ResourceListResult

List of resource groups.
ResourceManagementClientOptionalParams

Optional parameters.
ResourceProviderOperationDisplayProperties

Resource provider operation's display properties.
ResourceReference

The resource Id model.
Resources

Interface representing a Resources.
ResourcesCheckExistenceByIdOptionalParams

Optional parameters.
ResourcesCheckExistenceOptionalParams

Optional parameters.
ResourcesCreateOrUpdateByIdOptionalParams

Optional parameters.
ResourcesCreateOrUpdateOptionalParams

Optional parameters.
ResourcesDeleteByIdOptionalParams

Optional parameters.
ResourcesDeleteOptionalParams

Optional parameters.
ResourcesGetByIdOptionalParams

Optional parameters.
ResourcesGetOptionalParams

Optional parameters.
ResourcesListByResourceGroupNextOptionalParams

Optional parameters.
ResourcesListByResourceGroupOptionalParams

Optional parameters.
ResourcesListNextOptionalParams

Optional parameters.
ResourcesListOptionalParams

Optional parameters.
ResourcesMoveInfo

Parameters of move resources.
ResourcesMoveResourcesOptionalParams

Optional parameters.
ResourcesUpdateByIdOptionalParams

Optional parameters.
ResourcesUpdateOptionalParams

Optional parameters.
ResourcesValidateMoveResourcesOptionalParams

Optional parameters.
ScopedDeployment

Deployment operation parameters.
ScopedDeploymentWhatIf

Deployment What-if operation parameters.
Sku

SKU for the resource.
SubResource

Sub-resource.
TagCount

Tag count.
TagDetails

Tag details.
TagValue

Tag information.
Tags

A dictionary of name and value pairs.
TagsCreateOrUpdateAtScopeOptionalParams

Optional parameters.
TagsCreateOrUpdateOptionalParams

Optional parameters.
TagsCreateOrUpdateValueOptionalParams

Optional parameters.
TagsDeleteAtScopeOptionalParams

Optional parameters.
TagsDeleteOptionalParams

Optional parameters.
TagsDeleteValueOptionalParams

Optional parameters.
TagsGetAtScopeOptionalParams

Optional parameters.
TagsListNextOptionalParams

Optional parameters.
TagsListOptionalParams

Optional parameters.
TagsListResult

List of subscription tags.
TagsOperations

Interface representing a TagsOperations.
TagsPatchResource

Wrapper resource for tags patch API request only.
TagsResource

Wrapper resource for tags API requests and responses.
TagsUpdateAtScopeOptionalParams

Optional parameters.
TargetResource

Target resource.
TemplateHashResult

Result of the request to calculate template hash. It contains a string of minified template and its hash.
TemplateLink

Entity representing the reference to the template.
WhatIfChange

Information about a single resource change predicted by What-If operation.
WhatIfOperationResult

Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
WhatIfPropertyChange

The predicted change to the resource property.
ZoneMapping

Type Aliases

AliasPatternType

Defines values for AliasPatternType.
AliasType

Defines values for AliasType.
ChangeType

Defines values for ChangeType.
DeploymentMode

Defines values for DeploymentMode.
DeploymentOperationsGetAtManagementGroupScopeResponse

Contains response data for the getAtManagementGroupScope operation.
DeploymentOperationsGetAtScopeResponse

Contains response data for the getAtScope operation.
DeploymentOperationsGetAtSubscriptionScopeResponse

Contains response data for the getAtSubscriptionScope operation.
DeploymentOperationsGetAtTenantScopeResponse

Contains response data for the getAtTenantScope operation.
DeploymentOperationsGetResponse

Contains response data for the get operation.
DeploymentOperationsListAtManagementGroupScopeNextResponse

Contains response data for the listAtManagementGroupScopeNext operation.
DeploymentOperationsListAtManagementGroupScopeResponse

Contains response data for the listAtManagementGroupScope operation.
DeploymentOperationsListAtScopeNextResponse

Contains response data for the listAtScopeNext operation.
DeploymentOperationsListAtScopeResponse

Contains response data for the listAtScope operation.
DeploymentOperationsListAtSubscriptionScopeNextResponse

Contains response data for the listAtSubscriptionScopeNext operation.
DeploymentOperationsListAtSubscriptionScopeResponse

Contains response data for the listAtSubscriptionScope operation.
DeploymentOperationsListAtTenantScopeNextResponse

Contains response data for the listAtTenantScopeNext operation.
DeploymentOperationsListAtTenantScopeResponse

Contains response data for the listAtTenantScope operation.
DeploymentOperationsListNextResponse

Contains response data for the listNext operation.
DeploymentOperationsListResponse

Contains response data for the list operation.
DeploymentsCalculateTemplateHashResponse

Contains response data for the calculateTemplateHash operation.
DeploymentsCheckExistenceAtManagementGroupScopeResponse

Contains response data for the checkExistenceAtManagementGroupScope operation.
DeploymentsCheckExistenceAtScopeResponse

Contains response data for the checkExistenceAtScope operation.
DeploymentsCheckExistenceAtSubscriptionScopeResponse

Contains response data for the checkExistenceAtSubscriptionScope operation.
DeploymentsCheckExistenceAtTenantScopeResponse

Contains response data for the checkExistenceAtTenantScope operation.
DeploymentsCheckExistenceResponse

Contains response data for the checkExistence operation.
DeploymentsCreateOrUpdateAtManagementGroupScopeResponse

Contains response data for the createOrUpdateAtManagementGroupScope operation.
DeploymentsCreateOrUpdateAtScopeResponse

Contains response data for the createOrUpdateAtScope operation.
DeploymentsCreateOrUpdateAtSubscriptionScopeResponse

Contains response data for the createOrUpdateAtSubscriptionScope operation.
DeploymentsCreateOrUpdateAtTenantScopeResponse

Contains response data for the createOrUpdateAtTenantScope operation.
DeploymentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
DeploymentsExportTemplateAtManagementGroupScopeResponse

Contains response data for the exportTemplateAtManagementGroupScope operation.
DeploymentsExportTemplateAtScopeResponse

Contains response data for the exportTemplateAtScope operation.
DeploymentsExportTemplateAtSubscriptionScopeResponse

Contains response data for the exportTemplateAtSubscriptionScope operation.
DeploymentsExportTemplateAtTenantScopeResponse

Contains response data for the exportTemplateAtTenantScope operation.
DeploymentsExportTemplateResponse

Contains response data for the exportTemplate operation.
DeploymentsGetAtManagementGroupScopeResponse

Contains response data for the getAtManagementGroupScope operation.
DeploymentsGetAtScopeResponse

Contains response data for the getAtScope operation.
DeploymentsGetAtSubscriptionScopeResponse

Contains response data for the getAtSubscriptionScope operation.
DeploymentsGetAtTenantScopeResponse

Contains response data for the getAtTenantScope operation.
DeploymentsGetResponse

Contains response data for the get operation.
DeploymentsListAtManagementGroupScopeNextResponse

Contains response data for the listAtManagementGroupScopeNext operation.
DeploymentsListAtManagementGroupScopeResponse

Contains response data for the listAtManagementGroupScope operation.
DeploymentsListAtScopeNextResponse

Contains response data for the listAtScopeNext operation.
DeploymentsListAtScopeResponse

Contains response data for the listAtScope operation.
DeploymentsListAtSubscriptionScopeNextResponse

Contains response data for the listAtSubscriptionScopeNext operation.
DeploymentsListAtSubscriptionScopeResponse

Contains response data for the listAtSubscriptionScope operation.
DeploymentsListAtTenantScopeNextResponse

Contains response data for the listAtTenantScopeNext operation.
DeploymentsListAtTenantScopeResponse

Contains response data for the listAtTenantScope operation.
DeploymentsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
DeploymentsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
DeploymentsValidateAtManagementGroupScopeResponse

Contains response data for the validateAtManagementGroupScope operation.
DeploymentsValidateAtScopeResponse

Contains response data for the validateAtScope operation.
DeploymentsValidateAtSubscriptionScopeResponse

Contains response data for the validateAtSubscriptionScope operation.
DeploymentsValidateAtTenantScopeResponse

Contains response data for the validateAtTenantScope operation.
DeploymentsValidateResponse

Contains response data for the validate operation.
DeploymentsWhatIfAtManagementGroupScopeResponse

Contains response data for the whatIfAtManagementGroupScope operation.
DeploymentsWhatIfAtSubscriptionScopeResponse

Contains response data for the whatIfAtSubscriptionScope operation.
DeploymentsWhatIfAtTenantScopeResponse

Contains response data for the whatIfAtTenantScope operation.
DeploymentsWhatIfResponse

Contains response data for the whatIf operation.
OnErrorDeploymentType

Defines values for OnErrorDeploymentType.
OperationsListNextResponse

Contains response data for the listNext operation.
OperationsListResponse

Contains response data for the list operation.
PropertyChangeType

Defines values for PropertyChangeType.
ProvidersGetAtTenantScopeResponse

Contains response data for the getAtTenantScope operation.
ProvidersGetResponse

Contains response data for the get operation.
ProvidersListAtTenantScopeNextResponse

Contains response data for the listAtTenantScopeNext operation.
ProvidersListAtTenantScopeResponse

Contains response data for the listAtTenantScope operation.
ProvidersListNextResponse

Contains response data for the listNext operation.
ProvidersListResponse

Contains response data for the list operation.
ProvidersRegisterResponse

Contains response data for the register operation.
ProvidersUnregisterResponse

Contains response data for the unregister operation.
ProvisioningOperation

Defines values for ProvisioningOperation.
ResourceGroupsCheckExistenceResponse

Contains response data for the checkExistence operation.
ResourceGroupsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ResourceGroupsExportTemplateResponse

Contains response data for the exportTemplate operation.
ResourceGroupsGetResponse

Contains response data for the get operation.
ResourceGroupsListNextResponse

Contains response data for the listNext operation.
ResourceGroupsListResponse

Contains response data for the list operation.
ResourceGroupsUpdateResponse

Contains response data for the update operation.
ResourceIdentityType

Defines values for ResourceIdentityType.
ResourcesCheckExistenceByIdResponse

Contains response data for the checkExistenceById operation.
ResourcesCheckExistenceResponse

Contains response data for the checkExistence operation.
ResourcesCreateOrUpdateByIdResponse

Contains response data for the createOrUpdateById operation.
ResourcesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ResourcesGetByIdResponse

Contains response data for the getById operation.
ResourcesGetResponse

Contains response data for the get operation.
ResourcesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
ResourcesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
ResourcesListNextResponse

Contains response data for the listNext operation.
ResourcesListResponse

Contains response data for the list operation.
ResourcesUpdateByIdResponse

Contains response data for the updateById operation.
ResourcesUpdateResponse

Contains response data for the update operation.
TagsCreateOrUpdateAtScopeResponse

Contains response data for the createOrUpdateAtScope operation.
TagsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
TagsCreateOrUpdateValueResponse

Contains response data for the createOrUpdateValue operation.
TagsGetAtScopeResponse

Contains response data for the getAtScope operation.
TagsListNextResponse

Contains response data for the listNext operation.
TagsListResponse

Contains response data for the list operation.
TagsPatchOperation

Defines values for TagsPatchOperation.
KnownTagsPatchOperation can be used interchangeably with TagsPatchOperation, this enum contains the known values that the service supports.

Known values supported by the service

Replace: The 'replace' option replaces the entire set of existing tags with a new set.
Merge: The 'merge' option allows adding tags with new names and updating the values of tags with existing names.
Delete: The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
TagsUpdateAtScopeResponse

Contains response data for the updateAtScope operation.
WhatIfResultFormat

Defines values for WhatIfResultFormat.

Enums

KnownTagsPatchOperation

Known values of TagsPatchOperation that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.