Azure コマンド ライン インターフェイス (Azure CLI) を使用して Azure Redis Cache を作成および管理する方法How to create and manage Azure Redis Cache using the Azure Command-Line Interface (Azure CLI)

Azure CLI は、任意のプラットフォームから Azure インフラストラクチャを管理する優れた方法です。The Azure CLI is a great way to manage your Azure infrastructure from any platform. この記事では、Azure CLI を使用して Azure Redis Cache インスタンスを作成および管理する方法について説明します。This article shows you how to create and manage your Azure Redis Cache instances using the Azure CLI.

注意

この記事は、Azure CLI の以前のバージョンに適用されます。This article applies to a previous version of Azure CLI. 最新の Azure CLI 2.0 サンプル スクリプトについては、Azure CLI Redis キャッシュ サンプルに関するページを参照してください。For the latest Azure CLI 2.0 sample scripts, see Azure CLI Redis cache samples.

前提条件Prerequisites

Azure CLI を使用して Azure Redis Cache インスタンスを作成および管理するには、次の手順を実行する必要があります。To create and manage Azure Redis Cache instances using Azure CLI, you must complete the following steps.

Redis Cache のプロパティRedis Cache properties

Redis Cache インスタンスを作成および更新する場合には、次のプロパティを使用します。The following properties are used when creating and updating Redis Cache instances.

プロパティProperty SwitchSwitch DescriptionDescription
namename -n, --name-n, --name Redis Cache の名前です。Name of the Redis Cache.
resource groupresource group -g, --resource-group-g, --resource-group リソース グループの名前です。Name of the Resource Group.
locationlocation -l, --location-l, --location キャッシュを作成する場所です。Location to create cache.
sizesize -z, --size-z, --size Redis Cache のサイズです。Size of the Redis Cache. 有効な値: [C0、C1、C2、C3、C4、C5、C6、P1、P2、P3、P4]Valid values: [C0, C1, C2, C3, C4, C5, C6, P1, P2, P3, P4]
skusku -x, --sku-x, --sku Redis SKU です。Redis SKU. 値は次のいずれかです: [Basic、Standard、Premium]Should be one of : [Basic, Standard, Premium]
EnableNonSslPortEnableNonSslPort -e、--enable-non-ssl-port-e, --enable-non-ssl-port Redis Cache の EnableNonSslPort プロパティです。EnableNonSslPort property of the Redis Cache. キャッシュの非 SSL ポートを有効にする場合は、このフラグを追加します。Add this flag if you want to enable the Non SSL Port for your cache
Redis 構成Redis Configuration -c、--redis-configuration-c, --redis-configuration Redis 構成。Redis Configuration. 構成のキーと値の JSON 形式の文字列をここに入力します。Enter a JSON formatted string of configuration keys and values here. 形式: "{"":"","":""}"Format:"{"":"","":""}"
Redis 構成Redis Configuration -f、--redis-configuration-file-f, --redis-configuration-file Redis 構成。Redis Configuration. 構成キーおよび値を含むファイルのパスをここに入力します。Enter the path of a file containing configuration keys and values here. ファイル エントリの形式: {"":"","":""}Format for the file entry: {"":"","":""}
シャード数Shard Count -r、--shard-count-r, --shard-count クラスタリングにより Premium クラスター キャッシュに作成するシャードの数。Number of Shards to create on a Premium Cluster Cache with clustering.
仮想ネットワークVirtual Network -v、--virtual-network-v, --virtual-network VNET でキャッシュをホストする場合に、Redis Cache をデプロイする仮想ネットワークの正確な ARM リソース ID を指定します。When hosting your cache in a VNET, specifies the exact ARM resource ID of the virtual network to deploy the redis cache in. 形式の例: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
key typekey type -t、--key-type-t, --key-type 更新するキーの種類です。Type of key to renew. 有効な値: [Primary、Secondary]Valid values: [Primary, Secondary]
StaticIPStaticIP -p, --static-ip -p, --static-ip VNET でキャッシュをホストする場合に、キャッシュのサブネットで一意の IP アドレスを指定します。When hosting your cache in a VNET, specifies a unique IP address in the subnet for the cache. 指定していない場合、サブネットから自動的にアドレスが 1 つ選択されます。If not provided, one is chosen for you from the subnet.
サブネットSubnet t、--subnet t, --subnet VNET でキャッシュをホストする場合に、キャッシュをデプロイするサブネットの名前を指定します。When hosting your cache in a VNET, specifies the name of the subnet in which to deploy the cache.
VirtualNetworkVirtualNetwork -v, --virtual-network -v, --virtual-network VNET でキャッシュをホストする場合に、Redis Cache をデプロイする仮想ネットワークの正確な ARM リソース ID を指定します。When hosting your cache in a VNET, specifies the exact ARM resource ID of the virtual network to deploy the redis cache in. 形式の例: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
サブスクリプションSubscription -s、--subscription-s, --subscription サブスクリプションの識別子です。The subscription identifier.

すべての Redis Cache コマンドを参照してください。See all Redis Cache commands

