Deployments - 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.
POST https://management.azure.com/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel?api-version=2021-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
The name of the deployment. Regex pattern: |
scope
|
path | True |
string |
The resource scope. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
204 No Content |
No Content |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Definitions
Name | Description |
---|---|
Cloud |
An error response for a resource management request. |
Error |
The resource management error additional info. |
Error |
Error Response |
CloudError
An error response for a resource management request.
Name | Type | Description |
---|---|---|
error |
Error Response |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorResponse
Error Response
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |