ApiCenterWorkspaceResource.HeadApiAsync(String, CancellationToken) Method

Definition

Namespace:
Azure.ResourceManager.ApiCenter
Assembly:
Azure.ResourceManager.ApiCenter.dll
Package:
Azure.ResourceManager.ApiCenter v1.1.0-beta.1
Source:
ApiCenterWorkspaceResource.cs

Checks if specified API exists.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}.
  • Operation Id. : Apis_Head.
  • Default Api Version. : 2024-06-01-preview.
  • Resource. : ApiCenterWorkspaceResource. 
public virtual System.Threading.Tasks.Task<Azure.Response> HeadApiAsync(string apiName, System.Threading.CancellationToken cancellationToken = default);
abstract member HeadApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.HeadApiAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function HeadApiAsync (apiName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

apiName
String

The name of the API.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentNullException

apiName is null.

ArgumentException

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

Applies to