すべての Redis Cache コマンドとそのパラメーターを表示するには、 azure rediscache -h コマンドを使用します。To see all Redis Cache commands and their parameters, use the azure rediscache -h command.

C:\>azure rediscache -h
help:    Commands to manage your Azure Redis Cache(s)
help:
help:    Create a Redis Cache
help:      rediscache create [--name <name> --resource-group <resource-group> --location <location> [options]]
help:
help:    Delete an existing Redis Cache
help:      rediscache delete [--name <name> --resource-group <resource-group> ]
help:
help:    List all Redis Caches within your Subscription or Resource Group
help:      rediscache list [options]
help:
help:    Show properties of an existing Redis Cache
help:      rediscache show [--name <name> --resource-group <resource-group>]
help:
help:    Change settings of an existing Redis Cache
help:      rediscache set [--name <name> --resource-group <resource-group> --redis-configuration <redis-configuration>/--redis-configuration-file <redisConfigurationFile>]
help:
help:    Renew the authentication key for an existing Redis Cache
help:      rediscache renew-key [--name <name> --resource-group <resource-group> ]
help:
help:    Lists Primary and Secondary key of an existing Redis Cache
help:      rediscache list-keys [--name <name> --resource-group <resource-group>]
help:
help:    Options:
help:      -h, --help  output usage information
help:
help:    Current Mode: arm (Azure Resource Management)

Redis Cache の作成Create a Redis Cache

Redis Cache を作成するには、次のコマンドを使用します。To create a Redis Cache, use the following command:

azure rediscache create [--name <name> --resource-group <resource-group> --location <location> [options]]

このコマンドの詳細を確認するには、 azure rediscache create -h コマンドを実行します。For more information about this command, run the azure rediscache create -h command.

C:\>azure rediscache create -h
help:    Create a Redis Cache
help:
help:    Usage: rediscache create [--name <name> --resource-group <resource-group> --location <location> [options]]
help:
help:    Options:
help:      -h, --help                                               output usage information
help:      -v, --verbose                                            use verbose output
help:      -vv                                                      more verbose with debug output
help:      --json                                                   use json output
help:      -n, --name <name>                                        Name of the Redis Cache.
help:      -g, --resource-group <resource-group>                    Name of the Resource Group
help:      -l, --location <location>                                Location to create cache.
help:      -z, --size <size>                                        Size of the Redis Cache. Valid values: [C0, C1, C2, C3, C4, C5, C6, P1, P2, P3, P4]
help:      -x, --sku <sku>                                          Redis SKU. Should be one of : [Basic, Standard, Premium]
help:      -e, --enable-non-ssl-port                                EnableNonSslPort property of the Redis Cache. Add this flag if you want to enable the Non SSL Port for your cache
help:      -c, --redis-configuration <redis-configuration>          Redis Configuration. Enter a JSON formatted string of configuration keys and values here. Format:"{"<key1>":"<value1>","<key2>":"<value2>"}"
help:      -f, --redis-configuration-file <redisConfigurationFile>  Redis Configuration. Enter the path of a file containing configuration keys and values here. Format for the file entry: {"<key1>":"<value1>","<key2>":"<value2>"}
help:      -r, --shard-count <shard-count>                          Number of Shards to create on a Premium Cluster Cache
help:      -v, --virtual-network <virtual-network>                  The exact ARM resource ID of the virtual network to deploy the redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
help:      -t, --subnet <subnet>                                    Required when deploying a redis cache inside an existing Azure Virtual Network
help:      -p, --static-ip <static-ip>                              Required when deploying a redis cache inside an existing Azure Virtual Network
help:      -s, --subscription <id>                                  the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

既存の Redis Cache を削除するDelete an existing Redis Cache

Redis Cache を削除するには、次のコマンドを使用します。To delete a Redis Cache, use the following command:

azure rediscache delete [--name <name> --resource-group <resource-group> ]

このコマンドの詳細を確認するには、 azure rediscache delete -h コマンドを実行します。For more information about this command, run the azure rediscache delete -h command.

C:\>azure rediscache delete -h
help:    Delete an existing Redis Cache
help:
help:    Usage: rediscache delete [--name <name> --resource-group <resource-group> ]
help:
help:    Options:
help:      -h, --help                             output usage information
help:      -v, --verbose                          use verbose output
help:      -vv                                    more verbose with debug output
help:      --json                                 use json output
help:      -n, --name <name>                      Name of the Redis Cache.
help:      -g, --resource-group <resource-group>  Name of the Resource Group under which the cache exists
help:      -s, --subscription <subscription>      the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

サブスクリプションまたはリソース グループ内のすべての Redis Cache を一覧表示するList all Redis Caches within your Subscription or Resource Group

サブスクリプションまたはリソース グループ内のすべての Redis Cache を一覧表示するには、次のコマンドを使用します。To list all Redis Caches within your Subscription or Resource Group, use the following command:

azure rediscache list [options]

このコマンドの詳細を確認するには、 azure rediscache list -h コマンドを実行します。For more information about this command, run the azure rediscache list -h command.

