TableResourcesOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a TableResources operations.

Properties

beginCreateUpdateTable
beginCreateUpdateTableAndWait
beginCreateUpdateTableRoleAssignment
beginCreateUpdateTableRoleAssignmentAndWait
beginCreateUpdateTableRoleDefinition
beginCreateUpdateTableRoleDefinitionAndWait
beginDeleteTable
beginDeleteTableAndWait
beginDeleteTableRoleAssignment
beginDeleteTableRoleAssignmentAndWait
beginDeleteTableRoleDefinition
beginDeleteTableRoleDefinitionAndWait
beginMigrateTableToAutoscale
beginMigrateTableToAutoscaleAndWait
beginMigrateTableToManualThroughput
beginMigrateTableToManualThroughputAndWait
beginRetrieveContinuousBackupInformation
beginRetrieveContinuousBackupInformationAndWait
beginUpdateTableThroughput
beginUpdateTableThroughputAndWait
createUpdateTable	Create or update an Azure Cosmos DB Table
createUpdateTableRoleAssignment	Creates or updates an Azure Cosmos DB Table Role Assignment.
createUpdateTableRoleDefinition	Creates or updates an Azure Cosmos DB Table Role Definition.
deleteTable	Deletes an existing Azure Cosmos DB Table.
deleteTableRoleAssignment	Deletes an existing Azure Cosmos DB Table Role Assignment.
deleteTableRoleDefinition	Deletes an existing Azure Cosmos DB Table Role Definition.
getTable	Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
getTableRoleAssignment	Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.
getTableRoleDefinition	Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.
getTableThroughput	Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
listTableRoleAssignments	Retrieves the list of all Azure Cosmos DB Table Role Assignments.
listTableRoleDefinitions	Retrieves the list of all Azure Cosmos DB Table Role Definitions.
listTables	Lists the Tables under an existing Azure Cosmos DB database account.
migrateTableToAutoscale	Migrate an Azure Cosmos DB Table from manual throughput to autoscale
migrateTableToManualThroughput	Migrate an Azure Cosmos DB Table from autoscale to manual throughput
retrieveContinuousBackupInformation	Retrieves continuous backup information for a table.
updateTableThroughput	Update RUs per second of an Azure Cosmos DB Table

Property Details

beginCreateUpdateTable

Warning

This API is now deprecated.

use createUpdateTable instead

beginCreateUpdateTable: (resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams) => Promise<SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams) => Promise<SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>

beginCreateUpdateTableAndWait

Warning

This API is now deprecated.

use createUpdateTable instead

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

Property Value

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

beginCreateUpdateTableRoleAssignment

Warning

This API is now deprecated.

use createUpdateTableRoleAssignment instead

beginCreateUpdateTableRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>>

beginCreateUpdateTableRoleAssignmentAndWait

Warning

This API is now deprecated.

use createUpdateTableRoleAssignment instead

beginCreateUpdateTableRoleAssignmentAndWait: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => Promise<TableRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => Promise<TableRoleAssignmentResource>

beginCreateUpdateTableRoleDefinition

Warning

This API is now deprecated.

use createUpdateTableRoleDefinition instead

beginCreateUpdateTableRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>>

beginCreateUpdateTableRoleDefinitionAndWait

Warning

This API is now deprecated.

use createUpdateTableRoleDefinition instead

beginCreateUpdateTableRoleDefinitionAndWait: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => Promise<TableRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => Promise<TableRoleDefinitionResource>

beginDeleteTable

Warning

This API is now deprecated.

use deleteTable instead

beginDeleteTable: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteTableAndWait

Warning

This API is now deprecated.

use deleteTable instead

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

Property Value

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

beginDeleteTableRoleAssignment

Warning

This API is now deprecated.

use deleteTableRoleAssignment instead

beginDeleteTableRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteTableRoleAssignmentAndWait

Warning

This API is now deprecated.

use deleteTableRoleAssignment instead

beginDeleteTableRoleAssignmentAndWait: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => Promise<void>

beginDeleteTableRoleDefinition

Warning

This API is now deprecated.

use deleteTableRoleDefinition instead

beginDeleteTableRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteTableRoleDefinitionAndWait

Warning

This API is now deprecated.

use deleteTableRoleDefinition instead

beginDeleteTableRoleDefinitionAndWait: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => Promise<void>

beginMigrateTableToAutoscale

Warning

This API is now deprecated.

use migrateTableToAutoscale instead

beginMigrateTableToAutoscale: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateTableToAutoscaleAndWait

Warning

This API is now deprecated.

use migrateTableToAutoscale instead

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

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams) => Promise<ThroughputSettingsGetResults>

beginMigrateTableToManualThroughput

Warning

This API is now deprecated.

