ApiCenterApiCollection.GetIfExists(String, CancellationToken) Method

Definition

Namespace:
Azure.ResourceManager.ApiCenter
Assembly:
Azure.ResourceManager.ApiCenter.dll
Package:
Azure.ResourceManager.ApiCenter v1.0.0
Package:
Azure.ResourceManager.ApiCenter v1.1.0-beta.1
Source:
ApiCenterApiCollection.cs
Source:
ApiCenterApiCollection.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}.
  • Operation Id. : Apis_Get.
  • Default Api Version. : 2024-06-01-preview. 
public virtual Azure.NullableResponse<Azure.ResourceManager.ApiCenter.ApiCenterApiResource> GetIfExists(string apiName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.ApiCenter.ApiCenterApiResource>
override this.GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.ApiCenter.ApiCenterApiResource>
Public Overridable Function GetIfExists (apiName As String, Optional cancellationToken As CancellationToken = Nothing) As NullableResponse(Of ApiCenterApiResource)

Parameters

apiName
String

The name of the API.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

NullableResponse<ApiCenterApiResource>

Exceptions

ArgumentNullException

apiName is null.

ArgumentException

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

Applies to