TableResources interface
Interface representing a TableResources.
Methods
Method Details
beginCreateUpdateTable(string, string, string, TableCreateUpdateParameters, TableResourcesCreateUpdateTableOptionalParams)
Create or update an Azure Cosmos DB Table
function beginCreateUpdateTable(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>
beginCreateUpdateTableAndWait(string, string, string, TableCreateUpdateParameters, TableResourcesCreateUpdateTableOptionalParams)
Create or update an Azure Cosmos DB Table
function beginCreateUpdateTableAndWait(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<TableGetResults>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.
The options parameters.
Returns
Promise<TableGetResults>
beginDeleteTable(string, string, string, TableResourcesDeleteTableOptionalParams)
Deletes an existing Azure Cosmos DB Table.
function beginDeleteTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<SimplePollerLike<OperationState<TableResourcesDeleteTableHeaders>, TableResourcesDeleteTableHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableResourcesDeleteTableHeaders>, TableResourcesDeleteTableHeaders>>
beginDeleteTableAndWait(string, string, string, TableResourcesDeleteTableOptionalParams)
Deletes an existing Azure Cosmos DB Table.
function beginDeleteTableAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<TableResourcesDeleteTableHeaders>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.
The options parameters.
Returns
Promise<TableResourcesDeleteTableHeaders>
beginMigrateTableToAutoscale(string, string, string, TableResourcesMigrateTableToAutoscaleOptionalParams)
Migrate an Azure Cosmos DB Table from manual throughput to autoscale
function beginMigrateTableToAutoscale(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateTableToAutoscaleAndWait(string, string, string, TableResourcesMigrateTableToAutoscaleOptionalParams)
Migrate an Azure Cosmos DB Table from manual throughput to autoscale
function beginMigrateTableToAutoscaleAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
beginMigrateTableToManualThroughput(string, string, string, TableResourcesMigrateTableToManualThroughputOptionalParams)
Migrate an Azure Cosmos DB Table from autoscale to manual throughput
function beginMigrateTableToManualThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateTableToManualThroughputAndWait(string, string, string, TableResourcesMigrateTableToManualThroughputOptionalParams)
Migrate an Azure Cosmos DB Table from autoscale to manual throughput
function beginMigrateTableToManualThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
beginRetrieveContinuousBackupInformation(string, string, string, ContinuousBackupRestoreLocation, TableResourcesRetrieveContinuousBackupInformationOptionalParams)
Retrieves continuous backup information for a table.
function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>
beginRetrieveContinuousBackupInformationAndWait(string, string, string, ContinuousBackupRestoreLocation, TableResourcesRetrieveContinuousBackupInformationOptionalParams)
Retrieves continuous backup information for a table.
function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>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.
The options parameters.
Returns
Promise<BackupInformation>
beginUpdateTableThroughput(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
Update RUs per second of an Azure Cosmos DB Table
function beginUpdateTableThroughput(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginUpdateTableThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
Update RUs per second of an Azure Cosmos DB Table
function beginUpdateTableThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
getTable(string, string, string, TableResourcesGetTableOptionalParams)
Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
function getTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableOptionalParams): Promise<TableGetResults>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.
The options parameters.
Returns
Promise<TableGetResults>
getTableThroughput(string, string, string, TableResourcesGetTableThroughputOptionalParams)
Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
function getTableThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
listTables(string, string, TableResourcesListTablesOptionalParams)
Lists the Tables under an existing Azure Cosmos DB database account.
function listTables(resourceGroupName: string, accountName: string, options?: TableResourcesListTablesOptionalParams): PagedAsyncIterableIterator<TableGetResults, TableGetResults[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
The options parameters.