Redis interface
Redis を表すインターフェイス。
メソッド
メソッドの詳細
beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)
既存の Redis キャッシュを作成または置換 (上書き/再作成、ダウンタイムの可能性あり) します。
function beginCreate(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisCreateParameters
Redis の作成操作に指定されたパラメーター。
- options
- RedisCreateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)
既存の Redis キャッシュを作成または置換 (上書き/再作成、ダウンタイムの可能性あり) します。
function beginCreateAndWait(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<RedisResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisCreateParameters
Redis の作成操作に指定されたパラメーター。
- options
- RedisCreateOptionalParams
オプション パラメーター。
戻り値
Promise<RedisResource>
beginDelete(string, string, RedisDeleteOptionalParams)
Redis キャッシュを削除します。
function beginDelete(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- options
- RedisDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)
Redis キャッシュを削除します。
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- options
- RedisDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Redis Cache からコンテナー内の BLOB にデータをエクスポートします。
function beginExportData(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- ExportRDBParameters
Redis エクスポート操作のパラメーター。
- options
- RedisExportDataOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Redis Cache からコンテナー内の BLOB にデータをエクスポートします。
function beginExportDataAndWait(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- ExportRDBParameters
Redis エクスポート操作のパラメーター。
- options
- RedisExportDataOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginFlushCache(string, string, RedisFlushCacheOptionalParams)
キャッシュ内のすべてのキーを削除します。
function beginFlushCache(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- cacheName
-
string
Redis キャッシュの名前。
- options
- RedisFlushCacheOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)
キャッシュ内のすべてのキーを削除します。
function beginFlushCacheAndWait(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<RedisFlushCacheResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- cacheName
-
string
Redis キャッシュの名前。
- options
- RedisFlushCacheOptionalParams
オプション パラメーター。
戻り値
Promise<RedisFlushCacheResponse>
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Redis Cache にデータをインポートします。
function beginImportData(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- ImportRDBParameters
Redis インポート操作のパラメーター。
- options
- RedisImportDataOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Redis Cache にデータをインポートします。
function beginImportDataAndWait(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- ImportRDBParameters
Redis インポート操作のパラメーター。
- options
- RedisImportDataOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
既存の Redis キャッシュを更新します。
function beginUpdate(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisUpdateParameters
Update Redis 操作に指定されたパラメーター。
- options
- RedisUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
既存の Redis キャッシュを更新します。
function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<RedisResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisUpdateParameters
Update Redis 操作に指定されたパラメーター。
- options
- RedisUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<RedisResource>
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)
Redis Cache 名が有効であり、まだ使用されていないことを確認します。
function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>パラメーター
- parameters
- CheckNameAvailabilityParameters
CheckNameAvailability Redis 操作に指定されたパラメーター。 サポートされているリソースの種類は 'Microsoft.Cache/redis' のみです。
オプション パラメーター。
戻り値
Promise<void>
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)
指定した Redis ノードを再起動します。 この操作には、キャッシュ リソースへの書き込みアクセス許可が必要です。 データが失われる可能性があります。
function forceReboot(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams): Promise<RedisForceRebootResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisRebootParameters
再起動する Redis ノードを指定します。
- options
- RedisForceRebootOptionalParams
オプション パラメーター。
戻り値
Promise<RedisForceRebootResponse>
get(string, string, RedisGetOptionalParams)
Redis Cache (リソースの説明) を取得します。
function get(resourceGroupName: string, name: string, options?: RedisGetOptionalParams): Promise<RedisResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- options
- RedisGetOptionalParams
オプション パラメーター。
戻り値
Promise<RedisResource>
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)
リソース グループ内のすべての Redis キャッシュを一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
listBySubscription(RedisListBySubscriptionOptionalParams)
指定したサブスクリプション内のすべての Redis キャッシュを取得します。
function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>パラメーター
オプション パラメーター。
戻り値
listKeys(string, string, RedisListKeysOptionalParams)
Redis Cache のアクセス キーを取得します。 この操作には、キャッシュ リソースへの書き込みアクセス許可が必要です。
function listKeys(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams): Promise<RedisAccessKeys>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- options
- RedisListKeysOptionalParams
オプション パラメーター。
戻り値
Promise<RedisAccessKeys>
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)
Redis Cache のアップグレード通知を取得します。
function listUpgradeNotifications(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams): PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- history
-
number
アップグレード通知を検索する時間 (分)
オプション パラメーター。
戻り値
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)
Redis Cache のアクセス キーを再生成します。 この操作には、キャッシュ リソースへの書き込みアクセス許可が必要です。
function regenerateKey(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams): Promise<RedisAccessKeys>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- name
-
string
Redis キャッシュの名前。
- parameters
- RedisRegenerateKeyParameters
再生成するキーを指定します。
- options
- RedisRegenerateKeyOptionalParams
オプション パラメーター。
戻り値
Promise<RedisAccessKeys>