MockableCosmosDBTenantResource.CheckNameExistsDatabaseAccountAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB.Mocking

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

MockableCosmosDBTenantResource.cs

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 virtual System.Threading.Tasks.Task<Azure.Response<bool>> CheckNameExistsDatabaseAccountAsync (string accountName, System.Threading.CancellationToken cancellationToken = default);

abstract member CheckNameExistsDatabaseAccountAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.CheckNameExistsDatabaseAccountAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function CheckNameExistsDatabaseAccountAsync (accountName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

accountName

String

Cosmos DB database account name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<Boolean>>

Exceptions

ArgumentException

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

ArgumentNullException

accountName is null.