CosmosDBSqlContainerCollection.GetAsync(String, CancellationToken) Method
Definition
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>> GetAsync (string containerName, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>Public Overridable Function GetAsync (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
Exceptions
containerName is an empty string, and was expected to be non-empty.
containerName is null.
