Azure PowerShell を使用した Azure Redis の管理

Azure Managed Redis キャッシュを作成する

New-AzRedisEnterpriseCache コマンドレットを使用して、新しい Azure Managed Redis インスタンスを作成します。 ResourceGroupName、 Name、 Location、および Sku は必須のパラメーターです。 その他のパラメーターは省略可能であり、既定値があります。

Microsoft Entra 認証は、すべての新しいキャッシュに対して既定で有効になっており、セキュリティに推奨されます。

New-AzRedisEnterpriseCacheのすべての Azure Managed Redis PowerShell パラメーターとプロパティについては、「New-AzRedisEnterpriseCache」を参照してください。 使用可能なパラメーターとその説明の一覧を出力するには、次のコマンドを実行します。

Get-Help New-AzRedisEnterpriseCache -detailed

次のコマンド例では、既定のパラメーターを使用して、指定した名前、場所、リソース グループ、SKU を使用して Azure Managed Redis インスタンスを作成します。 インスタンスのサイズは 1 GB で、SSL 以外のポートは無効になっています。

New-AzRedisEnterpriseCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -Sku Balanced_B1

データベースの作成と構成

New-AzRedisEnterpriseCacheDatabase コマンドレットを使用して、Azure Managed Redis キャッシュのデータベースを作成および構成できます。 New-AzRedisEnterpriseCacheDatabaseで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help New-AzRedisEnterpriseCacheDatabase -detailed

キャッシュの作成時にデータベースを構成しない場合、 New-AzRedisEnterpriseCache は既定で default という名前のキャッシュに 1 つのデータベースを作成し、すべてのキャッシュ データがこの DB 0 データベースに格納されます。

Azure Managed Redis キャッシュを更新する

Update-AzRedisEnterpriseCache コマンドレットを使用して、Azure Managed Redis インスタンスを更新できます。 Update-AzRedisEnterpriseCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Update-AzRedisEnterpriseCache -detailed

Update-AzRedisEnterpriseCache コマンドレットを使用して、Sku、Tag、MinimumTlsVersionなどのプロパティを更新できます。 次のコマンドは、トランスポート層セキュリティ (TLS) の最小バージョンを更新し、 myCacheという名前の Azure Managed Redis キャッシュにタグを追加します。

Update-AzRedisEnterpriseCache -Name "myCache" -ResourceGroupName "myGroup" -MinimumTlsVersion "1.2" -Tag @{"tag1" = "value1"}

Azure Managed Redis Cache に関する情報を取得する

Get-AzRedisEnterpriseCache コマンドレットを使用してキャッシュに関する情報を取得できます。 Get-AzRedisEnterpriseCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Get-AzRedisEnterpriseCache -detailed

現在のサブスクリプションのすべてのキャッシュに関する情報を取得するには、パラメーターを指定せずに Get-AzRedisEnterpriseCache を実行します。

Get-AzRedisEnterpriseCache

特定のリソース グループのすべてのキャッシュに関する情報を取得するには、Get-AzRedisEnterpriseCache パラメーターを指定して ResourceGroupName を実行します。

Get-AzRedisEnterpriseCache -ResourceGroupName myGroup

特定のキャッシュに関する情報を返すには、キャッシュのGet-AzRedisEnterpriseCacheとNameを使用してResourceGroupNameを実行します。

Get-AzRedisEnterpriseCache -Name myCache -ResourceGroupName myGroup

Azure Managed Redis キャッシュのアクセス キーを取得する

キャッシュのアクセス キーを取得するには、 Get-AzRedisEnterpriseCacheKey コマンドレットを使用します。 Get-AzRedisEnterpriseCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Get-AzRedisEnterpriseCacheKey -detailed

キャッシュのキーを取得するには、キャッシュのGet-AzRedisEnterpriseCacheKeyとNameを使用して ResourceGroupName コマンドレットを呼び出します。

Get-AzRedisEnterpriseCacheKey -Name myCache -ResourceGroupName myGroup

Azure Managed Redis キャッシュのアクセス キーを再生成する

キャッシュのアクセス キーを再生成するには、New-AzRedisEnterpriseCacheKey コマンドレットを使用します。 New-AzRedisEnterpriseCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help New-AzRedisEnterpriseCacheKey -detailed

キャッシュのプライマリ キーまたはセカンダリ キーを再生成するには、キャッシュ New-AzRedisEnterpriseCacheKeyとNameを使用して ResourceGroupName コマンドレットを呼び出し、Primary パラメーターにSecondaryまたはKeyTypeを指定します。 次の例では、キャッシュのセカンダリ アクセス キーを再生成します。

New-AzRedisEnterpriseCacheKey -Name myCache -ResourceGroupName myGroup -KeyType Secondary

Azure Managed Redis キャッシュを削除する

