ApiManagementGatewayResource.DeleteGatewayApiAsync Method

Definition

Deletes the specified API from the specified Gateway.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • Operation Id: GatewayApi_Delete
  • Default Api Version: 2023-03-01-preview
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteGatewayApiAsync (string apiId, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteGatewayApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteGatewayApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteGatewayApiAsync (apiId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

apiId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

apiId is an empty string, and was expected to be non-empty.

apiId is null.

Applies to