ApiCenterWorkspaceResource.HeadApi(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 Azure.Response HeadApi(string apiName, System.Threading.CancellationToken cancellationToken = default);
abstract member HeadApi : string * System.Threading.CancellationToken -> Azure.Response
override this.HeadApi : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function HeadApi (apiName As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

apiName
String

The name of the API.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

apiName is null.

ArgumentException

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

Applies to