Azure PowerShell を使用した Azure Redis Cache の管理Manage Azure Redis Cache with Azure PowerShell

このトピックでは、Azure Redis Cache インスタンスの作成、更新、スケールなどの一般的なタスクを実行する方法、アクセス キーを再生成する方法、キャッシュに関する情報を表示する方法について説明します。This topic shows you how to perform common tasks such as create, update, and scale your Azure Redis Cache instances, how to regenerate access keys, and how to view information about your caches. Azure Redis Cache 用の PowerShell コマンドレットの詳細な一覧については、 Azure Redis Cache コマンドレットに関するページをご覧ください。For a complete list of Azure Redis Cache PowerShell cmdlets, see Azure Redis Cache cmdlets.

注意

Azure には、リソースの作成と操作に関して、Resource Manager とクラシックの 2 種類のデプロイメント モデルがあります。Azure has two different deployment models for creating and working with resources: Resource Manager and classic. この記事では、Resource Manager デプロイメント モデルの使用方法について説明しています。最新のデプロイでは、クラシック デプロイメント モデルではなくこのモデルをお勧めします。This article covers using the Resource Manager deployment model, which Microsoft recommends for new deployments instead of the classic deployment model.

クラシック デプロイメント モデルについて詳しくは、「Azure Resource Manager とクラシック デプロイ: デプロイ モデルとリソースの状態について」を参照してください。For more information about the classic deployment model, see Azure Resource Manager vs. classic deployment: Understand deployment models and the state of your resources.

前提条件Prerequisites

Azure PowerShell をインストール済みである場合、Azure PowerShell Version 1.0.0 以降であることが必要です。If you have already installed Azure PowerShell, you must have Azure PowerShell version 1.0.0 or later. インストールした Azure PowerShell のバージョンは、Azure PowerShell コマンド プロンプトで次のコマンドを使用して確認できます。You can check the version of Azure PowerShell that you have installed with this command at the Azure PowerShell command prompt.

Get-Module azure | format-table version

まず、次のコマンドで Azure にログインする必要があります。First, you must log in to Azure with this command.

Login-AzureRmAccount

Microsoft Azure のサインイン ダイアログで、Azure アカウントの電子メール アドレスとそのパスワードを指定します。Specify the email address of your Azure account and its password in the Microsoft Azure sign-in dialog.

次に、Azure サブスクリプションが複数ある場合は、使用する Azure サブスクリプションを設定する必要があります。Next, if you have multiple Azure subscriptions, you need to set your Azure subscription. 現在のサブスクリプションを一覧表示するには、次のコマンドを実行します。To see a list of your current subscriptions, run this command.

Get-AzureRmSubscription | sort SubscriptionName | Select SubscriptionName

サブスクリプションを指定するには、次のコマンドを実行します。To specify the subscription, run the following command. 次の例では、サブスクリプション名は ContosoSubscriptionです。In the following example, the subscription name is ContosoSubscription.

Select-AzureRmSubscription -SubscriptionName ContosoSubscription

Azure リソース マネージャーで Windows PowerShell を使用するには、以下が必要です。Before you can use Windows PowerShell with Azure Resource Manager, you need the following:

このチュートリアルに表示されているコマンドレットの詳しいヘルプを確認には、Get-Help コマンドレットを使用します。To get detailed help for any cmdlet you see in this tutorial, use the Get-Help cmdlet.

Get-Help <cmdlet-name> -Detailed

たとえば、 New-AzureRmRedisCache コマンドレットについてのヘルプを確認するには、次のように入力します。For example, to get help for the New-AzureRmRedisCache cmdlet, type:

Get-Help New-AzureRmRedisCache -Detailed

他のクラウドに接続する方法How to connect to other clouds

既定では、Azure 環境はグローバル Azure クラウド インスタンスを表す AzureCloudです。By default the Azure environment is AzureCloud, which represents the global Azure cloud instance. 別のインスタンスに接続するには、Add-AzureRmAccount コマンドと -Environment または -EnvironmentName コマンド ライン スイッチを使用し、任意の環境または環境名を指定します。To connect to a different instance, use the Add-AzureRmAccount command with the -Environment or -EnvironmentName command line switch with the desired environment or environment name.

利用可能な環境の一覧を表示するには、 Get-AzureRmEnvironment コマンドレットを実行します。To see the list of available environments, run the Get-AzureRmEnvironment cmdlet.

Azure Government Cloud に接続するにはTo connect to the Azure Government Cloud

Azure Government Cloud に接続するには、次のいずれかのコマンドを使用します。To connect to the Azure Government Cloud, use one of the following commands.

Add-AzureRMAccount -EnvironmentName AzureUSGovernment

またはor

Add-AzureRmAccount -Environment (Get-AzureRmEnvironment -Name AzureUSGovernment)

Azure Government Cloud でキャッシュを作成するには、次のいずれかの場所を使用します。To create a cache in the Azure Government Cloud, use one of the following locations.

  • 米国政府バージニア州USGov Virginia
  • 米国政府アイオワ州USGov Iowa

Azure Government Cloud の詳細については、「Microsoft Azure Government」と「Microsoft Azure Government 開発者向けガイド」をご覧ください。For more information about the Azure Government Cloud, see Microsoft Azure Government and Microsoft Azure Government Developer Guide.

