ApiCenterApiDefinitionCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiCenter

Assembly:

Azure.ResourceManager.ApiCenter.dll

Package:

Azure.ResourceManager.ApiCenter v1.0.0

Source:

ApiCenterApiDefinitionCollection.cs

Tries to get details for this resource from the service.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}.
• Operation Id. : ApiDefinitions_Get.
• Default Api Version. : 2024-06-01-preview.

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiCenter.ApiCenterApiDefinitionResource>> GetIfExistsAsync(string definitionName, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetIfExistsAsync (definitionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of ApiCenterApiDefinitionResource))

Parameters

definitionName

String

The name of the API definition.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<ApiCenterApiDefinitionResource>>

Exceptions

ArgumentNullException

definitionName is null.

ArgumentException

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