ApiManagementGatewayCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementGatewayCollection.cs

Tries to get details for this resource from the service.

• 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.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>> GetIfExistsAsync (string gatewayId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>>

Public Overridable Function GetIfExistsAsync (gatewayId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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

Task<NullableResponse<ApiManagementGatewayResource>>

Exceptions

ArgumentException

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

ArgumentNullException

gatewayId is null.