C:\>azure rediscache list -h
help:    List all Redis Caches within your Subscription or Resource Group
help:
help:    Usage: rediscache list [options]
help:
help:    Options:
help:      -h, --help                             output usage information
help:      -v, --verbose                          use verbose output
help:      -vv                                    more verbose with debug output
help:      --json                                 use json output
help:      -g, --resource-group <resource-group>  Name of the Resource Group
help:      -s, --subscription <subscription>      the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

既存の Redis Cache のプロパティを表示するShow properties of an existing Redis Cache

既存の Redis Cache のプロパティを表示するには、次のコマンドを使用します。To show properties of an existing Redis Cache, use the following command:

azure rediscache show [--name <name> --resource-group <resource-group>]

このコマンドの詳細を確認するには、 azure rediscache show -h コマンドを実行します。For more information about this command, run the azure rediscache show -h command.

C:\>azure rediscache show -h
help:    Show properties of an existing Redis Cache
help:
help:    Usage: rediscache show [--name <name> --resource-group <resource-group>]
help:
help:    Options:
help:      -h, --help                             output usage information
help:      -v, --verbose                          use verbose output
help:      -vv                                    more verbose with debug output
help:      --json                                 use json output
help:      -n, --name <name>                      Name of the Redis Cache.
help:      -g, --resource-group <resource-group>  Name of the Resource Group
help:      -s, --subscription <subscription>      the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

既存の Redis Cache の設定を変更するChange settings of an existing Redis Cache

既存の Redis Cache の設定を変更するには、次のコマンドを使用します。To change settings of an existing Redis Cache, use the following command:

azure rediscache set [--name <name> --resource-group <resource-group> --redis-configuration <redis-configuration>/--redis-configuration-file <redisConfigurationFile>]

このコマンドの詳細を確認するには、 azure rediscache set -h コマンドを実行します。For more information about this command, run the azure rediscache set -h command.

C:\>azure rediscache set -h
help:    Change settings of an existing Redis Cache
help:
help:    Usage: rediscache set [--name <name> --resource-group <resource-group> --redis-configuration <redis-configuration>/--redis-configuration-file <redisConfigurationFile>]
help:
help:    Options:
help:      -h, --help                                               output usage information
help:      -v, --verbose                                            use verbose output
help:      -vv                                                      more verbose with debug output
help:      --json                                                   use json output
help:      -n, --name <name>                                        Name of the Redis Cache.
help:      -g, --resource-group <resource-group>                    Name of the Resource Group
help:      -c, --redis-configuration <redis-configuration>          Redis Configuration. Enter a JSON formatted string of configuration keys and values here.
help:      -f, --redis-configuration-file <redisConfigurationFile>  Redis Configuration. Enter the path of a file containing configuration keys and values here.
help:      -s, --subscription <subscription>                        the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

既存の Redis Cache の認証キーを更新するRenew the authentication key for an existing Redis Cache

既存の Redis Cache の認証キーを更新するには、次のコマンドを使用します。To renew the authentication key for an existing Redis Cache, use the following command:

azure rediscache renew-key [--name <name> --resource-group <resource-group> --key-type <key-type>]

key-type に対して、Primary または Secondary を指定します。Specify Primary or Secondary for key-type.

このコマンドの詳細を確認するには、azure rediscache renew-key -h コマンドを実行します。For more information about this command, run the azure rediscache renew-key -h command.

C:\>azure rediscache renew-key -h
help:    Renew the authentication key for an existing Redis Cache
help:
help:    Usage: rediscache renew-key [--name <name> --resource-group <resource-group> ]
help:
help:    Options:
help:      -h, --help                             output usage information
help:      -v, --verbose                          use verbose output
help:      -vv                                    more verbose with debug output
help:      --json                                 use json output
help:      -n, --name <name>                      Name of the Redis Cache.
help:      -g, --resource-group <resource-group>  Name of the Resource Group under which cache exists
help:      -t, --key-type <key-type>              type of key to renew. Valid values are: 'Primary', 'Secondary'.
help:      -s, --subscription <subscription>      the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)

既存の Redis Cache のプライマリ キーとセカンダリ キーを一覧表示するList Primary and Secondary keys of an existing Redis Cache

既存の Redis Cache のプライマリ キーとセカンダリ キーを一覧表示するには、次のコマンドを使用します。To list Primary and Secondary keys of an existing Redis Cache, use the following command:

azure rediscache list-keys [--name <name> --resource-group <resource-group>]

このコマンドの詳細を確認するには、 azure rediscache list-keys -h コマンドを実行します。For more information about this command, run the azure rediscache list-keys -h command.

C:\>azure rediscache list-keys -h
help:    Lists Primary and Secondary key of an existing Redis Cache
help:
help:    Usage: rediscache list-keys [--name <name> --resource-group <resource-group>]
help:
help:    Options:
help:      -h, --help                             output usage information
help:      -v, --verbose                          use verbose output
help:      -vv                                    more verbose with debug output
help:      --json                                 use json output
help:      -n, --name <name>                      Name of the Redis Cache.
help:      -g, --resource-group <resource-group>  Name of the Resource Group under which Cache exists
help:      -s, --subscription <subscription>      the subscription identifier
help:
help:    Current Mode: arm (Azure Resource Management)