CosmosDBSqlContainerCollection.GetIfExists(String, CancellationToken) Method

Definition

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
public virtual Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource> GetIfExists (string containerName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>
override this.GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>
Public Overridable Function GetIfExists (containerName As String, Optional cancellationToken As CancellationToken = Nothing) As NullableResponse(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.

Applies to