CosmosDBAccountCollection Class

Definition

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

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

Constructors

CosmosDBAccountCollection()

Initializes a new instance of the CosmosDBAccountCollection 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, CosmosDBAccountCreateOrUpdateContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_CreateOrUpdate
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBAccountCreateOrUpdateContent, CancellationToken)

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

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
Get(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
GetAll(CancellationToken)

Lists all the Azure Cosmos DB database accounts available under the given resource group.

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

Lists all the Azure Cosmos DB database accounts available under the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts
  • Operation Id: DatabaseAccounts_ListByResourceGroup
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
GetAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
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<CosmosDBAccountResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBAccountResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to