Share via


CosmosDBThroughputPoolAccountCollection.Get(String, CancellationToken) 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-02-15-preview
  • Resource: CosmosDBThroughputPoolAccountResource
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource> Get (string throughputPoolAccountName, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>
Public Overridable Function Get (throughputPoolAccountName As String, Optional cancellationToken As CancellationToken = Nothing) As 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 an empty string, and was expected to be non-empty.

throughputPoolAccountName is null.

Applies to