CosmosDBSqlContainerCollection Class

Definition

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

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

Constructors

CosmosDBSqlContainerCollection()

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

Create or update an Azure Cosmos DB SQL container

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
  • Operation Id: SqlResources_CreateUpdateSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBSqlContainerCreateOrUpdateContent, CancellationToken)

Create or update an Azure Cosmos DB SQL container

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
  • Operation Id: SqlResources_CreateUpdateSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
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}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
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}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
Get(String, CancellationToken)

Gets the SQL container under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
GetAll(CancellationToken)

Lists the SQL container under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers
  • Operation Id: SqlResources_ListSqlContainers
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
GetAllAsync(CancellationToken)

Lists the SQL container under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers
  • Operation Id: SqlResources_ListSqlContainers
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
GetAsync(String, CancellationToken)

Gets the SQL container under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
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}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
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}/containers/{containerName}
  • Operation Id: SqlResources_GetSqlContainer
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlContainerResource
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<CosmosDBSqlContainerResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBSqlContainerResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to