Azure China Cloud に接続するにはTo connect to the Azure China Cloud

Azure China Cloud に接続するには、次のいずれかのコマンドを使用します。To connect to the Azure China Cloud, use one of the following commands.

Add-AzureRMAccount -EnvironmentName AzureChinaCloud

またはor

Add-AzureRmAccount -Environment (Get-AzureRmEnvironment -Name AzureChinaCloud)

Azure China Cloud でキャッシュを作成するには、次のいずれかの場所を使用します。To create a cache in the Azure China Cloud, use one of the following locations.

  • 中国 (東部)China East
  • 中国 (北部)China North

Azure China Cloud の詳細については、 中国の 21Vianet が運営している AzureChinaCloud for Azureに関するページをご覧ください。For more information about the Azure China Cloud, see AzureChinaCloud for Azure operated by 21Vianet in China.

Microsoft Azure Germany に接続するにはTo connect to Microsoft Azure Germany

Microsoft Azure Germany に接続するには、次のいずれかのコマンドを使用します。To connect to Microsoft Azure Germany, use one of the following commands.

Add-AzureRMAccount -EnvironmentName AzureGermanCloud

またはor

Add-AzureRmAccount -Environment (Get-AzureRmEnvironment -Name AzureGermanCloud)

Microsoft Azure Germany でキャッシュを作成するには、次のいずれかの場所を使用します。To create a cache in Microsoft Azure Germany, use one of the following locations.

  • ドイツ中部Germany Central
  • ドイツ北東部Germany Northeast

Microsoft Azure Germany の詳細については、「Microsoft Azure Germany」を参照してください。For more information about Microsoft Azure Germany, see Microsoft Azure Germany.

Azure Redis Cache 用の PowerShell で使用されるプロパティProperties used for Azure Redis Cache PowerShell

次の表は、Azure PowerShell を使用して Azure Redis Cache インスタンスを作成し、管理するときに一般的に使用されるパラメーターのプロパティと説明を示しています。The following table contains properties and descriptions for commonly used parameters when creating and managing your Azure Redis Cache instances using Azure PowerShell.

パラメーターParameter DescriptionDescription 既定値Default
NameName キャッシュの名前Name of the cache
場所Location キャッシュの場所Location of the cache
ResourceGroupNameResourceGroupName キャッシュを作成するリソース グループの名前Resource group name in which to create the cache
サイズSize キャッシュのサイズ。The size of the cache. 有効な値: P1、P2、P3、P4、C0、C1、C2、C3、C4、C5、C6、250 MB、1 GB、2.5 GB、6 GB、13 GB、26 GB、53 GBValid values are: P1, P2, P3, P4, C0, C1, C2, C3, C4, C5, C6, 250MB, 1GB, 2.5GB, 6GB, 13GB, 26GB, 53GB 1GB1GB
ShardCountShardCount クラスタリングが有効になっている Premium キャッシュを作成するときに作成するシャードの数。The number of shards to create when creating a premium cache with clustering enabled. 有効な値: 1、2、3、4、5、6、7、8、9、10Valid values are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
SKUSKU キャッシュの SKU を指定します。Specifies the SKU of the cache. 有効な値: Basic、Standard、PremiumValid values are: Basic, Standard, Premium 標準Standard
RedisConfigurationRedisConfiguration Redis 構成の設定を指定します。Specifies Redis configuration settings. 各設定の詳細については、次の「 RedisConfiguration プロパティ 」の表をご覧ください。For details on each setting, see the following RedisConfiguration properties table.
EnableNonSslPortEnableNonSslPort 非 SSL ポートが有効になっているかどうかを示します。Indicates whether the non-SSL port is enabled. FalseFalse
MaxMemoryPolicyMaxMemoryPolicy このパラメーターは廃止されました。代わりに、RedisConfiguration を使用します。This parameter has been deprecated - use RedisConfiguration instead.
StaticIPStaticIP 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 VNET でキャッシュをホストする場合に、キャッシュをデプロイするサブネットの名前を指定します。When hosting your cache in a VNET, specifies the name of the subnet in which to deploy the cache.
VirtualNetworkVirtualNetwork VNET でキャッシュをホストする場合に、キャッシュをデプロイする VNET のリソース ID を指定します。When hosting your cache in a VNET, specifies the resource ID of the VNET in which to deploy the cache.
KeyTypeKeyType アクセス キーを更新するときに再生成するアクセス キーを指定します。Specifies which access key to regenerate when renewing access keys. 有効な値: Primary、SecondaryValid values are: Primary, Secondary

RedisConfiguration プロパティRedisConfiguration properties

