ApiManagementGatewayCollection.GetAsync(String, CancellationToken) Method

Definition

Gets the details of the Gateway specified by its identifier.

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

Parameters

gatewayId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

gatewayId is null.

Applies to