TableResources interface
代表 TableResources 的介面。
方法
方法詳細資料
beginCreateUpdateTable(string, string, string, TableCreateUpdateParameters, TableResourcesCreateUpdateTableOptionalParams)
建立或更新 Azure Cosmos DB 資料表
function beginCreateUpdateTable(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- createUpdateTableParameters
- TableCreateUpdateParameters
要提供給目前資料表的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableGetResults>, TableGetResults>>
beginCreateUpdateTableAndWait(string, string, string, TableCreateUpdateParameters, TableResourcesCreateUpdateTableOptionalParams)
建立或更新 Azure Cosmos DB 資料表
function beginCreateUpdateTableAndWait(resourceGroupName: string, accountName: string, tableName: string, createUpdateTableParameters: TableCreateUpdateParameters, options?: TableResourcesCreateUpdateTableOptionalParams): Promise<TableGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- createUpdateTableParameters
- TableCreateUpdateParameters
要提供給目前資料表的參數。
選項參數。
傳回
Promise<TableGetResults>
beginDeleteTable(string, string, string, TableResourcesDeleteTableOptionalParams)
刪除現有的 Azure Cosmos DB 資料表。
function beginDeleteTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<SimplePollerLike<OperationState<TableResourcesDeleteTableHeaders>, TableResourcesDeleteTableHeaders>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TableResourcesDeleteTableHeaders>, TableResourcesDeleteTableHeaders>>
beginDeleteTableAndWait(string, string, string, TableResourcesDeleteTableOptionalParams)
刪除現有的 Azure Cosmos DB 資料表。
function beginDeleteTableAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesDeleteTableOptionalParams): Promise<TableResourcesDeleteTableHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<TableResourcesDeleteTableHeaders>
beginMigrateTableToAutoscale(string, string, string, TableResourcesMigrateTableToAutoscaleOptionalParams)
將 Azure Cosmos DB 資料表從手動輸送量遷移至自動調整
function beginMigrateTableToAutoscale(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateTableToAutoscaleAndWait(string, string, string, TableResourcesMigrateTableToAutoscaleOptionalParams)
將 Azure Cosmos DB 資料表從手動輸送量遷移至自動調整
function beginMigrateTableToAutoscaleAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<ThroughputSettingsGetResults>
beginMigrateTableToManualThroughput(string, string, string, TableResourcesMigrateTableToManualThroughputOptionalParams)
將 Azure Cosmos DB 資料表從自動調整移轉至手動輸送量
function beginMigrateTableToManualThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateTableToManualThroughputAndWait(string, string, string, TableResourcesMigrateTableToManualThroughputOptionalParams)
將 Azure Cosmos DB 資料表從自動調整移轉至手動輸送量
function beginMigrateTableToManualThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesMigrateTableToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
傳回
Promise<ThroughputSettingsGetResults>
beginRetrieveContinuousBackupInformation(string, string, string, ContinuousBackupRestoreLocation, TableResourcesRetrieveContinuousBackupInformationOptionalParams)
擷取資料表的持續備份資訊。
function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- location
- ContinuousBackupRestoreLocation
連續備份還原位置的名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>
beginRetrieveContinuousBackupInformationAndWait(string, string, string, ContinuousBackupRestoreLocation, TableResourcesRetrieveContinuousBackupInformationOptionalParams)
擷取資料表的持續備份資訊。
function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, tableName: string, location: ContinuousBackupRestoreLocation, options?: TableResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- location
- ContinuousBackupRestoreLocation
連續備份還原位置的名稱。
傳回
Promise<BackupInformation>
beginUpdateTableThroughput(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
更新 Azure Cosmos DB 資料表每秒 RU
function beginUpdateTableThroughput(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要針對目前資料表每秒 RU 提供的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginUpdateTableThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
更新 Azure Cosmos DB 資料表每秒 RU 數
function beginUpdateTableThroughputAndWait(resourceGroupName: string, accountName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: TableResourcesUpdateTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要針對目前資料表每秒 RU 提供的參數。
選項參數。
傳回
Promise<ThroughputSettingsGetResults>
getTable(string, string, string, TableResourcesGetTableOptionalParams)
取得具有所提供名稱之現有 Azure Cosmos DB 資料庫帳戶下的資料表。
function getTable(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableOptionalParams): Promise<TableGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<TableGetResults>
getTableThroughput(string, string, string, TableResourcesGetTableThroughputOptionalParams)
使用提供的名稱,取得現有 Azure Cosmos DB 資料庫帳戶下資料表每秒 RU 數。
function getTableThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
- tableName
-
string
Cosmos DB 資料表名稱。
選項參數。
傳回
Promise<ThroughputSettingsGetResults>
listTables(string, string, TableResourcesListTablesOptionalParams)
列出現有 Azure Cosmos DB 資料庫帳戶下的資料表。
function listTables(resourceGroupName: string, accountName: string, options?: TableResourcesListTablesOptionalParams): PagedAsyncIterableIterator<TableGetResults, TableGetResults[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- accountName
-
string
Cosmos DB 資料庫帳戶名稱。
選項參數。