CosmosDBThroughputPoolCollection.Get(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

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

Source:: CosmosDBThroughputPoolCollection.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: CosmosDBThroughputPoolResource

public virtual Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource> Get (string throughputPoolName, System.Threading.CancellationToken cancellationToken = default);

abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>

Public Overridable Function Get (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

Response<CosmosDBThroughputPoolResource>

Exceptions

ArgumentException

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

ArgumentNullException

throughputPoolName is null.

Applies to

Share via