Share via


CosmosDBForPostgreSqlExtensions.CheckCosmosDBForPostgreSqlClusterNameAvailabilityAsync Method

Definition

Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability
  • Operation Id: Clusters_CheckNameAvailability
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterNameAvailabilityResult>> CheckCosmosDBForPostgreSqlClusterNameAvailabilityAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterNameAvailabilityContent content, System.Threading.CancellationToken cancellationToken = default);
static member CheckCosmosDBForPostgreSqlClusterNameAvailabilityAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterNameAvailabilityContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterNameAvailabilityResult>>
<Extension()>
Public Function CheckCosmosDBForPostgreSqlClusterNameAvailabilityAsync (subscriptionResource As SubscriptionResource, content As CosmosDBForPostgreSqlClusterNameAvailabilityContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBForPostgreSqlClusterNameAvailabilityResult))

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

content
CosmosDBForPostgreSqlClusterNameAvailabilityContent

The required parameters for checking if cluster name is available.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

subscriptionResource or content is null.

Applies to