CosmosDBAccountResource.GetCosmosDBSqlDatabaseAsync Method
Definition
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.
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-09-01-preview
- Resource: CosmosDBSqlDatabaseResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>> GetCosmosDBSqlDatabaseAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBSqlDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>
override this.GetCosmosDBSqlDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>
Public Overridable Function GetCosmosDBSqlDatabaseAsync (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
Exceptions
databaseName
is null.
databaseName
is an empty string, and was expected to be non-empty.