Share via


IGatewayApiOperations.DeleteWithHttpMessagesAsync Method

Definition

Deletes the specified API from the specified Gateway.

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

gatewayId
String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

apiId
String

API identifier. Must be unique in the current API Management service instance.

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