Share via


CosmosDBThroughputPoolCollection Class

Definition

A class representing a collection of CosmosDBThroughputPoolResource and their operations. Each CosmosDBThroughputPoolResource in the collection will belong to the same instance of ResourceGroupResource. To get a CosmosDBThroughputPoolCollection instance call the GetCosmosDBThroughputPools method from an instance of ResourceGroupResource.

public class CosmosDBThroughputPoolCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
type CosmosDBThroughputPoolCollection = class
    inherit ArmCollection
    interface seq<CosmosDBThroughputPoolResource>
    interface IEnumerable
    interface IAsyncEnumerable<CosmosDBThroughputPoolResource>
Public Class CosmosDBThroughputPoolCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of CosmosDBThroughputPoolResource), IEnumerable(Of CosmosDBThroughputPoolResource)
Inheritance
CosmosDBThroughputPoolCollection
Implements

Constructors

CosmosDBThroughputPoolCollection()

Initializes a new instance of the CosmosDBThroughputPoolCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, CosmosDBThroughputPoolData, CancellationToken)

Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_CreateOrUpdate
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBThroughputPoolData, CancellationToken)

Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_CreateOrUpdate
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
Get(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: CosmosDBThroughputPoolResource
GetAll(CancellationToken)

List all the ThroughputPools in a given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools
  • Operation Id: ThroughputPools_ListByResourceGroup
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
GetAllAsync(CancellationToken)

List all the ThroughputPools in a given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools
  • Operation Id: ThroughputPools_ListByResourceGroup
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
GetAsync(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: CosmosDBThroughputPoolResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
  • Operation Id: ThroughputPool_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<CosmosDBThroughputPoolResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBThroughputPoolResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to