TableResources | @azure/arm-cosmosdb

Interface representing a TableResources.

Hierarchy

TableResources

Implemented by

TableResourcesImpl

Index

Methods

beginCreateUpdateTable

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

- Defined in operationsInterfaces/tableResources.ts:69
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>

- Defined in operationsInterfaces/tableResources.ts:89
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>>

- Defined in operationsInterfaces/tableResources.ts:103
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>

- Defined in operationsInterfaces/tableResources.ts:116
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>>

- Defined in operationsInterfaces/tableResources.ts:180
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>

- Defined in operationsInterfaces/tableResources.ts:198
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>>

- Defined in operationsInterfaces/tableResources.ts:211
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>

- Defined in operationsInterfaces/tableResources.ts:229
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>>

- Defined in operationsInterfaces/tableResources.ts:243
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>

- Defined in operationsInterfaces/tableResources.ts:265
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>>

- Defined in operationsInterfaces/tableResources.ts:145
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>

- Defined in operationsInterfaces/tableResources.ts:166
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>

- Defined in operationsInterfaces/tableResources.ts:55
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>

- Defined in operationsInterfaces/tableResources.ts:130
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>

- Defined in operationsInterfaces/tableResources.ts:43
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

Implemented by

Index

Methods

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

accountName: string

tableName: string

location: ContinuousBackupRestoreLocation

Optional options: TableResourcesRetrieveContinuousBackupInformationOptionalParams

Returns Promise<TableResourcesRetrieveContinuousBackupInformationResponse>

beginUpdateTableThroughput