az redisenterprise

Note

このリファレンスは、Azure CLI (バージョン 2.45.0 以降) の redisenterprise 拡張機能の一部です。 拡張機能は、az redisenterprise コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

redisenterprise キャッシュを管理します。

コマンド

名前	説明	型	状態
az redisenterprise create	既存の (ダウンタイムが発生する可能性がある) キャッシュ クラスターを作成します (上書き/再作成)。	拡張	GA
az redisenterprise database	Redis Enterprise データベースを管理します。	拡張	GA
az redisenterprise database create	データベースを作成します。	拡張	GA
az redisenterprise database delete	1 つのデータベースを削除します。	拡張	GA
az redisenterprise database export	ターゲット データベースからデータベース ファイルをエクスポートします。	拡張	GA
az redisenterprise database flush	このデータベース内のすべてのキーと、リンクされたデータベースからすべてのキーをフラッシュします。	拡張	GA
az redisenterprise database force-unlink	指定したデータベース リソースへのリンクを強制的に削除します。	拡張	GA
az redisenterprise database import	データベース ファイルをターゲット データベースにインポートします。	拡張	GA
az redisenterprise database list	指定した RedisEnterprise クラスター内のすべてのデータベースを一覧表示します。	拡張	GA
az redisenterprise database list-keys	RedisEnterprise データベースのアクセス キーを取得します。	拡張	GA
az redisenterprise database regenerate-key	RedisEnterprise データベースのアクセス キーを再生成します。	拡張	GA
az redisenterprise database show	RedisEnterprise クラスター内のデータベースに関する情報を取得します。	拡張	GA
az redisenterprise database update	データベースを更新します。	拡張	GA
az redisenterprise database wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA
az redisenterprise delete	RedisEnterprise キャッシュ クラスターを削除します。	拡張	GA
az redisenterprise list	指定したサブスクリプション内のすべての RedisEnterprise クラスターを一覧表示します。	拡張	GA
az redisenterprise operation-status	操作の状態を取得します。	拡張	GA
az redisenterprise operation-status show	操作の状態を取得します。	拡張	GA
az redisenterprise show	RedisEnterprise クラスターに関する情報を取得します。	拡張	GA
az redisenterprise update	既存の (ダウンタイムが発生する可能性がある) キャッシュ クラスターを更新します (上書き/再作成)。	拡張	GA
az redisenterprise wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az redisenterprise create

既存の (ダウンタイムが発生する可能性がある) キャッシュ クラスターを作成します (上書き/再作成)。

