共用方式為


CosmosDBExtensions.GetCosmosDBThroughputPoolAsync Method

Definition

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_Get
  • Default Api Version: 2024-12-01-preview
  • Resource: CosmosDBThroughputPoolResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>> GetCosmosDBThroughputPoolAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string throughputPoolName, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBThroughputPoolAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>>
<Extension()>
Public Function GetCosmosDBThroughputPoolAsync (resourceGroupResource As ResourceGroupResource, throughputPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBThroughputPoolResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

throughputPoolName
String

Cosmos DB Throughput Pool name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or throughputPoolName is null.

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

Applies to