DeploymentsOperationsExtensions.CancelAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.ResourceManager

Assembly:: Microsoft.Azure.Management.ResourceManager.dll

Package:: Microsoft.Azure.Management.ResourceManager v3.17.4-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Cancels a currently running template deployment.

public static System.Threading.Tasks.Task CancelAsync (this Microsoft.Azure.Management.ResourceManager.IDeploymentsOperations operations, string resourceGroupName, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member CancelAsync : Microsoft.Azure.Management.ResourceManager.IDeploymentsOperations * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function CancelAsync (operations As IDeploymentsOperations, resourceGroupName As String, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations: IDeploymentsOperations

The operations group for this extension method.

resourceGroupName: String

The name of the resource group. The name is case insensitive.

deploymentName: String

The name of the deployment.

cancellationToken: CancellationToken

The cancellation token.

Returns

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 resource group partially deployed.

Applies to