CosmosDBSqlDatabaseCollection.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBSqlDatabaseCollection.cs

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
• Operation Id: SqlResources_GetSqlDatabase
• Default Api Version: 2024-02-15-preview
• Resource: CosmosDBSqlDatabaseResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>> GetAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>

Public Overridable Function GetAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBSqlDatabaseResource))

Parameters

databaseName

String

Cosmos DB database name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBSqlDatabaseResource>>

Exceptions

ArgumentException

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

ArgumentNullException

databaseName is null.