Share via

ArmDeploymentResource.DeleteAsync(WaitUntil, 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

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

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

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Applies to