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>
beginCreateUpdateTableRoleAssignment(string, string, string, TableRoleAssignmentResource, TableResourcesCreateUpdateTableRoleAssignmentOptionalParams)
Creates or updates an Azure Cosmos DB Table Role Assignment.
function beginCreateUpdateTableRoleAssignment(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams): Promise<SimplePollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleAssignmentId
-
string
The GUID for the Role Assignment.
- createUpdateTableRoleAssignmentParameters
- TableRoleAssignmentResource
The properties required to create or update a Role Assignment.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>>
beginCreateUpdateTableRoleAssignmentAndWait(string, string, string, TableRoleAssignmentResource, TableResourcesCreateUpdateTableRoleAssignmentOptionalParams)
Creates or updates an Azure Cosmos DB Table Role Assignment.
function beginCreateUpdateTableRoleAssignmentAndWait(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams): Promise<TableRoleAssignmentResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleAssignmentId
-
string
The GUID for the Role Assignment.
- createUpdateTableRoleAssignmentParameters
- TableRoleAssignmentResource
The properties required to create or update a Role Assignment.
The options parameters.
Returns
Promise<TableRoleAssignmentResource>
beginCreateUpdateTableRoleDefinition(string, string, string, TableRoleDefinitionResource, TableResourcesCreateUpdateTableRoleDefinitionOptionalParams)
Creates or updates an Azure Cosmos DB Table Role Definition.
function beginCreateUpdateTableRoleDefinition(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleDefinitionId
-
string
The GUID for the Role Definition.
- createUpdateTableRoleDefinitionParameters
- TableRoleDefinitionResource
The properties required to create or update a Role Definition.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>>
beginCreateUpdateTableRoleDefinitionAndWait(string, string, string, TableRoleDefinitionResource, TableResourcesCreateUpdateTableRoleDefinitionOptionalParams)
Creates or updates an Azure Cosmos DB Table Role Definition.
function beginCreateUpdateTableRoleDefinitionAndWait(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams): Promise<TableRoleDefinitionResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleDefinitionId
-
string
The GUID for the Role Definition.
- createUpdateTableRoleDefinitionParameters
- TableRoleDefinitionResource
The properties required to create or update a Role Definition.
The options parameters.
Returns
Promise<TableRoleDefinitionResource>
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>
beginDeleteTableRoleAssignment(string, string, string, TableResourcesDeleteTableRoleAssignmentOptionalParams)
Deletes an existing Azure Cosmos DB Table Role Assignment.
function beginDeleteTableRoleAssignment(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleAssignmentId
-
string
The GUID for the Role Assignment.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteTableRoleAssignmentAndWait(string, string, string, TableResourcesDeleteTableRoleAssignmentOptionalParams)
Deletes an existing Azure Cosmos DB Table Role Assignment.
function beginDeleteTableRoleAssignmentAndWait(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleAssignmentId
-
string
The GUID for the Role Assignment.
The options parameters.
Returns
Promise<void>
beginDeleteTableRoleDefinition(string, string, string, TableResourcesDeleteTableRoleDefinitionOptionalParams)
Deletes an existing Azure Cosmos DB Table Role Definition.
function beginDeleteTableRoleDefinition(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleDefinitionId
-
string
The GUID for the Role Definition.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteTableRoleDefinitionAndWait(string, string, string, TableResourcesDeleteTableRoleDefinitionOptionalParams)
Deletes an existing Azure Cosmos DB Table Role Definition.
function beginDeleteTableRoleDefinitionAndWait(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleDefinitionId
-
string
The GUID for the Role Definition.
The options parameters.
Returns
Promise<void>
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>
getTableRoleAssignment(string, string, string, TableResourcesGetTableRoleAssignmentOptionalParams)
Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.
function getTableRoleAssignment(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesGetTableRoleAssignmentOptionalParams): Promise<TableRoleAssignmentResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleAssignmentId
-
string
The GUID for the Role Assignment.
The options parameters.
Returns
Promise<TableRoleAssignmentResource>
getTableRoleDefinition(string, string, string, TableResourcesGetTableRoleDefinitionOptionalParams)
Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.
function getTableRoleDefinition(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesGetTableRoleDefinitionOptionalParams): Promise<TableRoleDefinitionResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- roleDefinitionId
-
string
The GUID for the Role Definition.
The options parameters.
Returns
Promise<TableRoleDefinitionResource>
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>
listTableRoleAssignments(string, string, TableResourcesListTableRoleAssignmentsOptionalParams)
Retrieves the list of all Azure Cosmos DB Table Role Assignments.
function listTableRoleAssignments(resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleAssignmentsOptionalParams): PagedAsyncIterableIterator<TableRoleAssignmentResource, TableRoleAssignmentResource[], 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.
Returns
listTableRoleDefinitions(string, string, TableResourcesListTableRoleDefinitionsOptionalParams)
Retrieves the list of all Azure Cosmos DB Table Role Definitions.
function listTableRoleDefinitions(resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<TableRoleDefinitionResource, TableRoleDefinitionResource[], 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.
Returns
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.