プロパティProperty DescriptionDescription 価格レベルPricing tiers
rdb-backup-enabledrdb-backup-enabled Redis データ永続化 が有効かどうか。Whether Redis data persistence is enabled Premium のみPremium only
rdb-storage-connection-stringrdb-storage-connection-string Redis データ永続化The connection string to the storage account for Redis data persistence Premium のみPremium only
rdb-backup-frequencyrdb-backup-frequency Redis データ永続化The backup frequency for Redis data persistence Premium のみPremium only
maxmemory-reservedmaxmemory-reserved キャッシュ以外のプロセスに 予約済みのメモリ を構成するConfigures the memory reserved for non-cache processes Standard と PremiumStandard and Premium
maxmemory-policymaxmemory-policy キャッシュに 削除ポリシー を構成するConfigures the eviction policy for the cache すべての価格レベルAll pricing tiers
notify-keyspace-eventsnotify-keyspace-events キースペース通知Configures keyspace notifications Standard と PremiumStandard and Premium
hash-max-ziplist-entrieshash-max-ziplist-entries 小規模の集計データの種類に メモリ最適化 を構成するConfigures memory optimization for small aggregate data types Standard と PremiumStandard and Premium
hash-max-ziplist-valuehash-max-ziplist-value 小規模の集計データの種類に メモリ最適化 を構成するConfigures memory optimization for small aggregate data types Standard と PremiumStandard and Premium
set-max-intset-entriesset-max-intset-entries 小規模の集計データの種類に メモリ最適化 を構成するConfigures memory optimization for small aggregate data types Standard と PremiumStandard and Premium
zset-max-ziplist-entrieszset-max-ziplist-entries 小規模の集計データの種類に メモリ最適化 を構成するConfigures memory optimization for small aggregate data types Standard と PremiumStandard and Premium
zset-max-ziplist-valuezset-max-ziplist-value 小規模の集計データの種類に メモリ最適化 を構成するConfigures memory optimization for small aggregate data types Standard と PremiumStandard and Premium
データベースdatabases データベースの数を構成する。Configures the number of databases. このプロパティは、キャッシュの作成時にのみ構成できます。This property can be configured only at cache creation. Standard と PremiumStandard and Premium

Redis Cache の作成方法To create a Redis Cache

Azure Redis Cache インスタンスを新規作成するには、 New-AzureRmRedisCache コマンドレットを使用します。New Azure Redis Cache instances are created using the New-AzureRmRedisCache cmdlet.

重要

Azure ポータルを使用してサブスクリプションに初めて Redis Cache を作成すると、そのサブスクリプションの Microsoft.Cache 名前空間がポータルによって登録されます。The first time you create a Redis cache in a subscription using the Azure portal, the portal registers the Microsoft.Cache namespace for that subscription. PowerShell を使用してサブスクリプションに最初の Redis Cache を作成する場合は、先に次のコマンドを使用して名前空間を登録する必要があります。これを実行しないと、New-AzureRmRedisCacheGet-AzureRmRedisCache などのコマンドレットが失敗します。If you attempt to create the first Redis cache in a subscription using PowerShell, you must first register that namespace using the following command; otherwise cmdlets such as New-AzureRmRedisCache and Get-AzureRmRedisCache fail.

Register-AzureRmResourceProvider -ProviderNamespace "Microsoft.Cache"

New-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for New-AzureRmRedisCache, run the following command.

PS C:\> Get-Help New-AzureRmRedisCache -detailed

NAME
    New-AzureRmRedisCache

SYNOPSIS
    Creates a new redis cache.


SYNTAX
    New-AzureRmRedisCache -Name <String> -ResourceGroupName <String> -Location <String> [-RedisVersion <String>]
    [-Size <String>] [-Sku <String>] [-MaxMemoryPolicy <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort
    <Boolean>] [-ShardCount <Integer>] [-VirtualNetwork <String>] [-Subnet <String>] [-StaticIP <String>]
    [<CommonParameters>]


DESCRIPTION
    The New-AzureRmRedisCache cmdlet creates a new redis cache.


