MockableCosmosDBResourceGroupResource.GetCosmosDBAccountAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB.Mocking
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.10
Source:
MockableCosmosDBResourceGroupResource.cs
Source:
MockableCosmosDBResourceGroupResource.cs

Retrieves the properties of an existing Azure Cosmos DB database account.

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

Parameters

accountName
String

Cosmos DB database account name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBAccountResource>>

Exceptions

ArgumentNullException

accountName is null.

ArgumentException

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

Applies to