ApiManagementGatewayCollection.GetIfExistsAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.ApiManagement

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.1.0

Package:: Azure.ResourceManager.ApiManagement v1.2.0-beta.1

Source:: ApiManagementGatewayCollection.cs

Source:: ApiManagementGatewayCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: 2021-08-01
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.

Applies to

Share via