ApiCenterWorkspaceResource.HeadEnvironmentAsync Method

Definition

Checks if specified environment exists.

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

Parameters

environmentName
String

The name of the environment.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

environmentName is null.

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

Applies to