CosmosDBAccountResource.GetCosmosDBTableAsync 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:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.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 Tables under an existing Azure Cosmos DB database account with the provided name.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
Operation Id: TableResources_GetTable
Default Api Version: 2024-09-01-preview
Resource: CosmosDBTableResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBTableResource>> GetCosmosDBTableAsync (string tableName, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetCosmosDBTableAsync (tableName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBTableResource))

Parameters

tableName: String

Cosmos DB table name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBTableResource>>

Exceptions

ArgumentNullException

tableName is null.

ArgumentException

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

Applies to

Share via