CosmosDBExtensions.GetCosmosDBAccountAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.7

Source:: CosmosDBExtensions.cs

Source:: CosmosDBExtensions.cs

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.

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-02-15-preview
Resource: CosmosDBAccountResource

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

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

<Extension()>
Public Function GetCosmosDBAccountAsync (resourceGroupResource As ResourceGroupResource, accountName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<CosmosDBAccountResource>>

Exceptions

ArgumentNullException

resourceGroupResource or accountName is null.

ArgumentException

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

Applies to