DeploymentsOperations interface

Interface representing a Deployments operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginCreateOrUpdateAtManagementGroupScope
beginCreateOrUpdateAtManagementGroupScopeAndWait
beginCreateOrUpdateAtScope
beginCreateOrUpdateAtScopeAndWait
beginCreateOrUpdateAtSubscriptionScope
beginCreateOrUpdateAtSubscriptionScopeAndWait
beginCreateOrUpdateAtTenantScope
beginCreateOrUpdateAtTenantScopeAndWait
beginDelete
beginDeleteAndWait
beginDeleteAtManagementGroupScope
beginDeleteAtManagementGroupScopeAndWait
beginDeleteAtScope
beginDeleteAtScopeAndWait
beginDeleteAtSubscriptionScope
beginDeleteAtSubscriptionScopeAndWait
beginDeleteAtTenantScope
beginDeleteAtTenantScopeAndWait
beginValidate
beginValidateAndWait
beginValidateAtManagementGroupScope
beginValidateAtManagementGroupScopeAndWait
beginValidateAtScope
beginValidateAtScopeAndWait
beginValidateAtSubscriptionScope
beginValidateAtSubscriptionScopeAndWait
beginValidateAtTenantScope
beginValidateAtTenantScopeAndWait
beginWhatIf
beginWhatIfAndWait
beginWhatIfAtManagementGroupScope
beginWhatIfAtManagementGroupScopeAndWait
beginWhatIfAtSubscriptionScope
beginWhatIfAtSubscriptionScopeAndWait
beginWhatIfAtTenantScope
beginWhatIfAtTenantScopeAndWait
calculateTemplateHash	Calculate the hash of the given template.
cancel	You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
cancelAtManagementGroupScope	You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
cancelAtScope	You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
cancelAtSubscriptionScope	You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
cancelAtTenantScope	You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
checkExistence	Checks whether the deployment exists.
checkExistenceAtManagementGroupScope	Checks whether the deployment exists.
checkExistenceAtScope	Checks whether the deployment exists.
checkExistenceAtSubscriptionScope	Checks whether the deployment exists.
checkExistenceAtTenantScope	Checks whether the deployment exists.
createOrUpdate	You can provide the template and parameters directly in the request or link to JSON files.
createOrUpdateAtManagementGroupScope	You can provide the template and parameters directly in the request or link to JSON files.
createOrUpdateAtScope	You can provide the template and parameters directly in the request or link to JSON files.
createOrUpdateAtSubscriptionScope	You can provide the template and parameters directly in the request or link to JSON files.
createOrUpdateAtTenantScope	You can provide the template and parameters directly in the request or link to JSON files.
delete	A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
deleteAtManagementGroupScope	A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
deleteAtScope	A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
deleteAtSubscriptionScope	A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
deleteAtTenantScope	A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
exportTemplate	Exports the template used for specified deployment.
exportTemplateAtManagementGroupScope	Exports the template used for specified deployment.
exportTemplateAtScope	Exports the template used for specified deployment.
exportTemplateAtSubscriptionScope	Exports the template used for specified deployment.
exportTemplateAtTenantScope	Exports the template used for specified deployment.
get	Gets a deployment.
getAtManagementGroupScope	Gets a deployment.
getAtScope	Gets a deployment.
getAtSubscriptionScope	Gets a deployment.
getAtTenantScope	Gets a deployment.
listAtManagementGroupScope	Get all the deployments for a management group.
listAtScope	Get all the deployments at the given scope.
listAtSubscriptionScope	Get all the deployments for a subscription.
listAtTenantScope	Get all the deployments at the tenant scope.
listByResourceGroup	Get all the deployments for a resource group.
validate	Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
validateAtManagementGroupScope	Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
validateAtScope	Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
validateAtSubscriptionScope	Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
validateAtTenantScope	Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
whatIf	Returns changes that will be made by the deployment if executed at the scope of the resource group.
whatIfAtManagementGroupScope	Returns changes that will be made by the deployment if executed at the scope of the management group.
whatIfAtSubscriptionScope	Returns changes that will be made by the deployment if executed at the scope of the subscription.
whatIfAtTenantScope	Returns changes that will be made by the deployment if executed at the scope of the tenant group.

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => Promise<DeploymentExtended>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => Promise<DeploymentExtended>