PARAMETERS
    -Name <String>
        Name of the redis cache to create.

    -ResourceGroupName <String>
        Name of resource group in which to create the redis cache.

    -Location <String>
        Location in which to create the redis cache.

    -RedisVersion <String>
        RedisVersion is deprecated and will be removed in future release.

    -Size <String>
        Size of the redis cache. The default value is 1GB or C1. Possible values are P1, P2, P3, P4, C0, C1, C2, C3,
        C4, C5, C6, 250MB, 1GB, 2.5GB, 6GB, 13GB, 26GB, 53GB.

    -Sku <String>
        Sku of redis cache. The default value is Standard. Possible values are Basic, Standard and Premium.

    -MaxMemoryPolicy <String>
        The 'MaxMemoryPolicy' setting has been deprecated. Please use 'RedisConfiguration' setting to set
        MaxMemoryPolicy. e.g. -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"}

    -RedisConfiguration <Hashtable>
        All Redis Configuration Settings. Few possible keys: rdb-backup-enabled, rdb-storage-connection-string,
        rdb-backup-frequency, maxmemory-reserved, maxmemory-policy, notify-keyspace-events, hash-max-ziplist-entries,
        hash-max-ziplist-value, set-max-intset-entries, zset-max-ziplist-entries, zset-max-ziplist-value, databases.

    -EnableNonSslPort <Boolean>
        EnableNonSslPort is used by Azure Redis Cache. If no value is provided, the default value is false and the
        non-SSL port will be disabled. Possible values are true and false.

    -ShardCount <Integer>
        The number of shards to create on a Premium Cluster Cache.

    -VirtualNetwork <String>
        The exact ARM resource ID of the virtual network to deploy the redis cache in. Example format: /subscriptions/{
        subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.ClassicNetwork/VirtualNetworks/{vnetName}

    -Subnet <String>
        Required when deploying a redis cache inside an existing Azure Virtual Network.

    -StaticIP <String>
        Required when deploying a redis cache inside an existing Azure Virtual Network.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

既定のパラメーターを使用してキャッシュを作成するには、次のコマンドを実行します。To create a cache with default parameters, run the following command.

New-AzureRmRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US"

ResourceGroupNameNameLocation は必須のパラメーターですが、他のパラメーターは省略可能で、それぞれに既定値があります。ResourceGroupName, Name, and Location are required parameters, but the rest are optional and have default values. 前述のコマンドを実行すると、Standard SKU の Azure Redis Cache インスタンスが作成され、指定した名前、場所、リソース グループが設定されます。サイズは 1 GB に設定され、非 SSL ポートは無効になっています。Running the previous command creates a Standard SKU Azure Redis Cache instance with the specified name, location, and resource group, that is 1 GB in size with the non-SSL port disabled.

Premium キャッシュを作成する場合は、P1 (6 GB ~ 60 GB)、P2 (13 GB ~ 130 GB)、P3 (26 GB ~ 260 GB)、P4 (53 GB ~ 530 GB) のいずれかのサイズを指定します。To create a premium cache, specify a size of P1 (6 GB - 60 GB), P2 (13 GB - 130 GB), P3 (26 GB - 260 GB), or P4 (53 GB - 530 GB). クラスタリングを有効にする場合は、ShardCount パラメーターを使用してシャード数を指定します。To enable clustering, specify a shard count using the ShardCount parameter. 次の例では、3 つのシャードを指定して P1 の Premium キャッシュを作成しています。The following example creates a P1 premium cache with 3 shards. P1 Premium キャッシュはサイズが 6 GB です。3 つのシャードを指定したため、合計サイズは 18 GB (3 x 6 GB) です。A P1 premium cache is 6 GB in size, and since we specified three shards the total size is 18 GB (3 x 6 GB).

New-AzureRmRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -Sku Premium -Size P1 -ShardCount 3

RedisConfiguration の値を指定する場合は、@{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"} のように、キー/値のペアとして値を {} で囲みます。To specify values for the RedisConfiguration parameter, enclose the values inside {} as key/value pairs like @{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}. 次の例では、allkeys-random に設定された maxmemory ポリシーと KEA に設定されたキースペース通知を使用して、Standard の 1 GB のキャッシュを作成しています。The following example creates a standard 1 GB cache with allkeys-random maxmemory policy and keyspace notifications configured with KEA. 詳細については、「キースペース通知 (詳細設定)」および「メモリ ポリシー」をご覧ください。For more information, see Keyspace notifications (advanced settings) and Memory policies.

New-AzureRmRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}

キャッシュの作成時にデータベースの設定を構成するにはTo configure the databases setting during cache creation

databases の設定は、キャッシュの作成中にのみ構成することができます。The databases setting can be configured only during cache creation. 次の例では、 New-AzureRmRedisCache コマンドレットを使用して、48 のデータベースを持つ Premium P3 (26 GB) のキャッシュを作成します。The following example creates a premium P3 (26 GB) cache with 48 databases using the New-AzureRmRedisCache cmdlet.

New-AzureRmRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -Sku Premium -Size P3 -RedisConfiguration @{"databases" = "48"}

databases プロパティの詳細については、「 既定の Azure Redis Cache サーバー構成」をご覧ください。For more information on the databases property, see Default Azure Redis Cache server configuration. New-AzureRmRedisCache コマンドレットを使用して、キャッシュを作成する方法の詳細については、上記の「Redis Cache の作成方法」セクションをご覧ください。For more information on creating a cache using the New-AzureRmRedisCache cmdlet, see the previous To create a Redis Cache section.

Redis Cache の更新方法To update a Redis cache

Azure Redis Cache インスタンスを更新するには、 Set-AzureRmRedisCache コマンドレットを使用します。Azure Redis Cache instances are updated using the Set-AzureRmRedisCache cmdlet.

Set-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Set-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Set-AzureRmRedisCache -detailed

NAME
    Set-AzureRmRedisCache

SYNOPSIS
    Set redis cache updatable parameters.

SYNTAX
    Set-AzureRmRedisCache -Name <String> -ResourceGroupName <String> [-Size <String>] [-Sku <String>]
    [-MaxMemoryPolicy <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-ShardCount
    <Integer>] [<CommonParameters>]

DESCRIPTION
    The Set-AzureRmRedisCache cmdlet sets redis cache parameters.

PARAMETERS
    -Name <String>
        Name of the redis cache to update.

    -ResourceGroupName <String>
        Name of the resource group for the cache.

    -Size <String>
        Size of the redis cache. The default value is 1GB or C1. Possible values are P1, P2, P3, P4, C0, C1, C2, C3,
        C4, C5, C6, 250MB, 1GB, 2.5GB, 6GB, 13GB, 26GB, 53GB.

    -Sku <String>
        Sku of redis cache. The default value is Standard. Possible values are Basic, Standard and Premium.

    -MaxMemoryPolicy <String>
        The 'MaxMemoryPolicy' setting has been deprecated. Please use 'RedisConfiguration' setting to set
        MaxMemoryPolicy. e.g. -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"}

    -RedisConfiguration <Hashtable>
        All Redis Configuration Settings. Few possible keys: rdb-backup-enabled, rdb-storage-connection-string,
        rdb-backup-frequency, maxmemory-reserved, maxmemory-policy, notify-keyspace-events, hash-max-ziplist-entries,
        hash-max-ziplist-value, set-max-intset-entries, zset-max-ziplist-entries, zset-max-ziplist-value.

    -EnableNonSslPort <Boolean>
        EnableNonSslPort is used by Azure Redis Cache. The default value is null and no change will be made to the
        currently configured value. Possible values are true and false.

    -ShardCount <Integer>
        The number of shards to create on a Premium Cluster Cache.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Set-AzureRmRedisCache コマンドレットを使用して、SizeSkuEnableNonSslPortRedisConfiguration の値などのプロパティを更新できます。The Set-AzureRmRedisCache cmdlet can be used to update properties such as Size, Sku, EnableNonSslPort, and the RedisConfiguration values.

次のコマンドを実行すると、myCache という名前の Redis Cache の maxmemory-policy が更新されます。The following command updates the maxmemory-policy for the Redis Cache named myCache.

Set-AzureRmRedisCache -ResourceGroupName "myGroup" -Name "myCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"}