az redisenterprise create --cluster-name
                          --resource-group
                          --sku {EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50}
                          [--assigned-identities]
                          [--capacity]
                          [--client-protocol {Encrypted, Plaintext}]
                          [--clustering-policy {EnterpriseCluster, OSSCluster}]
                          [--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
                          [--group-nickname]
                          [--identity-resource-id]
                          [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                          [--key-encryption-identity-type {systemAssignedIdentity, userAssignedIdentity}]
                          [--key-encryption-key-url]
                          [--linked-databases]
                          [--location]
                          [--minimum-tls-version {1.0, 1.1, 1.2}]
                          [--module]
                          [--no-database]
                          [--no-wait]
                          [--persistence]
                          [--port]
                          [--tags]
                          [--zones]

例

キャッシュの作成

az redisenterprise create --cluster-name "cache1" --location "East US" --minimum-tls-version "1.2" --sku "Enterprise_E20" --capacity 4 --tags tag1="value1" --zones "1" "2" "3" --client-protocol "Encrypted" --clustering-policy "EnterpriseCluster" --eviction-policy "NoEviction" --modules name="RedisBloom" args="ERROR_RATE 0.02 INITIAL_SIZE 400" --persistence aof-enabled=true aof-frequency="1s" --port 10000 --resource-group "rg1"

必須のパラメーター

--cluster-name --name -n

RedisEnterprise クラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sku

デプロイする RedisEnterprise クラスターの種類。 指定できる値: (Enterprise_E10、EnterpriseFlash_F300など)。

指定可能な値: EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50

省略可能のパラメーター

--assigned-identities --user-assigned-identities

リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

--capacity

RedisEnterprise クラスターのサイズ。 SKU に応じて、既定値は 2 または 3 です。 有効な値は、エンタープライズ SKU の場合は (2、4、6、...)、Flash SKU の場合は (3、9、15、...) です。

--client-protocol

redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。 既定値は TLS 暗号化です。

指定可能な値: Encrypted, Plaintext

--clustering-policy

クラスタリング ポリシー - 既定値は OSSCluster です。 作成時に指定されます。

指定可能な値: EnterpriseCluster, OSSCluster

--eviction-policy

Redis 削除ポリシー - 既定値は VolatileLRU です。

指定可能な値: AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL

--group-nickname

リンクされたデータベース リソースのグループの名前。

--identity-resource-id --user-assigned-identity-resource-id

キー暗号化キー URL へのアクセスに使用するユーザー割り当て ID。 例: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。}

--identity-type

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

指定可能な値: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--key-encryption-identity-type --key-identity-type

この API バージョンでは userAssignedIdentity のみがサポートされています。その他の型は、今後サポートされる可能性があります。

指定可能な値: systemAssignedIdentity, userAssignedIdentity

--key-encryption-key-url

キー暗号化キーの URL。バージョン管理のみ。例: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

--linked-databases

このデータベースにリンクするデータベース リソースの一覧。

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--minimum-tls-version

サポートするクラスターの最小 TLS バージョン (例: '1.2')。

指定可能な値: 1.0, 1.1, 1.2

--module --modules

このデータベースで有効にする redis モジュールのオプション セット - モジュールは作成時にのみ追加できます。

--no-database

[詳細設定]。 既定のデータベースは自動的に作成しないでください。 警告: データベースを作成するまでキャッシュは使用できません。

規定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--persistence

永続化の設定。

--port

データベース エンドポイントの TCP ポート。 作成時に指定されます。 既定値は使用可能なポートです。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--zones -z

このクラスターがデプロイされる可用性ゾーン。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az redisenterprise delete

RedisEnterprise キャッシュ クラスターを削除します。

az redisenterprise delete [--cluster-name]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

省略可能のパラメーター

--cluster-name --name -n

RedisEnterprise クラスターの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az redisenterprise list

指定したサブスクリプション内のすべての RedisEnterprise クラスターを一覧表示します。

az redisenterprise list [--resource-group]

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az redisenterprise show

RedisEnterprise クラスターに関する情報を取得します。

az redisenterprise show [--cluster-name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

省略可能のパラメーター

--cluster-name --name -n

RedisEnterprise クラスターの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az redisenterprise update

既存の (ダウンタイムが発生する可能性がある) キャッシュ クラスターを更新します (上書き/再作成)。

az redisenterprise update [--add]
                          [--assigned-identities]
                          [--capacity]
                          [--cluster-name]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--identity-resource-id]
                          [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                          [--ids]
                          [--key-encryption-identity-type {systemAssignedIdentity, userAssignedIdentity}]
                          [--key-encryption-key-url]
                          [--minimum-tls-version {1.0, 1.1, 1.2}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--sku {EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50}]
                          [--subscription]
                          [--tags]
                          [--zones]

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--assigned-identities --user-assigned-identities

リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--capacity

RedisEnterprise クラスターのサイズ。 SKU に応じて、既定値は 2 または 3 です。 有効な値は、エンタープライズ SKU の場合は (2、4、6、...)、Flash SKU の場合は (3、9、15、...) です。

--cluster-name --name -n

RedisEnterprise クラスターの名前。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--identity-resource-id --user-assigned-identity-resource-id

キー暗号化キー URL へのアクセスに使用するユーザー割り当て ID。 例: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。}

--identity-type

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

指定可能な値: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--key-encryption-identity-type --key-identity-type

この API バージョンでは userAssignedIdentity のみがサポートされています。その他の型は、今後サポートされる可能性があります。

指定可能な値: systemAssignedIdentity, userAssignedIdentity

--key-encryption-key-url

キー暗号化キーの URL。バージョン管理のみ。 例: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78。

--minimum-tls-version

サポートするクラスターの最小 TLS バージョン (例: '1.2')。

指定可能な値: 1.0, 1.1, 1.2

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--sku

デプロイする RedisEnterprise クラスターの種類。 指定できる値: (Enterprise_E10、EnterpriseFlash_F300など)。

指定可能な値: EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--zones

このクラスターがデプロイされる可用性ゾーン。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az redisenterprise wait

条件が満たされるまで CLI を待機状態にします。

az redisenterprise wait [--cluster-name]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

省略可能のパラメーター

--cluster-name --name -n

RedisEnterprise クラスターの名前。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。