ApiManagementGatewayResource.GetGatewayApiEntityTagAsync Method

Definition

Checks that API entity specified by identifier is associated with the Gateway entity.

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

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