CosmosDBSqlDatabaseResource.GetCosmosDBSqlContainerAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBSqlDatabaseResource.cs

Source:: CosmosDBSqlDatabaseResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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-09-01-preview
Resource: CosmosDBSqlContainerResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>> GetCosmosDBSqlContainerAsync (string containerName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCosmosDBSqlContainerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>
override this.GetCosmosDBSqlContainerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>

Public Overridable Function GetCosmosDBSqlContainerAsync (containerName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBSqlContainerResource))

Parameters

containerName: String

Cosmos DB container name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBSqlContainerResource>>

Exceptions

ArgumentNullException

containerName is null.

ArgumentException

containerName is an empty string, and was expected to be non-empty.

Applies to

Aracılığıyla paylaş