use migrateTableToManualThroughput instead

beginMigrateTableToManualThroughput: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateTableToManualThroughputAndWait

Warning

This API is now deprecated.

use migrateTableToManualThroughput instead

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

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams) => Promise<ThroughputSettingsGetResults>

beginRetrieveContinuousBackupInformation

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

beginRetrieveContinuousBackupInformation: (resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams) => Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams) => Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

beginRetrieveContinuousBackupInformationAndWait

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

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

Property Value

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

beginUpdateTableThroughput

Warning

This API is now deprecated.

use updateTableThroughput instead

beginUpdateTableThroughput: (resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateTableThroughputAndWait

Warning

This API is now deprecated.

use updateTableThroughput instead

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

Property Value

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

createUpdateTable

Create or update an Azure Cosmos DB Table

createUpdateTable: (resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams) => PollerLike<OperationState<TableGetResults>, TableGetResults>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams) => PollerLike<OperationState<TableGetResults>, TableGetResults>

createUpdateTableRoleAssignment

Creates or updates an Azure Cosmos DB Table Role Assignment.

createUpdateTableRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => PollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateTableRoleAssignmentParameters: TableRoleAssignmentResource, options?: TableResourcesCreateUpdateTableRoleAssignmentOptionalParams) => PollerLike<OperationState<TableRoleAssignmentResource>, TableRoleAssignmentResource>

createUpdateTableRoleDefinition

Creates or updates an Azure Cosmos DB Table Role Definition.

createUpdateTableRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => PollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateTableRoleDefinitionParameters: TableRoleDefinitionResource, options?: TableResourcesCreateUpdateTableRoleDefinitionOptionalParams) => PollerLike<OperationState<TableRoleDefinitionResource>, TableRoleDefinitionResource>

deleteTable

Deletes an existing Azure Cosmos DB Table.

deleteTable: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams) => PollerLike<OperationState<void>, void>

deleteTableRoleAssignment

Deletes an existing Azure Cosmos DB Table Role Assignment.

deleteTableRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesDeleteTableRoleAssignmentOptionalParams) => PollerLike<OperationState<void>, void>

deleteTableRoleDefinition

Deletes an existing Azure Cosmos DB Table Role Definition.

deleteTableRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesDeleteTableRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

getTable

Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

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

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableOptionalParams) => Promise<TableGetResults>

getTableRoleAssignment

Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.

getTableRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesGetTableRoleAssignmentOptionalParams) => Promise<TableRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: TableResourcesGetTableRoleAssignmentOptionalParams) => Promise<TableRoleAssignmentResource>

getTableRoleDefinition

Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.

getTableRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesGetTableRoleDefinitionOptionalParams) => Promise<TableRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: TableResourcesGetTableRoleDefinitionOptionalParams) => Promise<TableRoleDefinitionResource>

getTableThroughput

Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.

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

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableThroughputOptionalParams) => Promise<ThroughputSettingsGetResults>

listTableRoleAssignments

Retrieves the list of all Azure Cosmos DB Table Role Assignments.

listTableRoleAssignments: (resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleAssignmentsOptionalParams) => PagedAsyncIterableIterator<TableRoleAssignmentResource, TableRoleAssignmentResource[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleAssignmentsOptionalParams) => PagedAsyncIterableIterator<TableRoleAssignmentResource, TableRoleAssignmentResource[], PageSettings>

listTableRoleDefinitions

Retrieves the list of all Azure Cosmos DB Table Role Definitions.

listTableRoleDefinitions: (resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleDefinitionsOptionalParams) => PagedAsyncIterableIterator<TableRoleDefinitionResource, TableRoleDefinitionResource[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: TableResourcesListTableRoleDefinitionsOptionalParams) => PagedAsyncIterableIterator<TableRoleDefinitionResource, TableRoleDefinitionResource[], PageSettings>

listTables

Lists the Tables under an existing Azure Cosmos DB database account.

listTables: (resourceGroupName: string, accountName: string, options?: TableResourcesListTablesOptionalParams) => PagedAsyncIterableIterator<TableGetResults, TableGetResults[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: TableResourcesListTablesOptionalParams) => PagedAsyncIterableIterator<TableGetResults, TableGetResults[], PageSettings>

migrateTableToAutoscale

Migrate an Azure Cosmos DB Table from manual throughput to autoscale

migrateTableToAutoscale: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateTableToManualThroughput

Migrate an Azure Cosmos DB Table from autoscale to manual throughput

migrateTableToManualThroughput: (resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

retrieveContinuousBackupInformation

Retrieves continuous backup information for a table.

retrieveContinuousBackupInformation: (resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

updateTableThroughput

Update RUs per second of an Azure Cosmos DB Table

updateTableThroughput: (resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>