Share via


DeploymentsOperationsExtensions.CancelAtManagementGroupScopeAsync Method

Definition

Cancels a currently running template deployment.

public static System.Threading.Tasks.Task CancelAtManagementGroupScopeAsync (this Microsoft.Azure.Management.ResourceManager.IDeploymentsOperations operations, string groupId, string deploymentName, System.Threading.CancellationToken cancellationToken = default);
static member CancelAtManagementGroupScopeAsync : Microsoft.Azure.Management.ResourceManager.IDeploymentsOperations * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function CancelAtManagementGroupScopeAsync (operations As IDeploymentsOperations, groupId As String, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IDeploymentsOperations

The operations group for this extension method.

groupId
String

The management group ID.

deploymentName
String

The name of the deployment.

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

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.

Applies to