Share via


MockableCosmosDBResourceGroupResource.GetCosmosDBThroughputPool 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-09-01-preview
  • Resource: CosmosDBThroughputPoolResource
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource> GetCosmosDBThroughputPool (string throughputPoolName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBThroughputPool : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
override this.GetCosmosDBThroughputPool : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
Public Overridable Function GetCosmosDBThroughputPool (throughputPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBThroughputPoolResource)

Parameters

throughputPoolName
String

Cosmos DB Throughput Pool name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

throughputPoolName is null.

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

Applies to