Azure Managed Redis Cache を削除するには、 Remove-AzRedisEnterpriseCache コマンドレットを使用します。 Remove-AzRedisEnterpriseCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Remove-AzRedisEnterpriseCache -detailed

次の例では、 myCacheという名前のキャッシュを削除します。

Remove-AzRedisEnterpriseCache -Name myCache -ResourceGroupName myGroup

Azure Managed Redis Cache データをインポートする

Azure Managed Redis インスタンスにデータをインポートするには、Import-AzRedisEnterpriseCache コマンドレットを使用します。 Import-AzRedisEnterpriseCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Import-AzRedisEnterpriseCache -detailed

インポートする BLOB のキャッシュ Name と ResourceGroupName と SasUri が必要です。 次のコマンドは、SAS URI で指定された BLOB からデータをインポートします。

Import-AzRedisEnterpriseCache -ClusterName "myCache" -ResourceGroupName "myGroup" -SasUri @("<sas-uri>")

Azure Managed Redis Cache データをエクスポートする

Azure Managed Redis インスタンスからデータをエクスポートするには、Export-AzRedisEnterpriseCache コマンドレットを使用します。 Export-AzRedisEnterpriseCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Export-AzRedisEnterpriseCache -detailed

キャッシュの Name と ResourceGroupName 、エクスポートするコンテナーの SasUri が必要です。 次のコマンド例では、SAS URI で指定されたコンテナーからデータをエクスポートします。

Export-AzRedisEnterpriseCache -Name "myCache" -ResourceGroupName "myGroup" -SasUri "https://mystorageaccount.blob.core.windows.net/mycontainer?sp=signedPermissions&se=signedExpiry&sv=signedVersion&sr=signedResource&sig=signature;mystoragekey"

Azure Cache for Redis PowerShell のプロパティとパラメーター

次の表は、Azure PowerShell のプロパティと、一般的な Azure Cache for Redis パラメーターの説明を示しています。 Az.RedisCacheのすべての Azure PowerShell パラメーターとプロパティについては、AzRedisCache を参照してください。

RedisConfiguration パラメーターのプロパティ

Azure Cache for Redis キャッシュを作成する

New-AzRedisCache コマンドレットを使用して、新しい Azure Cache for Redis インスタンスを作成します。 ResourceGroupName、 Name、および Location は必須パラメーターです。 その他のパラメーターは省略可能であり、既定値があります。

New-AzRedisCache で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help New-AzRedisCache -detailed>

次のコマンド例では、既定のパラメーターを使用して、指定した名前、場所、およびリソース グループを持つ Azure Cache for Redis インスタンスを作成します。 インスタンスは、非 SSL ポートが無効になっている Standard 1 GB キャッシュです。

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

RedisConfiguration パラメーターの値を指定するには、キーと値のペアを中かっこで囲{}。 次の例では、 @{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}を使用して 1 GB のキャッシュを作成します。 詳細については、「キースペース通知 (詳細設定)」および「メモリ ポリシー」をご覧ください。

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

Premium キャッシュを作成する

Azure Cache for Redis Premium レベルのキャッシュを作成するには、 P1 (6 から 60 GB)、 P2 (13 から 130 GB)、 P3 (26 から 260 GB)、または P4 (53 から 530 GB) のサイズを指定します。 クラスタリングを有効にする場合は、ShardCount パラメーターを使用してシャード数を指定します。

次の例では、3 つのシャードを含む P1 Premium キャッシュを作成します。 P1 Premium キャッシュのサイズは 6 GB で、3 つのシャードの合計サイズは 18 GB (3 x 6 GB) です。

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

データベース設定を構成する

databases コマンドレットの設定では、キャッシュ内のデータベースの数が構成されます。 databasesは Standard レベルと Premium レベルにのみ構成でき、PowerShell やその他の管理クライアントを使用したキャッシュの作成時にのみ構成できます。

キャッシュの作成時に databases 設定を指定しない場合、 New-AzRedisCache によって default という名前のデータベースが 1 つ作成され、すべてのキャッシュ データがこの DB 0 データベースに格納されます。 データベースの制限はキャッシュ層とサイズによって異なりますが、既定の設定は 16 です。

次の例では、48 個のデータベースを含む Premium P3 (26 GB) キャッシュを作成します。

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

databases プロパティの詳細については、「Default Azure Cache for Redis server configuration」 (既定の Azure Cache for Redis サーバー構成) をご覧ください。

Azure Cache for Redis キャッシュを更新する

Azure Cache for Redis インスタンスは 、Set-AzRedisCache コマンドレットを使用して更新します。 Set-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Set-AzRedisCache -detailed

Set-AzRedisCache コマンドレットを使用して、Size、Sku、EnableNonSslPort、RedisConfiguration値などのプロパティを更新できます。 次のコマンド例では、maxmemory-policyという名前の Azure Cache for Redis インスタンスのmyCacheを更新します。

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

