ArmDeploymentResource.Cancel(CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.Resources.Deployments

Assembly:

Azure.ResourceManager.Resources.Deployments.dll

Package:

Azure.ResourceManager.Resources.Deployments v1.0.0

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. : 2025-04-01.
• Resource. : ArmDeploymentResource.

public virtual Azure.Response Cancel(System.Threading.CancellationToken cancellationToken = default);

abstract member Cancel : System.Threading.CancellationToken -> Azure.Response
override this.Cancel : System.Threading.CancellationToken -> Azure.Response

Public Overridable Function Cancel (Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response