Share via

@azure/arm-resourcesdeployments package

Classes

DeploymentsClient

Interfaces

Alias

The alias type.
AliasPath

The type of the paths for alias.
AliasPathMetadata
AliasPattern

The type of the pattern for an alias path.
ApiProfile
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.
DeploymentDiagnosticsDefinition
DeploymentExportResult

The deployment export result.
DeploymentExtended

Deployment information.
DeploymentExtendedFilter

Deployment filter.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput

Deployment external input for parameterization.
DeploymentExternalInputDefinition

Deployment external input definition for parameterization.
DeploymentIdentity

The Managed Identity configuration for a deployment.
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.
DeploymentParameter

Deployment parameter for the template.
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.
DeploymentsClientOptionalParams

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.)
ExpressionEvaluationOptions

Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
HttpMessage

HTTP message.
KeyVaultParameterReference

Azure Key Vault parameter reference.
KeyVaultReference

Azure Key Vault reference.
OnErrorDeployment

Deployment on error behavior.
OnErrorDeploymentExtended

Deployment on error behavior with additional details.
ParametersLink

Entity representing the reference to the deployment parameters.
Provider

Resource provider information.
ProviderExtendedLocation

The provider extended location.
ProviderResourceType

Resource type managed by the resource provider.
ResourceProviderOperationDisplayProperties

Resource provider operation's display properties.
ResourceReference

The resource Id model.
ScopedDeployment

Deployment operation parameters.
ScopedDeploymentWhatIf

Deployment What-if operation parameters.
StatusMessage

Operation status message object.
SubResource

Sub-resource.
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.
UserAssignedIdentity

User assigned identity properties
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

AliasPathAttributes

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

Known values supported by the service

None: The token that the alias path is referring to has no attributes.
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect.
AliasPathTokenType

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

Known values supported by the service

NotSpecified: The token type is not specified.
Any: The token type can be anything.
String: The token type is string.
Object: The token type is object.
Array: The token type is array.
Integer: The token type is integer.
Number: The token type is number.
Boolean: The token type is boolean.
AliasPatternType

Defines values for AliasPatternType.
AliasType

Defines values for AliasType.
ChangeType

Defines values for ChangeType.
DeploymentIdentityType

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

Known values supported by the service

None
UserAssigned
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.
ExpressionEvaluationOptionsScopeType

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

Known values supported by the service

NotSpecified
Outer
Inner
ExtensionConfigPropertyType

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

Known values supported by the service

String: Property type representing a string value.
Int: Property type representing an integer value.
Bool: Property type representing a boolean value.
Array: Property type representing an array value.
Object: Property type representing an object value.
SecureString: Property type representing a secure string value.
SecureObject: Property type representing a secure object value.
Level

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

Known values supported by the service

Warning
Info
Error
OnErrorDeploymentType

Defines values for OnErrorDeploymentType.
PropertyChangeType

Defines values for PropertyChangeType.
ProviderAuthorizationConsentState

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

Known values supported by the service

NotSpecified
Required
NotRequired
Consented
ProvisioningOperation

Defines values for ProvisioningOperation.
ProvisioningState

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

Known values supported by the service

NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating
ValidationLevel

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

Known values supported by the service

Template: Static analysis of the template is performed.
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource.
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource.
WhatIfResultFormat

Defines values for WhatIfResultFormat.

Enums

KnownAliasPathAttributes

Known values of AliasPathAttributes that the service accepts.
KnownAliasPathTokenType

Known values of AliasPathTokenType that the service accepts.
KnownDeploymentIdentityType

Known values of DeploymentIdentityType that the service accepts.
KnownExpressionEvaluationOptionsScopeType

Known values of ExpressionEvaluationOptionsScopeType that the service accepts.
KnownExtensionConfigPropertyType

Known values of ExtensionConfigPropertyType that the service accepts.
KnownLevel

Known values of Level that the service accepts.
KnownProviderAuthorizationConsentState

Known values of ProviderAuthorizationConsentState that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownValidationLevel

Known values of ValidationLevel 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.