Redis Cache をスケーリングするにはTo scale a Redis cache

SizeSku、または ShardCount のプロパティが変更されたときに、Set-AzureRmRedisCache を使用して、Azure Redis Cache インスタンスをスケールできます。Set-AzureRmRedisCache can be used to scale an Azure Redis cache instance when the Size, Sku, or ShardCount properties are modified.

注意

PowerShell を使用してキャッシュをスケールする場合、Azure ポータルからキャッシュをスケールする場合と同じ制限とガイドラインが適用されます。Scaling a cache using PowerShell is subject to the same limits and guidelines as scaling a cache from the Azure portal. 別の価格レベルにスケーリングできますが、次のような制約があります。You can scale to a different pricing tier with the following restrictions.

  • 上位の価格レベルから下位の価格レベルにスケーリングすることはできません。You can't scale from a higher pricing tier to a lower pricing tier.
  • Premium キャッシュから Standard または Basic キャッシュにスケールすることはできません。You can't scale from a Premium cache down to a Standard or a Basic cache.
  • Standard キャッシュから Basic キャッシュにスケールすることはできません。You can't scale from a Standard cache down to a Basic cache.
  • Basic キャッシュから Standard キャッシュにスケールすることはできますが、同時にサイズを変更することはできません。You can scale from a Basic cache to a Standard cache but you can't change the size at the same time. サイズを変更する必要がある場合、後続のスケーリング操作でサイズを変更できます。If you need a different size, you can do a subsequent scaling operation to the desired size.
  • Basic キャッシュから直接 Premium キャッシュにスケールすることはできません。You can't scale from a Basic cache directly to a Premium cache. 1 回のスケーリング操作で Basic から Standard にスケールし、その後の操作で Standard から Premium にスケールする必要があります。You must scale from Basic to Standard in one scaling operation, and then from Standard to Premium in a subsequent scaling operation.
  • C0 (250 MB) サイズにそれより大きなサイズからスケールダウンすることはできません。You can't scale from a larger size down to the C0 (250 MB) size.

詳細については、「 Azure Redis Cache のスケーリング方法」をご覧ください。For more information, see How to Scale Azure Redis Cache.

次の例は、 myCache という名前のキャッシュを 2.5 GB のキャッシュにスケーリングする方法を示しています。The following example shows how to scale a cache named myCache to a 2.5 GB cache. このコマンドは、Basic と Standard の両方のキャッシュで使用できます。Note that this command works for both a Basic or a Standard cache.

Set-AzureRmRedisCache -ResourceGroupName myGroup -Name myCache -Size 2.5GB

このコマンドが発行されると、キャッシュの状態が返されます ( Get-AzureRmRedisCacheの呼び出しと同様です)。After this command is issued, the status of the cache is returned (similar to calling Get-AzureRmRedisCache). ProvisioningStateScaling である点に注目してください。Note that the ProvisioningState is Scaling.

PS C:\> Set-AzureRmRedisCache -Name myCache -ResourceGroupName myGroup -Size 2.5GB


Name               : mycache
Id                 : /subscriptions/12ad12bd-abdc-2231-a2ed-a2b8b246bbad4/resourceGroups/mygroup/providers/Mi
                     crosoft.Cache/Redis/mycache
Location           : South Central US
Type               : Microsoft.Cache/Redis
HostName           : mycache.redis.cache.windows.net
Port               : 6379
ProvisioningState  : Scaling
SslPort            : 6380
RedisConfiguration : {[maxmemory-policy, volatile-lru], [maxmemory-reserved, 150], [notify-keyspace-events, KEA],
                     [maxmemory-delta, 150]...}
EnableNonSslPort   : False
RedisVersion       : 3.0
Size               : 1GB
Sku                : Standard
ResourceGroupName  : mygroup
PrimaryKey         : ....
SecondaryKey       : ....
VirtualNetwork     :
Subnet             :
StaticIP           :
TenantSettings     : {}
ShardCount         :

