CosmosDBSqlContainerCollection.GetIfExistsAsync 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:: CosmosDBSqlContainerCollection.cs

Source:: CosmosDBSqlContainerCollection.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.

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

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

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

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

Parameters

containerName: String

Cosmos DB container name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<CosmosDBSqlContainerResource>>

Exceptions

ArgumentException

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

ArgumentNullException

containerName is null.

Applies to

Dela via