ApiManagementServiceResource.GetApiAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementServiceResource.cs

Gets the details of the API specified by its identifier.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
• Operation Id: Api_Get
• Default Api Version: 2023-03-01-preview
• Resource: ApiResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiResource>> GetApiAsync (string apiId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiResource>>
override this.GetApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiResource>>

Public Overridable Function GetApiAsync (apiId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiResource))

Parameters

apiId

String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ApiResource>>

Exceptions

ArgumentNullException

apiId is null.

ArgumentException

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