スケーリング処理が完了すると、ProvisioningStateSucceeded に変わります。When the scaling operation is complete, the ProvisioningState changes to Succeeded. Basic から Standard に変更した後にサイズを変更するなど、前の操作に続けてスケーリング操作の実行が必要になる場合は、前の操作が完了するまで待つ必要があります。そうでないと、次のようなエラーが表示されます。If you need to make a subsequent scaling operation, such as changing from Basic to Standard and then changing the size, you must wait until the previous operation is complete or you receive an error similar to the following.

Set-AzureRmRedisCache : Conflict: The resource '...' is not in a stable state, and is currently unable to accept the update request.

Redis Cache に関する情報を取得する方法To get information about a Redis cache

Get AzureRmRedisCache コマンドレットを使用してキャッシュに関する情報を取得できます。You can retrieve information about a cache using the Get-AzureRmRedisCache cmdlet.

Get-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Get-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Get-AzureRmRedisCache -detailed

NAME
    Get-AzureRmRedisCache

SYNOPSIS
    Gets details about a single cache or all caches in the specified resource group or all caches in the current
    subscription.

SYNTAX
    Get-AzureRmRedisCache [-Name <String>] [-ResourceGroupName <String>] [<CommonParameters>]

DESCRIPTION
    The Get-AzureRmRedisCache cmdlet gets the details about a cache or caches depending on input parameters. If both
    ResourceGroupName and Name parameters are provided then Get-AzureRmRedisCache will return details about the
    specific cache name provided.

    If only ResourceGroupName is provided than it will return details about all caches in the specified resource group.

    If no parameters are given than it will return details about all caches the current subscription.

PARAMETERS
    -Name <String>
        The name of the cache. When this parameter is provided along with ResourceGroupName, Get-AzureRmRedisCache
        returns the details for the cache.

    -ResourceGroupName <String>
        The name of the resource group that contains the cache or caches. If ResourceGroupName is provided with Name
        then Get-AzureRmRedisCache returns the details of the cache specified by Name. If only the ResourceGroup
        parameter is provided, then details for all caches in the resource group are returned.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

現在のサブスクリプションのすべてのキャッシュに関する情報を取得するには、パラメーターを指定せずに Get-AzureRmRedisCache を実行します。To return information about all caches in the current subscription, run Get-AzureRmRedisCache without any parameters.

Get-AzureRmRedisCache

特定のリソース グループのすべてのキャッシュに関する情報を取得するには、ResourceGroupName パラメーターを指定して Get-AzureRmRedisCache を実行します。To return information about all caches in a specific resource group, run Get-AzureRmRedisCache with the ResourceGroupName parameter.

Get-AzureRmRedisCache -ResourceGroupName myGroup

特定のキャッシュに関する情報を取得するには、キャッシュの名前を Name パラメーターに設定し、そのキャッシュが含まれているリソース グループを ResourceGroupName パラメーターに設定して、Get-AzureRmRedisCache を実行します。To return information about a specific cache, run Get-AzureRmRedisCache with the Name parameter containing the name of the cache, and the ResourceGroupName parameter with the resource group containing that cache.

PS C:\> Get-AzureRmRedisCache -Name myCache -ResourceGroupName myGroup

Name               : mycache
Id                 : /subscriptions/12ad12bd-abdc-2231-a2ed-a2b8b246bbad4/resourceGroups/myGroup/providers/Mi
                     crosoft.Cache/Redis/mycache
Location           : South Central US
Type               : Microsoft.Cache/Redis
HostName           : mycache.redis.cache.windows.net
Port               : 6379
ProvisioningState  : Succeeded
SslPort            : 6380
RedisConfiguration : {[maxmemory-policy, volatile-lru], [maxmemory-reserved, 62], [notify-keyspace-events, KEA],
                     [maxclients, 1000]...}
EnableNonSslPort   : False
RedisVersion       : 3.0
Size               : 1GB
Sku                : Standard
ResourceGroupName  : myGroup
VirtualNetwork     :
Subnet             :
StaticIP           :
TenantSettings     : {}
ShardCount         :

Redis Cache のアクセス キーを取得する方法To retrieve the access keys for a Redis cache

キャッシュのアクセス キーを取得するには、 Get AzureRmRedisCacheKey コマンドレットを使用します。To retrieve the access keys for your cache, you can use the Get-AzureRmRedisCacheKey cmdlet.

Get-AzureRmRedisCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Get-AzureRmRedisCacheKey, run the following command.

PS C:\> Get-Help Get-AzureRmRedisCacheKey -detailed

NAME
    Get-AzureRmRedisCacheKey

SYNOPSIS
    Gets the accesskeys for the specified redis cache.


SYNTAX
    Get-AzureRmRedisCacheKey -Name <String> -ResourceGroupName <String> [<CommonParameters>]

DESCRIPTION
    The Get-AzureRmRedisCacheKey cmdlet gets the access keys for the specified cache.

PARAMETERS
    -Name <String>
        Name of the redis cache.

    -ResourceGroupName <String>
        Name of the resource group for the cache.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

キャッシュのキーを取得するには、 Get-AzureRmRedisCacheKey コマンドレットを呼び出し、キャッシュの名前と、そのキャッシュが含まれているリソース グループの名前を渡します。To retrieve the keys for your cache, call the Get-AzureRmRedisCacheKey cmdlet and pass in the name of your cache the name of the resource group that contains the cache.

