CosmosDBSqlDatabaseCollection Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBSqlDatabaseCollection.cs

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

public class CosmosDBSqlDatabaseCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBSqlDatabaseResource>

type CosmosDBSqlDatabaseCollection = class
    inherit ArmCollection
    interface seq<CosmosDBSqlDatabaseResource>
    interface IEnumerable
    interface IAsyncEnumerable<CosmosDBSqlDatabaseResource>

Public Class CosmosDBSqlDatabaseCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of CosmosDBSqlDatabaseResource), IEnumerable(Of CosmosDBSqlDatabaseResource)

Inheritance

Object

ArmCollection

CosmosDBSqlDatabaseCollection

Implements

IAsyncEnumerable<CosmosDBSqlDatabaseResource> IEnumerable<CosmosDBSqlDatabaseResource> IEnumerable

Constructors

CosmosDBSqlDatabaseCollection()

Initializes a new instance of the CosmosDBSqlDatabaseCollection 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, CosmosDBSqlDatabaseCreateOrUpdateContent, CancellationToken)	Create or update an Azure Cosmos DB SQL database Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_CreateUpdateSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBSqlDatabaseCreateOrUpdateContent, CancellationToken)	Create or update an Azure Cosmos DB SQL database Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_CreateUpdateSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
Get(String, CancellationToken)	Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
GetAll(CancellationToken)	Lists the SQL databases under an existing Azure Cosmos DB database account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases Operation Id: SqlResources_ListSqlDatabases Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
GetAllAsync(CancellationToken)	Lists the SQL databases under an existing Azure Cosmos DB database account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases Operation Id: SqlResources_ListSqlDatabases Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
GetAsync(String, CancellationToken)	Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} Operation Id: SqlResources_GetSqlDatabase Default Api Version: 2024-05-15-preview Resource: CosmosDBSqlDatabaseResource
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<CosmosDBSqlDatabaseResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<CosmosDBSqlDatabaseResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.