Azure Cache for Redis キャッシュをスケーリングする

Set-AzRedisCache、Size、またはSkuのプロパティを変更するときに、ShardCountを使用して Azure Cache for Redis インスタンスをスケーリングできます。

次の例では、 myCache という名前のキャッシュを 2.5 GB のサイズにスケーリングする方法を示します。 このコマンドは、Basic キャッシュまたは Standard キャッシュに対して機能します。

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

このコマンドを発行すると、 Get-AzRedisCacheの呼び出しと同様に、キャッシュの状態が返されます。 ProvisioningState に Scaling が設定されています。

スケーリング処理が完了すると、ProvisioningState は Succeeded に変わります。 Basic から Standard に変更した後にサイズを変更するなど、別のスケーリング操作を行う必要がある場合は、前の操作が完了するまで待つ必要があります。 それ以外の場合は、次のメッセージのようなエラーが表示されます。

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

Azure Cache for Redis Cache に関する情報を取得する

Get-AzRedisCache コマンドレットを使用してキャッシュに関する情報を取得できます。 Get-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Get-AzRedisCache -detailed

現在のサブスクリプションのすべてのキャッシュに関する情報を取得するには、パラメーターを指定せずに Get-AzRedisCache を実行します。

Get-AzRedisCache

特定のリソース グループのすべてのキャッシュに関する情報を取得するには、Get-AzRedisCache パラメーターを指定して ResourceGroupName を実行します。

Get-AzRedisCache -ResourceGroupName myGroup

特定のキャッシュに関する情報を返すには、キャッシュ Get-AzRedisCacheとNameを使用してResourceGroupNameを実行します。

Get-AzRedisCache -Name myCache -ResourceGroupName myGroup

Azure Cache for Redis キャッシュのアクセス キーを取得する

キャッシュのアクセス キーを取得するには、 Get-AzRedisCacheKey コマンドレットを使用します。 Get-AzRedisCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Get-AzRedisCacheKey -detailed

キャッシュのキーを取得するには、キャッシュ Get-AzRedisCacheKeyとNameを使用して ResourceGroupName コマンドレットを呼び出します。

Get-AzRedisCacheKey -Name myCache -ResourceGroupName myGroup

Azure Cache for Redis キャッシュのアクセス キーを再生成する

キャッシュのアクセス キーを再生成するには、 New-AzRedisCacheKey コマンドレットを使用します。 New-AzRedisCacheKeyで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help New-AzRedisCacheKey -detailed

キャッシュのプライマリ キーまたはセカンダリ キーを再生成するには、キャッシュ New-AzRedisCacheKeyとNameを使用して ResourceGroupName コマンドレットを呼び出し、Primary パラメーターにSecondaryまたはKeyTypeを指定します。 次の例では、キャッシュのセカンダリ アクセス キーを再生成します。

New-AzRedisCacheKey -Name myCache -ResourceGroupName myGroup -KeyType Secondary

Azure Cache for Redis キャッシュを削除する

Azure Cache for Redis Cache を削除するには、 Remove-AzRedisCache コマンドレットを使用します。 Remove-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Remove-AzRedisCache -detailed

次の例では、 myCacheという名前のキャッシュを削除します。

Remove-AzRedisCache -Name myCache -ResourceGroupName myGroup

Azure Cache for Redis キャッシュにデータをインポートする

Azure Cache for Redis インスタンスにデータをインポートするには、Import-AzRedisCache コマンドレットを使用します。

Import-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Import-AzRedisCache -detailed

次のコマンドは、 Files パラメーターで指定された BLOB から Azure Cache for Redis にデータをインポートします。

Import-AzRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -Files @("https://mystorageaccount.blob.core.windows.net/mycontainername/blobname?sv=signedVersion&sr=signedResource&sig=signature&st=signTime&se=signedExpiry&sp=signedPermissions") -Force

Azure Cache for Redis のキャッシュ データをエクスポートする

Azure Cache for Redis インスタンスからデータをエクスポートするには、Export-AzRedisCache コマンドレットを使用します。

Export-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Export-AzRedisCache -detailed

次のコマンドは、azure Cache for Redis インスタンスから、 Container パラメーターで指定されたコンテナーにデータをエクスポートします。

Export-AzRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -Prefix "blobprefix" -Container "https://mystorageaccount.blob.core.windows.net/mycontainer?sv=signedResource&sig=signature&st=signTime&se=signedExpiry&sp=signedPermissions"

Azure Cache for Redis Cache を再起動する

Azure Cache for Redis インスタンスを再起動するには、Reset-AzRedisCache コマンドレットを使用します。

Reset-AzRedisCacheで使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。

Get-Help Reset-AzRedisCache -detailed

次のコマンドは、指定されたキャッシュの両方のノードを再起動します。

Reset-AzRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -RebootType "AllNodes" -Force