CosmosDBExtensions.GetCosmosDBAccount Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBExtensions.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-09-01-preview
• Resource: CosmosDBAccountResource

public static Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBAccountResource> GetCosmosDBAccount (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string accountName, System.Threading.CancellationToken cancellationToken = default);

static member GetCosmosDBAccount : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBAccountResource>

<Extension()>
Public Function GetCosmosDBAccount (resourceGroupResource As ResourceGroupResource, accountName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBAccountResource)

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

accountName

String

Cosmos DB database account name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<CosmosDBAccountResource>

Exceptions

ArgumentNullException

resourceGroupResource or accountName is null.

ArgumentException

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