Databases interface
データベースを表すインターフェイス。
メソッド
メソッドの詳細
beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)
データベースを作成します。
function beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- Database
データベースの作成または更新操作に指定されたパラメーター。
- options
- DatabasesCreateOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)
データベースを作成します。
function beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- Database
データベースの作成または更新操作に指定されたパラメーター。
- options
- DatabasesCreateOptionalParams
options パラメーター。
戻り値
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
1 つのデータベースを削除します
function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- options
- DatabasesDeleteOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
1 つのデータベースを削除します
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- options
- DatabasesDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
ターゲット データベースからデータベース ファイルをエクスポートします。
function beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ExportClusterParameters
クラスターにエクスポートするためのストレージ情報
- options
- DatabasesExportOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
ターゲット データベースからデータベース ファイルをエクスポートします。
function beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ExportClusterParameters
クラスターにエクスポートするためのストレージ情報
- options
- DatabasesExportOptionalParams
options パラメーター。
戻り値
Promise<void>
beginFlush(string, string, string, FlushParameters, DatabasesFlushOptionalParams)
このデータベース内のすべてのキーと、リンクされたデータベースからもフラッシュします。
function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, parameters: FlushParameters, options?: DatabasesFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- FlushParameters
フラッシュするデータベースを識別する情報
- options
- DatabasesFlushOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, string, FlushParameters, DatabasesFlushOptionalParams)
このデータベース内のすべてのキーと、リンクされたデータベースからもフラッシュします。
function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: FlushParameters, options?: DatabasesFlushOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- FlushParameters
フラッシュするデータベースを識別する情報
- options
- DatabasesFlushOptionalParams
options パラメーター。
戻り値
Promise<void>
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
指定したデータベース リソースへのリンクを強制的に削除します。
function beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ForceUnlinkParameters
リンク解除するデータベースを識別する情報。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
指定したデータベース リソースへのリンクを強制的に削除します。
function beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ForceUnlinkParameters
リンク解除するデータベースを識別する情報。
options パラメーター。
戻り値
Promise<void>
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
データベース ファイルをターゲット データベースにインポートします。
function beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ImportClusterParameters
クラスターにインポートするためのストレージ情報
- options
- DatabasesImportOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
データベース ファイルをターゲット データベースにインポートします。
function beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- ImportClusterParameters
クラスターにインポートするためのストレージ情報
- options
- DatabasesImportOptionalParams
options パラメーター。
戻り値
Promise<void>
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
RedisEnterprise データベースのアクセス キーを再生成します。
function beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- RegenerateKeyParameters
再生成するキーを指定します。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
RedisEnterprise データベースのアクセス キーを再生成します。
function beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- RegenerateKeyParameters
再生成するキーを指定します。
options パラメーター。
戻り値
Promise<AccessKeys>
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
データベースを更新します。
function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- DatabaseUpdate
データベースの作成または更新操作に指定されたパラメーター。
- options
- DatabasesUpdateOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
データベースを更新します。
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- parameters
- DatabaseUpdate
データベースの作成または更新操作に指定されたパラメーター。
- options
- DatabasesUpdateOptionalParams
options パラメーター。
戻り値
Promise<Database>
get(string, string, string, DatabasesGetOptionalParams)
RedisEnterprise クラスター内のデータベースに関する情報を取得します。
function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- options
- DatabasesGetOptionalParams
options パラメーター。
戻り値
Promise<Database>
listByCluster(string, string, DatabasesListByClusterOptionalParams)
指定した RedisEnterprise クラスター内のすべてのデータベースを取得します。
function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
options パラメーター。
戻り値
listKeys(string, string, string, DatabasesListKeysOptionalParams)
RedisEnterprise データベースのアクセス キーを取得します。
function listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
RedisEnterprise クラスターの名前。
- databaseName
-
string
データベースの名前。
- options
- DatabasesListKeysOptionalParams
options パラメーター。
戻り値
Promise<AccessKeys>