PS C:\> Get-AzureRmRedisCacheKey -Name myCache -ResourceGroupName myGroup

PrimaryKey   : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : ABhfB757JgjIgt785JgKH9865eifmekfnn649303JKL=

Redis Cache のアクセス キーを再生成する方法To regenerate access keys for your Redis cache

キャッシュのアクセス キーを再生成するには、 New-AzureRmRedisCacheKey コマンドレットを使用します。To regenerate the access keys for your cache, you can use the New-AzureRmRedisCacheKey cmdlet.

New-AzureRmRedisCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for New-AzureRmRedisCacheKey, run the following command.

PS C:\> Get-Help New-AzureRmRedisCacheKey -detailed

NAME
    New-AzureRmRedisCacheKey

SYNOPSIS
    Regenerates the access key of a redis cache.

SYNTAX
    New-AzureRmRedisCacheKey -Name <String> -ResourceGroupName <String> -KeyType <String> [-Force] [<CommonParameters>]

DESCRIPTION
    The New-AzureRmRedisCacheKey cmdlet regenerate the access key of a redis cache.

PARAMETERS
    -Name <String>
        Name of the redis cache.

    -ResourceGroupName <String>
        Name of the resource group for the cache.

    -KeyType <String>
        Specifies whether to regenerate the primary or secondary access key. Possible values are Primary or Secondary.

    -Force
        When the Force parameter is provided, the specified access key is regenerated without any confirmation prompts.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

キャッシュのプライマリ キーまたはセカンダリ キーを再生成するには、New-AzureRmRedisCacheKey コマンドレットを呼び出し、名前とリソース グループを渡して、KeyType パラメーターに Primary または Secondary を指定します。To regenerate the primary or secondary key for your cache, call the New-AzureRmRedisCacheKey cmdlet and pass in the name, resource group, and specify either Primary or Secondary for the KeyType parameter. 次の例では、キャッシュのセカンダリ アクセス キーが再生成されます。In the following example, the secondary access key for a cache is regenerated.

PS C:\> New-AzureRmRedisCacheKey -Name myCache -ResourceGroupName myGroup -KeyType Secondary

Confirm
Are you sure you want to regenerate Secondary key for redis cache 'myCache'?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y


PrimaryKey   : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : c53hj3kh4jhHjPJk8l0jji785JgKH9865eifmekfnn6=

Redis Cache を削除する方法To delete a Redis cache

Redis Cache を削除するには、 Remove-AzureRmRedisCache コマンドレットを使用します。To delete a Redis cache, use the Remove-AzureRmRedisCache cmdlet.

Remove-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Remove-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Remove-AzureRmRedisCache -detailed

NAME
    Remove-AzureRmRedisCache

SYNOPSIS
    Remove redis cache if exists.

