Deployments

Operations

Calculate Template Hash

Calculate the hash of the given template.

Cancel

Cancels a currently running template deployment.
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 At Management Group Scope

Cancels a currently running template deployment.
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.

Cancel At Scope

Cancels a currently running template deployment.
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.

Cancel At Subscription Scope

Cancels a currently running template deployment.
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.

Cancel At Tenant Scope

Cancels a currently running template deployment.
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.

Check Existence

Checks whether the deployment exists.

Check Existence At Management Group Scope

Checks whether the deployment exists.

Check Existence At Scope

Checks whether the deployment exists.

Check Existence At Subscription Scope

Checks whether the deployment exists.

Check Existence At Tenant Scope

Checks whether the deployment exists.

Create Or Update

Deploys resources to a resource group.
You can provide the template and parameters directly in the request or link to JSON files.

Create Or Update At Management Group Scope

Deploys resources at management group scope.
You can provide the template and parameters directly in the request or link to JSON files.

Create Or Update At Scope

Deploys resources at a given scope.
You can provide the template and parameters directly in the request or link to JSON files.

Create Or Update At Subscription Scope

Deploys resources at subscription scope.
You can provide the template and parameters directly in the request or link to JSON files.

Create Or Update At Tenant Scope

Deploys resources at tenant scope.
You can provide the template and parameters directly in the request or link to JSON files.

Delete

Deletes a deployment from the deployment history.
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 At Management Group Scope

Deletes a deployment from the deployment history.
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.

Delete At Scope

Deletes a deployment from the deployment history.
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.

Delete At Subscription Scope

Deletes a deployment from the deployment history.
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.

Delete At Tenant Scope

Deletes a deployment from the deployment history.
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.

Export Template

Exports the template used for specified deployment.

Export Template At Management Group Scope

Exports the template used for specified deployment.

Export Template At Scope

Exports the template used for specified deployment.

Export Template At Subscription Scope

Exports the template used for specified deployment.

Export Template At Tenant Scope

Exports the template used for specified deployment.

Get

Gets a deployment.

Get At Management Group Scope

Gets a deployment.

Get At Scope

Gets a deployment.

Get At Subscription Scope

Gets a deployment.

Get At Tenant Scope

Gets a deployment.

List At Management Group Scope

Get all the deployments for a management group.

List At Scope

Get all the deployments at the given scope.

List At Subscription Scope

Get all the deployments for a subscription.

List At Tenant Scope

Get all the deployments at the tenant scope.

List By Resource Group

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

Validate At Management Group Scope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

Validate At Scope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

Validate At Subscription Scope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

Validate At Tenant Scope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

What If

Returns changes that will be made by the deployment if executed at the scope of the resource group.

What If At Subscription Scope

Returns changes that will be made by the deployment if executed at the scope of the subscription.