TableResourcesImpl | @azure/arm-cosmosdb

Class containing TableResources operations.

Hierarchy

TableResourcesImpl

Implements

TableResources

Index

Constructors

constructor

Methods

Constructors

constructor

new TableResourcesImpl(client: CosmosDBManagementClient): TableResourcesImpl

- Defined in operations/tableResources.ts:44
Initialize a new instance of the class TableResources class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns TableResourcesImpl

Methods

beginCreateUpdateTable

beginCreateUpdateTable(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<PollerLike<PollOperationState<TableResourcesCreateUpdateTableResponse>, TableResourcesCreateUpdateTableResponse>>

Implementation of TableResources.beginCreateUpdateTable
- Defined in operations/tableResources.ts:158
Create or update an Azure Cosmos DB Table

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- createUpdateTableParameters: TableCreateUpdateParameters
  
  The parameters to provide for the current Table.
- Optional options: TableResourcesCreateUpdateTableOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TableResourcesCreateUpdateTableResponse>, TableResourcesCreateUpdateTableResponse>>

beginCreateUpdateTableAndWait

beginCreateUpdateTableAndWait(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<TableResourcesCreateUpdateTableResponse>

Implementation of TableResources.beginCreateUpdateTableAndWait
- Defined in operations/tableResources.ts:236
Create or update an Azure Cosmos DB Table

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- createUpdateTableParameters: TableCreateUpdateParameters
  
  The parameters to provide for the current Table.
- Optional options: TableResourcesCreateUpdateTableOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesCreateUpdateTableResponse>

beginDeleteTable

beginDeleteTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of TableResources.beginDeleteTable
- Defined in operations/tableResources.ts:260
Deletes an existing Azure Cosmos DB Table.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesDeleteTableOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteTableAndWait

beginDeleteTableAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<void>

Implementation of TableResources.beginDeleteTableAndWait
- Defined in operations/tableResources.ts:325
Deletes an existing Azure Cosmos DB Table.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesDeleteTableOptionalParams
  
  The options parameters.
Returns Promise<void>

beginMigrateTableToAutoscale

beginMigrateTableToAutoscale(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToAutoscaleResponse>, TableResourcesMigrateTableToAutoscaleResponse>>

Implementation of TableResources.beginMigrateTableToAutoscale
- Defined in operations/tableResources.ts:472
Migrate an Azure Cosmos DB Table from manual throughput to autoscale

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesMigrateTableToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToAutoscaleResponse>, TableResourcesMigrateTableToAutoscaleResponse>>

beginMigrateTableToAutoscaleAndWait

beginMigrateTableToAutoscaleAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<TableResourcesMigrateTableToAutoscaleResponse>

Implementation of TableResources.beginMigrateTableToAutoscaleAndWait
- Defined in operations/tableResources.ts:542
Migrate an Azure Cosmos DB Table from manual throughput to autoscale

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesMigrateTableToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesMigrateTableToAutoscaleResponse>

beginMigrateTableToManualThroughput

beginMigrateTableToManualThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToManualThroughputResponse>, TableResourcesMigrateTableToManualThroughputResponse>>

Implementation of TableResources.beginMigrateTableToManualThroughput
- Defined in operations/tableResources.ts:564
Migrate an Azure Cosmos DB Table from autoscale to manual throughput

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesMigrateTableToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToManualThroughputResponse>, TableResourcesMigrateTableToManualThroughputResponse>>

beginMigrateTableToManualThroughputAndWait

beginMigrateTableToManualThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<TableResourcesMigrateTableToManualThroughputResponse>

Implementation of TableResources.beginMigrateTableToManualThroughputAndWait
- Defined in operations/tableResources.ts:634
Migrate an Azure Cosmos DB Table from autoscale to manual throughput

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesMigrateTableToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesMigrateTableToManualThroughputResponse>

beginRetrieveContinuousBackupInformation

beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<PollerLike<PollOperationState<TableResourcesRetrieveContinuousBackupInformationResponse>, TableResourcesRetrieveContinuousBackupInformationResponse>>

Implementation of TableResources.beginRetrieveContinuousBackupInformation
- Defined in operations/tableResources.ts:657
Retrieves continuous backup information for a table.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- location: ContinuousBackupRestoreLocation
  
  The name of the continuous backup restore location.
- Optional options: TableResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TableResourcesRetrieveContinuousBackupInformationResponse>, TableResourcesRetrieveContinuousBackupInformationResponse>>

beginRetrieveContinuousBackupInformationAndWait

beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<TableResourcesRetrieveContinuousBackupInformationResponse>

Implementation of TableResources.beginRetrieveContinuousBackupInformationAndWait
- Defined in operations/tableResources.ts:732
Retrieves continuous backup information for a table.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- location: ContinuousBackupRestoreLocation
  
  The name of the continuous backup restore location.
- Optional options: TableResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesRetrieveContinuousBackupInformationResponse>

beginUpdateTableThroughput

beginUpdateTableThroughput(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<PollerLike<PollOperationState<TableResourcesUpdateTableThroughputResponse>, TableResourcesUpdateTableThroughputResponse>>

Implementation of TableResources.beginUpdateTableThroughput
- Defined in operations/tableResources.ts:369
Update RUs per second of an Azure Cosmos DB Table

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- updateThroughputParameters: ThroughputSettingsUpdateParameters
  
  The parameters to provide for the RUs per second of the current Table.
- Optional options: TableResourcesUpdateTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TableResourcesUpdateTableThroughputResponse>, TableResourcesUpdateTableThroughputResponse>>

beginUpdateTableThroughputAndWait

beginUpdateTableThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<TableResourcesUpdateTableThroughputResponse>

Implementation of TableResources.beginUpdateTableThroughputAndWait
- Defined in operations/tableResources.ts:448
Update RUs per second of an Azure Cosmos DB Table

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- updateThroughputParameters: ThroughputSettingsUpdateParameters
  
  The parameters to provide for the RUs per second of the current Table.
- Optional options: TableResourcesUpdateTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesUpdateTableThroughputResponse>

getTable

getTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableOptionalParams): Promise<TableResourcesGetTableResponse>

Implementation of TableResources.getTable
- Defined in operations/tableResources.ts:138
Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesGetTableOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesGetTableResponse>

getTableThroughput

getTableThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableThroughputOptionalParams): Promise<TableResourcesGetTableThroughputResponse>

Implementation of TableResources.getTableThroughput
- Defined in operations/tableResources.ts:348
Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- tableName: string
  
  Cosmos DB table name.
- Optional options: TableResourcesGetTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<TableResourcesGetTableThroughputResponse>

listTables

listTables(resourceGroupName: string, accountName: string, options?: TableResourcesListTablesOptionalParams): PagedAsyncIterableIterator<TableGetResults>

Implementation of TableResources.listTables
- Defined in operations/tableResources.ts:60
Lists the Tables under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: TableResourcesListTablesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TableGetResults>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CosmosDBManagementClient

Returns TableResourcesImpl

Methods

beginCreateUpdateTable

Parameters

resourceGroupName: string

accountName: string

tableName: string

createUpdateTableParameters: TableCreateUpdateParameters

Optional options: TableResourcesCreateUpdateTableOptionalParams

Returns Promise<PollerLike<PollOperationState<TableResourcesCreateUpdateTableResponse>, TableResourcesCreateUpdateTableResponse>>

beginCreateUpdateTableAndWait

Parameters

resourceGroupName: string

accountName: string

tableName: string

createUpdateTableParameters: TableCreateUpdateParameters

Optional options: TableResourcesCreateUpdateTableOptionalParams

Returns Promise<TableResourcesCreateUpdateTableResponse>

beginDeleteTable

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesDeleteTableOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteTableAndWait

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesDeleteTableOptionalParams

Returns Promise<void>

beginMigrateTableToAutoscale

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesMigrateTableToAutoscaleOptionalParams

Returns Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToAutoscaleResponse>, TableResourcesMigrateTableToAutoscaleResponse>>

beginMigrateTableToAutoscaleAndWait

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesMigrateTableToAutoscaleOptionalParams

Returns Promise<TableResourcesMigrateTableToAutoscaleResponse>

beginMigrateTableToManualThroughput

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesMigrateTableToManualThroughputOptionalParams

Returns Promise<PollerLike<PollOperationState<TableResourcesMigrateTableToManualThroughputResponse>, TableResourcesMigrateTableToManualThroughputResponse>>

beginMigrateTableToManualThroughputAndWait

Parameters

resourceGroupName: string

accountName: string

tableName: string

Optional options: TableResourcesMigrateTableToManualThroughputOptionalParams

Returns Promise<TableResourcesMigrateTableToManualThroughputResponse>

beginRetrieveContinuousBackupInformation

Parameters

resourceGroupName: string

accountName: string

tableName: string

location: ContinuousBackupRestoreLocation

Optional options: TableResourcesRetrieveContinuousBackupInformationOptionalParams

Returns Promise<PollerLike<PollOperationState<TableResourcesRetrieveContinuousBackupInformationResponse>, TableResourcesRetrieveContinuousBackupInformationResponse>>

beginRetrieveContinuousBackupInformationAndWait

Parameters

resourceGroupName: string