IApiTagDescriptionOperations.DeleteWithHttpMessagesAsync Method

Definition

Delete tag description for the Api.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteWithHttpMessagesAsync (string resourceGroupName, string serviceName, string apiId, string tagDescriptionId, string ifMatch, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteWithHttpMessagesAsync : string * string * string * 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 DeleteWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, apiId As String, tagDescriptionId As String, ifMatch As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group.

serviceName
String

The name of the API Management service.

apiId
String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagDescriptionId
String

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

ifMatch
String

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to