Share via


CosmosDBThroughputPoolAccountCollection Class

Definition

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

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

Constructors

CosmosDBThroughputPoolAccountCollection()

Initializes a new instance of the CosmosDBThroughputPoolAccountCollection 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, CosmosDBThroughputPoolAccountData, 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}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Create
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBThroughputPoolAccountData, 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}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Create
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
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}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
GetAll(CancellationToken)

Lists all the Azure Cosmos DB accounts available under the subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts
  • Operation Id: ThroughputPoolAccounts_List
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
GetAllAsync(CancellationToken)

Lists all the Azure Cosmos DB accounts available under the subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts
  • Operation Id: ThroughputPoolAccounts_List
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
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}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
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<CosmosDBThroughputPoolAccountResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBThroughputPoolAccountResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to