ApiManagementExtensions.GetApiGatewayAsync Method

Definition

Namespace:: Azure.ResourceManager.ApiManagement

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.3.0

Source:: ApiManagementExtensions.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.

Gets an API Management gateway resource description.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
Operation Id: ApiGateway_Get
Default Api Version: 2024-05-01
Resource: ApiGatewayResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiGatewayResource>> GetApiGatewayAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string gatewayName, System.Threading.CancellationToken cancellationToken = default);

static member GetApiGatewayAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiGatewayResource>>

<Extension()>
Public Function GetApiGatewayAsync (resourceGroupResource As ResourceGroupResource, gatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiGatewayResource))

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

gatewayName: String

The name of the API Management gateway.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<ApiGatewayResource>>

Exceptions

ArgumentNullException

resourceGroupResource or gatewayName is null.

ArgumentException

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

Applies to