CosmosDBExtensions.GetThroughputPoolResourceAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.7

Source:: CosmosDBExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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-02-15-preview
Resource: ThroughputPoolResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.ThroughputPoolResource>> GetThroughputPoolResourceAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string throughputPoolName, System.Threading.CancellationToken cancellationToken = default);

static member GetThroughputPoolResourceAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.ThroughputPoolResource>>

<Extension()>
Public Function GetThroughputPoolResourceAsync (resourceGroupResource As ResourceGroupResource, throughputPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ThroughputPoolResource))

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

Exceptions

ArgumentNullException

resourceGroupResource or throughputPoolName is null.

ArgumentException

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

Applies to