CosmosDBThroughputPoolResource.GetCosmosDBThroughputPoolAccountAsync Method

Definition

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>> GetCosmosDBThroughputPoolAccountAsync (string throughputPoolAccountName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBThroughputPoolAccountAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
override this.GetCosmosDBThroughputPoolAccountAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
Public Overridable Function GetCosmosDBThroughputPoolAccountAsync (throughputPoolAccountName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBThroughputPoolAccountResource))

Parameters

throughputPoolAccountName
String

Cosmos DB global database account in a Throughput Pool.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

throughputPoolAccountName is null.

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

Applies to