beginCreateOrUpdateAtManagementGroupScope

Warning

This API is now deprecated.

use createOrUpdateAtManagementGroupScope instead

beginCreateOrUpdateAtManagementGroupScope: (groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtManagementGroupScopeAndWait

Warning

This API is now deprecated.

use createOrUpdateAtManagementGroupScope instead

beginCreateOrUpdateAtManagementGroupScopeAndWait: (groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => Promise<DeploymentExtended>

beginCreateOrUpdateAtScope

Warning

This API is now deprecated.

use createOrUpdateAtScope instead

beginCreateOrUpdateAtScope: (scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

Property Value

(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtScopeAndWait

Warning

This API is now deprecated.

use createOrUpdateAtScope instead

beginCreateOrUpdateAtScopeAndWait: (scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => Promise<DeploymentExtended>

beginCreateOrUpdateAtSubscriptionScope

Warning

This API is now deprecated.

use createOrUpdateAtSubscriptionScope instead

beginCreateOrUpdateAtSubscriptionScope: (deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

Property Value

(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtSubscriptionScopeAndWait

Warning

This API is now deprecated.

use createOrUpdateAtSubscriptionScope instead

beginCreateOrUpdateAtSubscriptionScopeAndWait: (deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => Promise<DeploymentExtended>

beginCreateOrUpdateAtTenantScope

Warning

This API is now deprecated.

use createOrUpdateAtTenantScope instead

beginCreateOrUpdateAtTenantScope: (deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

Property Value

(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtTenantScopeAndWait

Warning

This API is now deprecated.

use createOrUpdateAtTenantScope instead

beginCreateOrUpdateAtTenantScopeAndWait: (deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => Promise<DeploymentExtended>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => Promise<void>

beginDeleteAtManagementGroupScope

Warning

This API is now deprecated.

use deleteAtManagementGroupScope instead

beginDeleteAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAtManagementGroupScopeAndWait

Warning

This API is now deprecated.

use deleteAtManagementGroupScope instead

beginDeleteAtManagementGroupScopeAndWait: (groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => Promise<void>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => Promise<void>

beginDeleteAtScope

Warning

This API is now deprecated.

use deleteAtScope instead

beginDeleteAtScope: (scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAtScopeAndWait

Warning

This API is now deprecated.

use deleteAtScope instead

beginDeleteAtScopeAndWait: (scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => Promise<void>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => Promise<void>

beginDeleteAtSubscriptionScope

Warning

This API is now deprecated.

use deleteAtSubscriptionScope instead

beginDeleteAtSubscriptionScope: (deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAtSubscriptionScopeAndWait

Warning

This API is now deprecated.

use deleteAtSubscriptionScope instead

beginDeleteAtSubscriptionScopeAndWait: (deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => Promise<void>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => Promise<void>

beginDeleteAtTenantScope

Warning

This API is now deprecated.

use deleteAtTenantScope instead

beginDeleteAtTenantScope: (deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAtTenantScopeAndWait

Warning

This API is now deprecated.

use deleteAtTenantScope instead

beginDeleteAtTenantScopeAndWait: (deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => Promise<void>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => Promise<void>

beginValidate

Warning

This API is now deprecated.

use validate instead

beginValidate: (resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAndWait

Warning

This API is now deprecated.

use validate instead

beginValidateAndWait: (resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams) => Promise<DeploymentValidateResult>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams) => Promise<DeploymentValidateResult>

beginValidateAtManagementGroupScope

Warning

This API is now deprecated.

use validateAtManagementGroupScope instead

beginValidateAtManagementGroupScope: (groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtManagementGroupScopeAndWait

Warning

This API is now deprecated.

use validateAtManagementGroupScope instead

beginValidateAtManagementGroupScopeAndWait: (groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams) => Promise<DeploymentValidateResult>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams) => Promise<DeploymentValidateResult>

beginValidateAtScope

Warning

This API is now deprecated.

use validateAtScope instead

beginValidateAtScope: (scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

Property Value

(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtScopeAndWait

Warning

This API is now deprecated.

use validateAtScope instead

beginValidateAtScopeAndWait: (scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams) => Promise<DeploymentValidateResult>

Property Value

(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams) => Promise<DeploymentValidateResult>

beginValidateAtSubscriptionScope

Warning

This API is now deprecated.

use validateAtSubscriptionScope instead

beginValidateAtSubscriptionScope: (deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

Property Value

(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtSubscriptionScopeAndWait

Warning

This API is now deprecated.

use validateAtSubscriptionScope instead

beginValidateAtSubscriptionScopeAndWait: (deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams) => Promise<DeploymentValidateResult>

Property Value

(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams) => Promise<DeploymentValidateResult>

beginValidateAtTenantScope

Warning

This API is now deprecated.

use validateAtTenantScope instead

beginValidateAtTenantScope: (deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

Property Value

(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtTenantScopeAndWait

Warning

This API is now deprecated.

use validateAtTenantScope instead

beginValidateAtTenantScopeAndWait: (deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams) => Promise<DeploymentValidateResult>

Property Value

(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams) => Promise<DeploymentValidateResult>

beginWhatIf

Warning

This API is now deprecated.

use whatIf instead

beginWhatIf: (resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAndWait

Warning

This API is now deprecated.

use whatIf instead

beginWhatIfAndWait: (resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams) => Promise<WhatIfOperationResult>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams) => Promise<WhatIfOperationResult>

beginWhatIfAtManagementGroupScope

Warning

This API is now deprecated.

use whatIfAtManagementGroupScope instead

beginWhatIfAtManagementGroupScope: (groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtManagementGroupScopeAndWait

Warning

This API is now deprecated.

use whatIfAtManagementGroupScope instead

beginWhatIfAtManagementGroupScopeAndWait: (groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams) => Promise<WhatIfOperationResult>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams) => Promise<WhatIfOperationResult>

beginWhatIfAtSubscriptionScope

Warning

This API is now deprecated.

use whatIfAtSubscriptionScope instead

beginWhatIfAtSubscriptionScope: (deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

Property Value

(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtSubscriptionScopeAndWait

Warning

This API is now deprecated.

use whatIfAtSubscriptionScope instead

beginWhatIfAtSubscriptionScopeAndWait: (deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams) => Promise<WhatIfOperationResult>

Property Value

(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams) => Promise<WhatIfOperationResult>

beginWhatIfAtTenantScope

Warning

This API is now deprecated.

use whatIfAtTenantScope instead

beginWhatIfAtTenantScope: (deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

Property Value

(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams) => Promise<SimplePollerLike<OperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtTenantScopeAndWait

Warning

This API is now deprecated.

use whatIfAtTenantScope instead

beginWhatIfAtTenantScopeAndWait: (deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams) => Promise<WhatIfOperationResult>

Property Value

(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams) => Promise<WhatIfOperationResult>

calculateTemplateHash

Calculate the hash of the given template.

calculateTemplateHash: (template: any, options?: DeploymentsCalculateTemplateHashOptionalParams) => Promise<TemplateHashResult>

Property Value

(template: any, options?: DeploymentsCalculateTemplateHashOptionalParams) => Promise<TemplateHashResult>

cancel

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.

cancel: (resourceGroupName: string, deploymentName: string, options?: DeploymentsCancelOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsCancelOptionalParams) => Promise<void>

cancelAtManagementGroupScope

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.

cancelAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsCancelAtManagementGroupScopeOptionalParams) => Promise<void>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsCancelAtManagementGroupScopeOptionalParams) => Promise<void>

cancelAtScope

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.

cancelAtScope: (scope: string, deploymentName: string, options?: DeploymentsCancelAtScopeOptionalParams) => Promise<void>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsCancelAtScopeOptionalParams) => Promise<void>

cancelAtSubscriptionScope

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.

cancelAtSubscriptionScope: (deploymentName: string, options?: DeploymentsCancelAtSubscriptionScopeOptionalParams) => Promise<void>

Property Value

(deploymentName: string, options?: DeploymentsCancelAtSubscriptionScopeOptionalParams) => Promise<void>

cancelAtTenantScope

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.

cancelAtTenantScope: (deploymentName: string, options?: DeploymentsCancelAtTenantScopeOptionalParams) => Promise<void>

Property Value

(deploymentName: string, options?: DeploymentsCancelAtTenantScopeOptionalParams) => Promise<void>

checkExistence

Checks whether the deployment exists.

checkExistence: (resourceGroupName: string, deploymentName: string, options?: DeploymentsCheckExistenceOptionalParams) => Promise<DeploymentsCheckExistenceResponse>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsCheckExistenceOptionalParams) => Promise<DeploymentsCheckExistenceResponse>

checkExistenceAtManagementGroupScope

Checks whether the deployment exists.

checkExistenceAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtManagementGroupScopeResponse>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtManagementGroupScopeResponse>

checkExistenceAtScope

Checks whether the deployment exists.

checkExistenceAtScope: (scope: string, deploymentName: string, options?: DeploymentsCheckExistenceAtScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtScopeResponse>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsCheckExistenceAtScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtScopeResponse>

checkExistenceAtSubscriptionScope

Checks whether the deployment exists.

checkExistenceAtSubscriptionScope: (deploymentName: string, options?: DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtSubscriptionScopeResponse>

Property Value

(deploymentName: string, options?: DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtSubscriptionScopeResponse>

checkExistenceAtTenantScope

Checks whether the deployment exists.

checkExistenceAtTenantScope: (deploymentName: string, options?: DeploymentsCheckExistenceAtTenantScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtTenantScopeResponse>

Property Value

(deploymentName: string, options?: DeploymentsCheckExistenceAtTenantScopeOptionalParams) => Promise<DeploymentsCheckExistenceAtTenantScopeResponse>

createOrUpdate

You can provide the template and parameters directly in the request or link to JSON files.

createOrUpdate: (resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

Property Value

(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

createOrUpdateAtManagementGroupScope

You can provide the template and parameters directly in the request or link to JSON files.

createOrUpdateAtManagementGroupScope: (groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

Property Value

(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

createOrUpdateAtScope

You can provide the template and parameters directly in the request or link to JSON files.

createOrUpdateAtScope: (scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

Property Value

(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

createOrUpdateAtSubscriptionScope

You can provide the template and parameters directly in the request or link to JSON files.

createOrUpdateAtSubscriptionScope: (deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

Property Value

(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

createOrUpdateAtTenantScope

You can provide the template and parameters directly in the request or link to JSON files.

createOrUpdateAtTenantScope: (deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

Property Value

(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams) => PollerLike<OperationState<DeploymentExtended>, DeploymentExtended>

delete

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

delete: (resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtManagementGroupScope

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

deleteAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtScope

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

deleteAtScope: (scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtSubscriptionScope

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

deleteAtSubscriptionScope: (deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtTenantScope

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

deleteAtTenantScope: (deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams) => PollerLike<OperationState<void>, void>

exportTemplate

Exports the template used for specified deployment.

exportTemplate: (resourceGroupName: string, deploymentName: string, options?: DeploymentsExportTemplateOptionalParams) => Promise<DeploymentExportResult>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsExportTemplateOptionalParams) => Promise<DeploymentExportResult>

exportTemplateAtManagementGroupScope

Exports the template used for specified deployment.

exportTemplateAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsExportTemplateAtManagementGroupScopeOptionalParams) => Promise<DeploymentExportResult>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsExportTemplateAtManagementGroupScopeOptionalParams) => Promise<DeploymentExportResult>

exportTemplateAtScope

Exports the template used for specified deployment.

exportTemplateAtScope: (scope: string, deploymentName: string, options?: DeploymentsExportTemplateAtScopeOptionalParams) => Promise<DeploymentExportResult>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsExportTemplateAtScopeOptionalParams) => Promise<DeploymentExportResult>

exportTemplateAtSubscriptionScope

Exports the template used for specified deployment.

exportTemplateAtSubscriptionScope: (deploymentName: string, options?: DeploymentsExportTemplateAtSubscriptionScopeOptionalParams) => Promise<DeploymentExportResult>

Property Value

(deploymentName: string, options?: DeploymentsExportTemplateAtSubscriptionScopeOptionalParams) => Promise<DeploymentExportResult>

exportTemplateAtTenantScope

Exports the template used for specified deployment.

exportTemplateAtTenantScope: (deploymentName: string, options?: DeploymentsExportTemplateAtTenantScopeOptionalParams) => Promise<DeploymentExportResult>

Property Value

(deploymentName: string, options?: DeploymentsExportTemplateAtTenantScopeOptionalParams) => Promise<DeploymentExportResult>

get

Gets a deployment.

get: (resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams) => Promise<DeploymentExtended>

Property Value

(resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams) => Promise<DeploymentExtended>

getAtManagementGroupScope

Gets a deployment.

getAtManagementGroupScope: (groupId: string, deploymentName: string, options?: DeploymentsGetAtManagementGroupScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(groupId: string, deploymentName: string, options?: DeploymentsGetAtManagementGroupScopeOptionalParams) => Promise<DeploymentExtended>

getAtScope

Gets a deployment.

getAtScope: (scope: string, deploymentName: string, options?: DeploymentsGetAtScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(scope: string, deploymentName: string, options?: DeploymentsGetAtScopeOptionalParams) => Promise<DeploymentExtended>

getAtSubscriptionScope

Gets a deployment.

getAtSubscriptionScope: (deploymentName: string, options?: DeploymentsGetAtSubscriptionScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(deploymentName: string, options?: DeploymentsGetAtSubscriptionScopeOptionalParams) => Promise<DeploymentExtended>

getAtTenantScope

Gets a deployment.

getAtTenantScope: (deploymentName: string, options?: DeploymentsGetAtTenantScopeOptionalParams) => Promise<DeploymentExtended>

Property Value

(deploymentName: string, options?: DeploymentsGetAtTenantScopeOptionalParams) => Promise<DeploymentExtended>

listAtManagementGroupScope

Get all the deployments for a management group.

listAtManagementGroupScope: (groupId: string, options?: DeploymentsListAtManagementGroupScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

Property Value

(groupId: string, options?: DeploymentsListAtManagementGroupScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

listAtScope

Get all the deployments at the given scope.

listAtScope: (scope: string, options?: DeploymentsListAtScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

Property Value

(scope: string, options?: DeploymentsListAtScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

listAtSubscriptionScope

Get all the deployments for a subscription.

listAtSubscriptionScope: (options?: DeploymentsListAtSubscriptionScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

Property Value

(options?: DeploymentsListAtSubscriptionScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

listAtTenantScope

Get all the deployments at the tenant scope.

listAtTenantScope: (options?: DeploymentsListAtTenantScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

Property Value

(options?: DeploymentsListAtTenantScopeOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

listByResourceGroup

Get all the deployments for a resource group.

listByResourceGroup: (resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

Property Value

(resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>