IDeploymentsOperations.CancelAtScopeWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.ResourceManager.Fluent

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

Package:: Microsoft.Azure.Management.ResourceManager.Fluent v1.38.1

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> CancelAtScopeWithHttpMessagesAsync (string scope, string deploymentName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelAtScopeWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function CancelAtScopeWithHttpMessagesAsync (scope As String, deploymentName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

scope: String

The resource scope.

deploymentName: String

The name of the deployment.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

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