Share via


IApiOperations.DeleteWithHttpMessagesAsync Method

Definition

Deletes the specified API of the API Management service instance.

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

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.

deleteRevisions
Nullable<Boolean>

Delete all revisions of the Api.

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