CosmosDBExtensions.CheckNameExistsDatabaseAccount Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBExtensions.cs

Source:: CosmosDBExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.

Request Path: /providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}
Operation Id: DatabaseAccounts_CheckNameExists
Default Api Version: 2024-09-01-preview
Resource: CosmosDBAccountResource

public static Azure.Response<bool> CheckNameExistsDatabaseAccount (this Azure.ResourceManager.Resources.TenantResource tenantResource, string accountName, System.Threading.CancellationToken cancellationToken = default);

static member CheckNameExistsDatabaseAccount : Azure.ResourceManager.Resources.TenantResource * string * System.Threading.CancellationToken -> Azure.Response<bool>

<Extension()>
Public Function CheckNameExistsDatabaseAccount (tenantResource As TenantResource, accountName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Boolean)

Parameters

tenantResource: TenantResource

The TenantResource instance the method will execute against.

accountName: String

Cosmos DB database account name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<Boolean>

Exceptions

ArgumentException

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

ArgumentNullException

tenantResource or accountName is null.

Applies to

Share via