SYNTAX
    Remove-AzureRmRedisCache -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [<CommonParameters>

DESCRIPTION
    The Remove-AzureRmRedisCache cmdlet removes a redis cache if it exists.

PARAMETERS
    -Name <String>
        Name of the redis cache to remove.

    -ResourceGroupName <String>
        Name of the resource group of the cache to remove.

    -Force
        When the Force parameter is provided, the cache is removed without any confirmation prompts.

    -PassThru
        By default Remove-AzureRmRedisCache removes the cache and does not return any value. If the PassThru par
        is provided then Remove-AzureRmRedisCache returns a boolean value indicating the success of the operatio

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

次の例では、 myCache という名前のキャッシュが削除されます。In the following example, the cache named myCache is removed.

PS C:\> Remove-AzureRmRedisCache -Name myCache -ResourceGroupName myGroup

Confirm
Are you sure you want to remove redis cache 'myCache'?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y

Redis Cache にインポートする方法To import a Redis cache

Azure Redis Cache インスタンスにデータをインポートするには、 Import-AzureRmRedisCache コマンドレットを使用します。You can import data into an Azure Redis Cache instance using the Import-AzureRmRedisCache cmdlet.

重要

インポート/エクスポートは、 Premium レベル のキャッシュでのみ使用できます。Import/Export is only available for premium tier caches. インポート/エクスポートの詳細については、「 Azure Redis Cache でデータをインポートまたはエクスポートする」をご覧ください。For more information about Import/Export, see Import and Export data in Azure Redis Cache.

Import-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Import-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Import-AzureRmRedisCache -detailed

NAME
    Import-AzureRmRedisCache

SYNOPSIS
    Import data from blobs to Azure Redis Cache.


SYNTAX
    Import-AzureRmRedisCache -Name <String> -ResourceGroupName <String> -Files <String[]> [-Format <String>] [-Force]
    [-PassThru] [<CommonParameters>]


DESCRIPTION
    The Import-AzureRmRedisCache cmdlet imports data from the specified blobs into Azure Redis Cache.


PARAMETERS
    -Name <String>
        The name of the cache.

    -ResourceGroupName <String>
        The name of the resource group that contains the cache.

    -Files <String[]>
        SAS urls of blobs whose content should be imported into the cache.

    -Format <String>
        Format for the blob.  Currently "rdb" is the only supported, with other formats expected in the future.

    -Force
        When the Force parameter is provided, import will be performed without any confirmation prompts.

    -PassThru
        By default Import-AzureRmRedisCache imports data in cache and does not return any value. If the PassThru
        parameter is provided then Import-AzureRmRedisCache returns a boolean value indicating the success of the
        operation.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

次のコマンドは、SAS URI で指定された BLOB から Azure Redis Cache にデータをインポートします。The following command imports data from the blob specified by the SAS uri into Azure Redis Cache.

PS C:\>Import-AzureRmRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -Files @("https://mystorageaccount.blob.core.windows.net/mycontainername/blobname?sv=2015-04-05&sr=b&sig=caIwutG2uDa0NZ8mjdNJdgOY8%2F8mhwRuGNdICU%2B0pI4%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwd") -Force

Redis Cache からエクスポートする方法To export a Redis cache

Azure Redis Cache インスタンスからデータをエクスポートするには、 Export-AzureRmRedisCache コマンドレットを使用します。You can export data from an Azure Redis Cache instance using the Export-AzureRmRedisCache cmdlet.

重要

インポート/エクスポートは、 Premium レベル のキャッシュでのみ使用できます。Import/Export is only available for premium tier caches. インポート/エクスポートの詳細については、「 Azure Redis Cache でデータをインポートまたはエクスポートする」をご覧ください。For more information about Import/Export, see Import and Export data in Azure Redis Cache.

Export-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Export-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Export-AzureRmRedisCache -detailed

NAME
    Export-AzureRmRedisCache

SYNOPSIS
    Exports data from Azure Redis Cache to a specified container.


SYNTAX
    Export-AzureRmRedisCache -Name <String> -ResourceGroupName <String> -Prefix <String> -Container <String> [-Format
    <String>] [-PassThru] [<CommonParameters>]


DESCRIPTION
    The Export-AzureRmRedisCache cmdlet exports data from Azure Redis Cache to a specified container.


PARAMETERS
    -Name <String>
        The name of the cache.

    -ResourceGroupName <String>
        The name of the resource group that contains the cache.

    -Prefix <String>
        Prefix to use for blob names.

    -Container <String>
        SAS url of container where data should be exported.

    -Format <String>
        Format for the blob.  Currently "rdb" is the only supported, with other formats expected in the future.

    -PassThru
        By default Export-AzureRmRedisCache does not return any value. If the PassThru parameter is provided
        then Export-AzureRmRedisCache returns a boolean value indicating the success of the operation.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

次のコマンドは、Azure Redis Cache インスタンスから、SAS URI で指定されたコンテナーにデータをエクスポートします。The following command exports data from an Azure Redis Cache instance into the container specified by the SAS uri.

    PS C:\>Export-AzureRmRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -Prefix "blobprefix"
    -Container "https://mystorageaccount.blob.core.windows.net/mycontainer?sv=2015-04-05&sr=c&sig=HezZtBZ3DURmEGDduauE7
    pvETY4kqlPI8JCNa8ATmaw%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwdl"

Redis Cache を再起動する方法To reboot a Redis cache

Azure Redis Cache インスタンスを再起動するには、 Reset-AzureRmRedisCache コマンドレットを使用します。You can reboot your Azure Redis Cache instance using the Reset-AzureRmRedisCache cmdlet.

重要

再起動は、 Premium レベル のキャッシュでのみ使用できます。Reboot is only available for premium tier caches. キャッシュの再起動の詳細については、 キャッシュ管理 - 再起動に関するセクションをご覧ください。For more information about rebooting your cache, see Cache administration - reboot.

Reset-AzureRmRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。To see a list of available parameters and their descriptions for Reset-AzureRmRedisCache, run the following command.

PS C:\> Get-Help Reset-AzureRmRedisCache -detailed

NAME
    Reset-AzureRmRedisCache

SYNOPSIS
    Reboot specified node(s) of an Azure Redis Cache instance.


SYNTAX
    Reset-AzureRmRedisCache -Name <String> -ResourceGroupName <String> -RebootType <String> [-ShardId <Integer>]
    [-Force] [-PassThru] [<CommonParameters>]


DESCRIPTION
    The Reset-AzureRmRedisCache cmdlet reboots the specified node(s) of an Azure Redis Cache instance.


PARAMETERS
    -Name <String>
        The name of the cache.

    -ResourceGroupName <String>
        The name of the resource group that contains the cache.

    -RebootType <String>
        Which node to reboot. Possible values are "PrimaryNode", "SecondaryNode", "AllNodes".

    -ShardId <Integer>
        Which shard to reboot when rebooting a premium cache with clustering enabled.

    -Force
        When the Force parameter is provided, reset will be performed without any confirmation prompts.

    -PassThru
        By default Reset-AzureRmRedisCache does not return any value. If the PassThru parameter is provided
        then Reset-AzureRmRedisCache returns a boolean value indicating the success of the operation.

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

次のコマンドは、指定されたキャッシュの両方のノードを再起動します。The following command reboots both nodes of the specified cache.

    PS C:\>Reset-AzureRmRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -RebootType "AllNodes"
    -Force

次のステップNext steps

Azure での Windows PowerShell の使用の詳細については、次のリソースをご覧ください。To learn more about using Windows PowerShell with Azure, see the following resources: