Share via

ArmDeploymentResource.CancelAsync(CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Resources
Assembly:
Azure.ResourceManager.Resources.dll
Package:
Azure.ResourceManager.Resources v1.9.0
Package:
Azure.ResourceManager.Resources v1.7.0-beta.1
Source:
ArmDeploymentResource.cs
Source:
ArmDeploymentResource.cs

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.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
  • Operation Id: Deployments_CancelAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
public virtual System.Threading.Tasks.Task<Azure.Response> CancelAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member CancelAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CancelAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response>

Applies to