CosmosDBExtensions.GetCosmosDBThroughputPoolAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:

CosmosDBExtensions.cs

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 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

Task<Response<CosmosDBThroughputPoolResource>>

Exceptions

ArgumentNullException

resourceGroupResource or throughputPoolName is null.

ArgumentException

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