DeploymentsOperationsExtensions.CancelAtSubscriptionScopeAsync(IDeploymentsOperations, String, CancellationToken) Method

Definition

Cancels a currently running template deployment.

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

Parameters

operations
IDeploymentsOperations

The operations group for this extension method.

deploymentName
System.String

The name of the deployment.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task

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