CosmosDBSqlDatabaseCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
  • Operation Id: SqlResources_GetSqlDatabase
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlDatabaseResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>> GetIfExistsAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>>
Public Overridable Function GetIfExistsAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBSqlDatabaseResource))

Parameters

databaseName
String

Cosmos DB database name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

databaseName is null.

Applies to