CosmosDBExtensions.GetThroughputPoolResource Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

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

Overloads

GetThroughputPoolResource(ArmClient, ResourceIdentifier)	Gets an object representing a ThroughputPoolResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a ThroughputPoolResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetThroughputPoolResource(ResourceIdentifier) instead.
GetThroughputPoolResource(ResourceGroupResource, String, CancellationToken)	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

GetThroughputPoolResource(ArmClient, ResourceIdentifier)

Source:

CosmosDBExtensions.cs

Gets an object representing a ThroughputPoolResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a ThroughputPoolResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetThroughputPoolResource(ResourceIdentifier) instead.

public static Azure.ResourceManager.CosmosDB.ThroughputPoolResource GetThroughputPoolResource (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier id);

static member GetThroughputPoolResource : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.CosmosDB.ThroughputPoolResource

<Extension()>
Public Function GetThroughputPoolResource (client As ArmClient, id As ResourceIdentifier) As ThroughputPoolResource

Parameters

client

ArmClient

The ArmClient instance the method will execute against.

id

ResourceIdentifier

The resource ID of the resource to get.

Returns

ThroughputPoolResource

Returns a ThroughputPoolResource object.

Exceptions

ArgumentNullException

client is null.

GetThroughputPoolResource(ResourceGroupResource, String, CancellationToken)

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

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

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

<Extension()>
Public Function GetThroughputPoolResource (resourceGroupResource As ResourceGroupResource, throughputPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<ThroughputPoolResource>

Exceptions

ArgumentNullException

resourceGroupResource or throughputPoolName is null.

ArgumentException

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