Share via


CosmosDBExtensions.GetCosmosDBThroughputPools Method

Definition

Overloads

GetCosmosDBThroughputPools(ResourceGroupResource)

Gets a collection of CosmosDBThroughputPoolResources in the ResourceGroupResource. MockingTo mock this method, please mock GetCosmosDBThroughputPools() instead.

GetCosmosDBThroughputPools(SubscriptionResource, CancellationToken)

Lists all the Azure Cosmos DB Throughput Pools available under the subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/throughputPools
  • Operation Id: ThroughputPools_List
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource

GetCosmosDBThroughputPools(ResourceGroupResource)

Source:
CosmosDBExtensions.cs

Gets a collection of CosmosDBThroughputPoolResources in the ResourceGroupResource. MockingTo mock this method, please mock GetCosmosDBThroughputPools() instead.

public static Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolCollection GetCosmosDBThroughputPools (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);
static member GetCosmosDBThroughputPools : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolCollection
<Extension()>
Public Function GetCosmosDBThroughputPools (resourceGroupResource As ResourceGroupResource) As CosmosDBThroughputPoolCollection

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

Returns

An object representing collection of CosmosDBThroughputPoolResources and their operations over a CosmosDBThroughputPoolResource.

Exceptions

resourceGroupResource is null.

Applies to

GetCosmosDBThroughputPools(SubscriptionResource, CancellationToken)

Source:
CosmosDBExtensions.cs

Lists all the Azure Cosmos DB Throughput Pools available under the subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/throughputPools
  • Operation Id: ThroughputPools_List
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
public static Azure.Pageable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource> GetCosmosDBThroughputPools (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBThroughputPools : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
<Extension()>
Public Function GetCosmosDBThroughputPools (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBThroughputPoolResource)

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of CosmosDBThroughputPoolResource that may take multiple service requests to iterate over.

Exceptions

subscriptionResource is null.

Applies to