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
現在の Table に提供するパラメーター。
options パラメーター。
戻り値
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
現在の Table に提供するパラメーター。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
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
継続的バックアップの復元場所の名前。
options パラメーター。
戻り値
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
継続的バックアップの復元場所の名前。
options パラメーター。
戻り値
Promise<BackupInformation>
beginUpdateTableThroughput(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
Azure Cosmos DB テーブルの 1 秒あたりの 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
現在のテーブルの 1 秒あたりの RU に対して指定するパラメーター。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginUpdateTableThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, TableResourcesUpdateTableThroughputOptionalParams)
Azure Cosmos DB テーブルの 1 秒あたりの 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
現在のテーブルの 1 秒あたりの RU に対して指定するパラメーター。
options パラメーター。
戻り値
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 テーブル名。
options パラメーター。
戻り値
Promise<TableGetResults>
getTableThroughput(string, string, string, TableResourcesGetTableThroughputOptionalParams)
指定された名前の既存の Azure Cosmos DB データベース アカウントの下にあるテーブルの 1 秒あたりの RU を取得します。
function getTableThroughput(resourceGroupName: string, accountName: string, tableName: string, options?: TableResourcesGetTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
Cosmos DB データベース アカウント名。
- tableName
-
string
Cosmos DB テーブル名。
options パラメーター。
戻り値
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 データベース アカウント名。
options パラメーター。