IDeploymentsOperations.DeleteAtManagementGroupScopeWithHttpMessagesAsync 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.

Deletes a deployment from the deployment history.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteAtManagementGroupScopeWithHttpMessagesAsync (string groupId, string deploymentName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAtManagementGroupScopeWithHttpMessagesAsync : 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 DeleteAtManagementGroupScopeWithHttpMessagesAsync (groupId 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

groupId: String

The management group ID.

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

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.

Applies to

Share via