Azure PowerShell を使用した Azure Redis の管理
Azure Managed Redis
Azure Managed Redis (プレビュー) インスタンスを作成するには、Azure portal にサインインし、[リソースの作成] を選択します。
[新規] ページで、検索ボックスに「Azure Cache for Redis」と入力します。
[新規 Redis Cache] ページで、新しいキャッシュの設定を構成します。
設定 値を選択する 説明 サブスクリプション ドロップダウンで、ご自身のサブスクリプションを選択します。 この新しい Azure Managed Redis インスタンスが作成されるサブスクリプション。 リソース グループ ドロップ ダウンでリソース グループを選択するか、 [新規作成] を選択し、新しいリソース グループの名前を入力します。 その中にキャッシュやその他のリソースを作成するリソース グループの名前。 すべてのアプリ リソースを 1 つのリソース グループに配置することで、それらをまとめて簡単に管理または削除できます。 DNS 名 リージョンで一意の名前を入力します。 キャッシュ名は、"キャッシュのリージョン名と組み合わせた" ときに 1 から 63 文字の文字列で、数字、英字、ハイフンのみを使用する必要があります。 (キャッシュ名の長さが 45 文字未満の場合、現在使用できるすべてのリージョンで機能するはずです)。名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。 キャッシュ インスタンスの "ホスト名" は \<DNS name\>.\<Azure region\>.redis.azure.net
です。場所 ドロップ ダウンで場所を選択します。 Azure Managed Redis は、選択した Azure リージョンで使用できます。 キャッシュの種類 ドロップダウン メニューから、パフォーマンス レベルとキャッシュ サイズを選択します。 Redis インスタンスのパフォーマンスはレベルによって決まり、データの格納に使用できるメモリはキャッシュ サイズによって決まります。 適切なパフォーマンス レベルの選択に関するガイダンスについては、「最適なサービス レベルを選択する」を参照してください [次へ: ネットワーク] を選択し、パブリックまたはプライベート エンドポイントのいずれかを選択します。
[次: 詳細] を選択します。
インスタンスに追加する Redis モジュールを構成します。
新しいマネージド キャッシュの場合、既定で次のように設定されています:
- Microsoft Entra ID は有効になっています。
- [アクセス キー認証] は、セキュリティ上の理由から無効になっています。
重要
最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセス キーの認可より、セキュリティと使いやすさの点で優れています。 キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証への Microsoft Entra ID の使用に関する記事をご覧ください。
クラスター化されていないキャッシュの [Clustering policy] (クラスタリング ポリシー) を [Enterprise] に設定するか、クラスター化されたキャッシュの場合は [OSS] に設定します。 [クラスタリング ポリシー] の選択方法の詳細については、「クラスタリング ポリシー」を参照してください。
アクティブ geo レプリケーションを使用する場合は、作成時にそれを構成する必要があります。 詳細については、「Azure Managed Redis インスタンスのアクティブ geo レプリケーションを構成する」を参照してください。
重要
Azure Managed Redis (プレビュー) インスタンスのクラスタリング ポリシーは、作成後に変更することはできません。 RediSearch を使用している場合、Enterprise クラスター ポリシーは必須であり、サポートされている唯一の削除ポリシーは
NoEviction
です。重要
geo レプリケーション グループでこのキャッシュ インスタンスを使用している場合、インスタンスの作成後に削除ポリシーを変更することはできません。 キャッシュを作成する前に、プライマリ ノードの削除ポリシーを確認してください。 アクティブ geo レプリケーションの詳細については、「アクティブ geo レプリケーションの前提条件」を参照してください。
重要
キャッシュ インスタンスを作成した後でモジュールを変更することはできません。 モジュールは、Azure Cache for Redis インスタンスを作成するときに有効になっている必要があります。 キャッシュの作成後にモジュールの構成を有効にするオプションはありません。
タグ を選択してスキップします。
確認と作成 をクリックします。
設定を確認し、 [作成] を選択します。
Redis インスタンスの作成には数分かかります。 Azure Managed Redis の [概要] ページで進行状況を監視できます。 [状態] に "実行中" と表示されている場合は、キャッシュを使用する準備ができています。
Azure Cache for Redis
キャッシュを作成するには、Azure portal にサインインします。 ポータルのメニューで、[リソースの作成] を選びます。
[作業の開始] ペインの検索バーに「Azure Cache for Redis」と入力します。 検索結果で Azure Cache for Redis を見つけて、[作成] を選びます。
[新しい Redis Cache] ペインの [基本] タブで、以下のキャッシュの設定を構成します。
設定 アクション 説明 サブスクリプション Azure サブスクリプションを選択します。 Azure Cache for Redis の新しいインスタンスの作成に使うサブスクリプション。 リソース グループ リソース グループを選択するか、 [新規作成] を選択し、新しいリソース グループの名前を入力します。 キャッシュや他のリソースを作成するリソース グループの名前。 すべてのアプリ リソースを 1 つのリソース グループに配置することで、それらをまとめて簡単に管理または削除できます。 DNS 名 一意の名前を入力します。 キャッシュ名は、数字、英字、ハイフンのみを含む 1 から 63 文字の文字列とする必要があります。 名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。 キャッシュ インスタンスの "ホスト名" は \<DNS name>.redis.cache.windows.net
です。場所 場所を選択します。 キャッシュを使う他のサービスに近い Azure リージョン。 キャッシュ SKU SKU を選びます。 SKU によって、キャッシュに利用できるサイズ、パフォーマンス、機能のパラメーターが決まります。 詳細については、Azure Cache for Redis の概要に関するページを参照してください。 キャッシュ サイズ キャッシュ サイズを選びます。 詳細については、Azure Cache for Redis の概要に関するページを参照してください。 [ネットワーク] タブを選ぶか、[次へ: ネットワーク] を選びます。
[ネットワーク] タブで、キャッシュに使う接続方法を選びます。
[詳細] タブを選ぶか、[次へ: 詳細] を選びます。
[詳細] ペインで、以下の情報に基づいて認証方法を確認または選択します。
- 既定では、新しい Basic、Standard、または Premium キャッシュでは、Microsoft Entra 認証が有効になり、アクセス キー認証が無効になります。
- Basic または Standard キャッシュの場合は、非 TLS ポートを選択できます。
- Standard および Premium キャッシュの場合は、可用性ゾーンを有効にすることを選択できます。 キャッシュの作成後に可用性ゾーンを無効にすることはできません。
- Premium キャッシュを利用する場合は、非 TLS ポート、クラスタリング、マネージド ID、データ永続化の設定を構成します。
重要
最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセス キーの認可より、セキュリティと使いやすさの点で優れています。 キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証への Microsoft Entra ID の使用に関する記事をご覧ください。
(省略可能) [タグ] タブを選ぶか、[次へ: タグ] を選びます。
(省略可能) キャッシュ リソースを分類する場合は、[タグ] タブでタグの名前と値を入力します。
[確認および作成] ボタンを選択します。
[確認と作成] タブでは、Azure によって構成が自動的に検証されます。
緑色の検証に成功のメッセージが表示された後、 [作成] を選択します。
新しいキャッシュのデプロイは数分で完了します。 デプロイの進行状況は、Azure Cache for Redis の [概要] ペインで監視できます。 [状態] に [実行中] と表示されたら、キャッシュを使用できます。
この記事では、Azure Redis インスタンスの作成、更新、スケーリングを実行する方法を示します。
Note
Azure には、リソースの作成と操作に使用できる、Azure Resource Manager およびクラシックという 2 つの異なるデプロイ モデルがあります。 この記事では、Resource Manager デプロイ モデルの使用について説明します。 新しいデプロイには、クラシック デプロイ モデルではなく、Resource Manager デプロイ モデルをお勧めします。
クラシック デプロイ モデルについて詳しくは、「Azure Resource Manager とクラシック デプロイ: デプロイ モデルとリソースの状態について」を参照してください。
前提条件
Azure PowerShell をインストール済みである場合、Azure PowerShell バージョン 12.4.0 以降であることが必要です。 Azure PowerShell のバージョンは、Azure PowerShell コマンド プロンプトでこのコマンドを使用して確認できます。
Get-Module Az | format-table version
まず、このコマンドで Azure にサインインする必要があります。
Connect-AzAccount
Microsoft Azure のサインイン ダイアログで、Azure アカウントの電子メール アドレスとご自分のパスワードを指定します。
次に、Azure サブスクリプションが複数ある場合は、使用する Azure サブスクリプションを設定する必要があります。 現在のサブスクリプションを一覧表示するには、次のコマンドを実行します。
Get-AzSubscription | sort SubscriptionName | Select SubscriptionName
サブスクリプションを指定するには、次のコマンドを実行します。 次の例では、サブスクリプション名は ContosoSubscription
です。
Select-AzSubscription -SubscriptionName ContosoSubscription
Azure Resource Manager で Windows PowerShell を使用する前に、設定を確認する必要があります。
- Windows PowerShell バージョン 3.0 または 4.0。 Windows PowerShell のバージョンを調べるには、
$PSVersionTable
と入力して、PSVersion
の値が 3.0 か 4.0 かを確認します。 互換バージョンをインストールするには、「Windows Management Framework 3.0」を参照してください。
このチュートリアルに表示されているコマンドレットの詳しいヘルプを確認には、Get-Help コマンドレットを使用します。
Get-Help <cmdlet-name> -Detailed
たとえば、 New-AzRedisEnterpriseCache
コマンドレットについてのヘルプを確認するには、次のように入力します。
Get-Help New-AzRedisEnterpriseCache -Detailed
他のクラウドに接続する方法
既定では、Azure 環境はグローバル Azure クラウド インスタンスを表す AzureCloud
です。 別のインスタンスに接続するには、Connect-AzAccount
コマンドと -Environment
または -EnvironmentName
コマンド ライン スイッチを使用し、必要な環境または環境名を指定します。
利用可能な環境の一覧を表示するには、 Get-AzEnvironment
コマンドレットを実行します。
Azure Government Cloud に接続するには
Azure Government Cloud に接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureUSGovernment
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureUSGovernment)
Azure Government Cloud でキャッシュを作成するには、次のいずれかの場所を使用します。
- USGov バージニア州
- USGov アイオワ州
Azure Government Cloud の詳細については、「Microsoft Azure Government」と「Microsoft Azure Government 開発者向けガイド」をご覧ください。
21Vianet によって運営される Microsoft Azure クラウドに接続するには
21Vianet によって運営される Azure クラウドに接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureChinaCloud
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureChinaCloud)
21Vianet によって運営される Azure クラウドでキャッシュを作成するには、次のいずれかの場所を使用します。
- 中国東部
- 中国北部
Microsoft Azure Germany に接続するには
Microsoft Azure Germany に接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureGermanCloud
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureGermanCloud)
Microsoft Azure Germany でキャッシュを作成するには、次のいずれかの場所を使用します。
- ドイツ中部
- ドイツ北東部
Microsoft Azure Germany の詳細については、「Microsoft Azure Germany」を参照してください。
Azure Managed Redis PowerShell のパラメーターとプロパティ
すべての Azure Managed Redis PowerShell パラメーターとプロパティの一覧については、「New-AzRedisEnterpriseCache」を参照してください。
Azure Managed Redis を作成するには
Azure Managed インスタンスを新規作成するには、New-AzRedisEnterpriseCache コマンドレットを使用します。
重要
Azure portal を使用してサブスクリプションに初めて Azure Managed Redis を作成すると、そのサブスクリプションの Microsoft.Cache
名前空間がポータルにより登録されます。 PowerShell を使用してサブスクリプションに最初の Azure Managed Redis を作成する場合は、先に次のコマンドを使用して名前空間を登録する必要があります。これを実行しないと、New-AzRedisEnterpriseCache
や Get-AzRedisEnterpriseCache
などのコマンドレットが失敗します。
Register-AzResourceProvider -ProviderNamespace "Microsoft.Cache"
New-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help New-AzRedisEnterpriseCache -detailed
NAME
New-AzRedisEnterpriseCache
SYNOPSIS
Creates a new Azure Managed Redis.
SYNTAX
New-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> -Location <String> [-RedisVersion <String>]
[-Sku <String>] [-MaxMemoryPolicy <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort
<Boolean>] [-ShardCount <Integer>] [-VirtualNetwork <String>] [-Subnet <String>] [-StaticIP <String>]
[<CommonParameters>]
DESCRIPTION
The New-AzRedisEnterpriseCache cmdlet creates a new Azure Managed Redis.
PARAMETERS
-Name <String>
Name of the Azure Managed Redis to create.
-ResourceGroupName <String>
Name of resource group in which to create the Azure Managed Redis.
-Location <String>
Location in which to create the Azure Managed Redis.
-RedisVersion <String>
RedisVersion is deprecated and will be removed in future release.
-Sku <String>
Sku of Azure Managed Redis.
-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 Managed Redis. 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 Cluster Cache.
-VirtualNetwork <String>
The exact ARM resource ID of the virtual network to deploy the Azure Managed Redis in. Example format: /subscriptions/{
subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.ClassicNetwork/VirtualNetworks/{vnetName}
-Subnet <String>
Required when deploying an Azure Managed Redis inside an existing Azure Virtual Network.
-StaticIP <String>
Required when deploying an Azure Managed Redis 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
既定のパラメーターを使用してキャッシュを作成するには、次のコマンドを実行します。
New-AzRedisEnterpriseCache -ResourceGroupName myGroup -Name mycache -Location "North Central US"
ResourceGroupName
、Name
、Location
は必須のパラメーターですが、残りのものは省略可能で、それぞれに既定値があります。 前述のコマンドを実行すると、指定された名前、場所、およびリソース グループで Azure Managed Redis インスタンスが作成されます。 インスタンスのサイズは 1 GB で、SSL 以外のポートは無効になっています。
クラスタリングを有効にする場合は、ShardCount
パラメーターを使用してシャード数を指定します。
RedisConfiguration
の値を指定する場合は、@{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}
のように、キー/値のペアとして値を {}
で囲みます。 次の例では、allkeys-random
に設定された maxmemory ポリシーと KEA
に設定されたキースペース通知を使用して、1 GB のキャッシュを作成しています。 詳細については、「キースペース通知 (詳細設定)」および「メモリ ポリシー」をご覧ください。
New-AzRedisEnterpriseCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}
キャッシュの作成時にデータベースの設定を構成するには
databases
の設定は、キャッシュの作成中にのみ構成することができます。 次の例では、New-AzRedisEnterpriseCache コマンドレットを使用して、48 のデータベースを持つキャッシュを作成します。
New-AzRedisEnterpriseCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -Sku B1 -RedisConfiguration @{"databases" = "48"}
databases
プロパティの詳細については、既定の Azure Managed Redis サーバー構成に関するページをご覧ください。 New-AzRedisEnterpriseCache コマンドレットを使用してキャッシュを作成する方法の詳細については、上記の「Azure Managed Redis を作成するには」のセクションをご覧ください。
Azure Managed Redis を更新するには
Azure Managed Redis インスタンスは、[Set-AzRedisEnterpriseCache] コマンドレットを使用して更新されます。
Set-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Set-AzRedisEnterpriseCache -detailed
NAME
Set-AzRedisEnterpriseCache
SYNOPSIS
Set Azure Managed Redis updatable parameters.
SYNTAX
Set-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> [-Sku <String>]
[-MaxMemoryPolicy <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-ShardCount
<Integer>] [<CommonParameters>]
DESCRIPTION
The Set-AzRedisEnterpriseCache cmdlet sets Azure Managed Redis parameters.
PARAMETERS
-Name <String>
Name of the Azure Managed Redis to update.
-ResourceGroupName <String>
Name of the resource group for the cache.
-Sku <String>
Sku of Azure Managed Redis.
-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 Managed Redis. 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 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
Set-AzRedisEnterpriseCache
コマンドレットを使用して、Sku
、EnableNonSslPort
、RedisConfiguration
の値などのプロパティを更新できます。
次のコマンドを実行すると、myCache という名前の Azure Managed Redis の maxmemory-policy が更新されます。
Set-AzRedisEnterpriseCache -ResourceGroupName "myGroup" -Name "myCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"}
Azure Managed Redis に関する情報を取得するには
Get-AzRedisEnterpriseCache コマンドレットを使用してキャッシュに関する情報を取得できます。
Get-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Get-AzRedisEnterpriseCache -detailed
NAME
Get-AzRedisEnterpriseCache
SYNOPSIS
Gets details about a single cache or all caches in the specified resource group or all caches in the current
subscription.
SYNTAX
Get-AzRedisEnterpriseCache [-Name <String>] [-ResourceGroupName <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzRedisEnterpriseCache cmdlet gets the details about a cache or caches depending on input parameters. If both
ResourceGroupName and Name parameters are provided then Get-AzRedisEnterpriseCache 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-AzRedisEnterpriseCache
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-AzRedisEnterpriseCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
現在のサブスクリプションのすべてのキャッシュに関する情報を取得するには、パラメーターを指定せずに Get-AzRedisEnterpriseCache
を実行します。
Get-AzRedisEnterpriseCache
特定のリソース グループのすべてのキャッシュに関する情報を取得するには、ResourceGroupName
パラメーターを指定して Get-AzRedisEnterpriseCache
を実行します。
Get-AzRedisEnterpriseCache -ResourceGroupName myGroup
特定のキャッシュに関する情報を取得するには、キャッシュの名前を Name
パラメーターに設定し、そのキャッシュが含まれているリソース グループを ResourceGroupName
パラメーターに設定して、Get-AzRedisEnterpriseCache
を実行します。
PS C:\> Get-AzRedisEnterpriseCache -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 : 10000
ProvisioningState : Succeeded
SslPort : 6380
RedisConfiguration : {[maxmemory-policy, volatile-lru], [maxmemory-reserved, 62], [notify-keyspace-events, KEA],
[maxclients, 1000]...}
EnableNonSslPort : False
RedisVersion : 3.0
Sku : B1
ResourceGroupName : myGroup
VirtualNetwork :
Subnet :
StaticIP :
TenantSettings : {}
ShardCount :
Azure Managed Redis のアクセス キーを取得するには
キャッシュのアクセス キーを取得するには、Get-AzRedisEnterpriseCacheKey コマンドレットを使用します。
Get-AzRedisEnterpriseCacheKey
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Get-AzRedisEnterpriseCacheKey -detailed
NAME
Get-AzRedisEnterpriseCacheKey
SYNOPSIS
Gets the accesskeys for the specified Azure Managed Redis.
SYNTAX
Get-AzRedisEnterpriseCacheKey -Name <String> -ResourceGroupName <String> [<CommonParameters>]
DESCRIPTION
The Get-AzRedisEnterpriseCacheKey cmdlet gets the access keys for the specified cache.
PARAMETERS
-Name <String>
Name of the Azure Managed Redis.
-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 (https://go.microsoft.com/fwlink/?LinkID=113216).
キャッシュのキーを取得するには、 Get-AzRedisEnterpriseCacheKey
コマンドレットを呼び出し、キャッシュの名前と、そのキャッシュが含まれているリソース グループの名前を渡します。
PS C:\> Get-AzRedisEnterpriseCacheKey -Name myCache -ResourceGroupName myGroup
PrimaryKey : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : ABhfB757JgjIgt785JgKH9865eifmekfnn649303JKL=
Azure Managed Redis インスタンスのアクセス キーを生成するには
キャッシュのアクセス キーを再生成するには、New-AzRedisEnterpriseCacheKey コマンドレットを使用します。
New-AzRedisEnterpriseCacheKey
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help New-AzRedisEnterpriseCacheKey -detailed
NAME
New-AzRedisEnterpriseCacheKey
SYNOPSIS
Regenerates the access key of an Azure Managed Redis.
SYNTAX
New-AzRedisEnterpriseCacheKey -Name <String> -ResourceGroupName <String> -KeyType <String> [-Force] [<CommonParameters>]
DESCRIPTION
The New-AzRedisEnterpriseCacheKey cmdlet regenerate the access key of an Azure Managed Redis.
PARAMETERS
-Name <String>
Name of the Azure Managed Redis.
-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 (https://go.microsoft.com/fwlink/?LinkID=113216).
キャッシュのプライマリ キーまたはセカンダリ キーを再生成するには、New-AzRedisEnterpriseCacheKey
コマンドレットを呼び出し、名前とリソース グループを渡して、KeyType
パラメーターに Primary
または Secondary
を指定します。 次の例では、キャッシュのセカンダリ アクセス キーが再生成されます。
PS C:\> New-AzRedisEnterpriseCacheKey -Name myCache -ResourceGroupName myGroup -KeyType Secondary
Confirm
Are you sure you want to regenerate Secondary key for Azure Managed Redis 'myCache'?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
PrimaryKey : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : c53hj3kh4jhHjPJk8l0jji785JgKH9865eifmekfnn6=
Azure Managed Redis を削除するには
Azure Managed Redis を削除するには、Remove-AzRedisEnterpriseCache コマンドレットを使用します。
Remove-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Remove-AzRedisEnterpriseCache -detailed
NAME
Remove-AzRedisEnterpriseCache
SYNOPSIS
Remove Azure Managed Redis if exists.
SYNTAX
Remove-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [<CommonParameters>
DESCRIPTION
The Remove-AzRedisEnterpriseCache cmdlet removes an Azure Managed Redis if it exists.
PARAMETERS
-Name <String>
Name of the Azure Managed Redis 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-AzRedisEnterpriseCache removes the cache and does not return any value. If the PassThru par
is provided then Remove-AzRedisEnterpriseCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次の例では、 myCache
という名前のキャッシュが削除されます。
PS C:\> Remove-AzRedisEnterpriseCache -Name myCache -ResourceGroupName myGroup
Confirm
Are you sure you want to remove Azure Managed Redis 'myCache'?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
Azure Managed Redis をインポートするには
Azure Managed Redis インスタンスにデータをインポートするには、Import-AzRedisEnterpriseCache
コマンドレットを使用します。
Import-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Import-AzRedisEnterpriseCache -detailed
NAME
Import-AzRedisEnterpriseCache
SYNOPSIS
Import data from blobs to Azure Managed Redis.
SYNTAX
Import-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> -Files <String[]> [-Format <String>] [-Force]
[-PassThru] [<CommonParameters>]
DESCRIPTION
The Import-AzRedisEnterpriseCache cmdlet imports data from the specified blobs into Azure Managed Redis.
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-AzRedisEnterpriseCache imports data in cache and does not return any value. If the PassThru
parameter is provided then Import-AzRedisEnterpriseCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、SAS URI で指定された BLOB から Azure Managed Redis にデータをインポートします。
PS C:\>Import-AzRedisEnterpriseCache -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
Azure Managed Redis をエクスポートするには
Azure Managed Redis インスタンスからデータをエクスポートするには、Export-AzRedisEnterpriseCache
コマンドレットを使用します。
Export-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Export-AzRedisEnterpriseCache -detailed
NAME
Export-AzRedisEnterpriseCache
SYNOPSIS
Exports data from Azure Managed Redis to a specified container.
SYNTAX
Export-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> -Prefix <String> -Container <String> [-Format
<String>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Export-AzRedisEnterpriseCache cmdlet exports data from Azure Managed Redis 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-AzRedisEnterpriseCache does not return any value. If the PassThru parameter is provided
then Export-AzRedisEnterpriseCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、Azure Managed Redis インスタンスから、SAS URI で指定されたコンテナーにデータをエクスポートします。
PS C:\>Export-AzRedisEnterpriseCache -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"
Azure Managed Redis を再起動するには (プレビュー)
Azure Managed Redis (プレビュー) インスタンスを再起動するには、Reset-AzRedisEnterpriseCache
コマンドレットを使用します。
Reset-AzRedisEnterpriseCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Reset-AzRedisEnterpriseCache -detailed
NAME
Reset-AzRedisEnterpriseCache
SYNOPSIS
Reboot specified node(s) of an Azure Managed Redis instance.
SYNTAX
Reset-AzRedisEnterpriseCache -Name <String> -ResourceGroupName <String> -RebootType <String> [-ShardId <Integer>]
[-Force] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Reset-AzRedisEnterpriseCache cmdlet reboots the specified node(s) of an Azure Managed Redis 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 cache with clustering enabled.
-Force
When the Force parameter is provided, reset will be performed without any confirmation prompts.
-PassThru
By default Reset-AzRedisEnterpriseCache does not return any value. If the PassThru parameter is provided
then Reset-AzRedisEnterpriseCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、指定されたキャッシュの両方のノードを再起動します。
PS C:\>Reset-AzRedisEnterpriseCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -RebootType "AllNodes"
-Force
Note
Azure には、リソースの作成と操作に使用できる、Azure Resource Manager およびクラシックという 2 つの異なるデプロイ モデルがあります。 この記事では、Resource Manager デプロイ モデルの使用について説明します。 新しいデプロイには、クラシック デプロイ モデルではなく、Resource Manager デプロイ モデルをお勧めします。
クラシック デプロイ モデルについて詳しくは、「Azure Resource Manager とクラシック デプロイ: デプロイ モデルとリソースの状態について」を参照してください。
前提条件
Azure PowerShell をインストール済みである場合、Azure PowerShell Version 1.0.0 以降であることが必要です。 Azure PowerShell のバージョンは、Azure PowerShell コマンド プロンプトでこのコマンドを使用して確認できます。
Get-Module Az | format-table version
まず、このコマンドで Azure にサインインする必要があります。
Connect-AzAccount
Microsoft Azure のサインイン ダイアログで、Azure アカウントの電子メール アドレスとご自分のパスワードを指定します。
次に、Azure サブスクリプションが複数ある場合は、使用する Azure サブスクリプションを設定する必要があります。 現在のサブスクリプションを一覧表示するには、次のコマンドを実行します。
Get-AzSubscription | sort SubscriptionName | Select SubscriptionName
サブスクリプションを指定するには、次のコマンドを実行します。 次の例では、サブスクリプション名は ContosoSubscription
です。
Select-AzSubscription -SubscriptionName ContosoSubscription
Azure Resource Manager で Windows PowerShell を使用する前に、設定を確認する必要があります。
- Windows PowerShell バージョン 3.0 または 4.0。 Windows PowerShell のバージョンを調べるには、
$PSVersionTable
と入力して、PSVersion
の値が 3.0 か 4.0 かを確認します。 互換バージョンをインストールするには、「Windows Management Framework 3.0」を参照してください。
このチュートリアルに表示されているコマンドレットの詳しいヘルプを確認には、Get-Help コマンドレットを使用します。
Get-Help <cmdlet-name> -Detailed
たとえば、 New-AzRedisCache
コマンドレットについてのヘルプを確認するには、次のように入力します。
Get-Help New-AzRedisCache -Detailed
他のクラウドに接続する方法
既定では、Azure 環境はグローバル Azure クラウド インスタンスを表す AzureCloud
です。 別のインスタンスに接続するには、Connect-AzAccount
コマンドと -Environment
または -EnvironmentName
コマンド ライン スイッチを使用し、必要な環境または環境名を指定します。
利用可能な環境の一覧を表示するには、 Get-AzEnvironment
コマンドレットを実行します。
Azure Government Cloud に接続するには
Azure Government Cloud に接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureUSGovernment
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureUSGovernment)
Azure Government Cloud でキャッシュを作成するには、次のいずれかの場所を使用します。
- USGov バージニア州
- USGov アイオワ州
Azure Government Cloud の詳細については、「Microsoft Azure Government」と「Microsoft Azure Government 開発者向けガイド」をご覧ください。
21Vianet によって運営される Microsoft Azure クラウドに接続するには
21Vianet によって運営される Azure クラウドに接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureChinaCloud
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureChinaCloud)
21Vianet によって運営される Azure クラウドでキャッシュを作成するには、次のいずれかの場所を使用します。
- 中国東部
- 中国北部
Microsoft Azure Germany に接続するには
Microsoft Azure Germany に接続するには、次のいずれかのコマンドを使用します。
Connect-AzAccount -EnvironmentName AzureGermanCloud
または
Connect-AzAccount -Environment (Get-AzEnvironment -Name AzureGermanCloud)
Microsoft Azure Germany でキャッシュを作成するには、次のいずれかの場所を使用します。
- ドイツ中部
- ドイツ北東部
Microsoft Azure Germany の詳細については、「Microsoft Azure Germany」を参照してください。
Azure Cache for Redis 用の PowerShell で使用されるプロパティ
次の表には、Azure Cache for Redis インスタンスを作成し、管理する場合の一般的なパラメーターの Azure PowerShell プロパティと説明が含まれています。
パラメーター | 説明 | Default |
---|---|---|
Name | キャッシュの名前 | |
Location | キャッシュの場所 | |
ResourceGroupName | キャッシュを作成するリソース グループの名前 | |
Size | キャッシュのサイズ。 有効な値: P1、P2、P3、P4、P5、C0、C1、C2、C3、C4、C5、C6、250 MB、1 GB、2.5 GB、6 GB、13 GB、26 GB、53 GB | 1GB |
ShardCount | クラスタリングが有効になっている Premium キャッシュを作成するときに作成するシャードの数。 有効な値: 1、2、3、4、5、6、7、8、9、10 | |
SKU | キャッシュの SKU を指定します。 有効な値: Basic、Standard、Premium | Standard |
RedisConfiguration | Redis 構成の設定を指定します。 各設定の詳細については、次の「 RedisConfiguration プロパティ 」の表をご覧ください。 | |
EnableNonSslPort | 非 SSL ポートが有効になっているかどうかを示します。 | False |
MaxMemoryPolicy | このパラメーターは非推奨となりました。代わりに、RedisConfiguration を使用します。 | |
StaticIP | VNET でキャッシュをホストする場合に、キャッシュのサブネットで一意の IP アドレスを指定します。 指定していない場合、サブネットから自動的にアドレスが 1 つ選択されます。 | |
Subnet | VNET でキャッシュをホストする場合に、キャッシュをデプロイするサブネットの名前を指定します。 | |
VirtualNetwork | VNET でキャッシュをホストする場合に、キャッシュをデプロイする VNET のリソース ID を指定します。 | |
KeyType | アクセス キーを更新するときに再生成するアクセス キーを指定します。 有効な値: Primary、Secondary |
RedisConfiguration プロパティ
プロパティ | 説明 | 価格レベル |
---|---|---|
rdb-backup-enabled | Redis データ永続化 が有効かどうか。 | Premium のみ |
rdb-storage-connection-string | Redis データ永続化 | Premium のみ |
rdb-backup-frequency | Redis データ永続化 | Premium のみ |
maxmemory-reserved | キャッシュ以外のプロセスに 予約済みのメモリ を構成する | Standard と Premium |
maxmemory-policy | キャッシュに 削除ポリシー を構成する | すべての価格レベル |
notify-keyspace-events | キースペース通知 | Standard と Premium |
hash-max-ziplist-entries | 小規模の集計データの種類に メモリ最適化 を構成する | Standard と Premium |
hash-max-ziplist-value | 小規模の集計データの種類に メモリ最適化 を構成する | Standard と Premium |
set-max-intset-entries | 小規模の集計データの種類に メモリ最適化 を構成する | Standard と Premium |
zset-max-ziplist-entries | 小規模の集計データの種類に メモリ最適化 を構成する | Standard と Premium |
zset-max-ziplist-value | 小規模の集計データの種類に メモリ最適化 を構成する | Standard と Premium |
databases | データベースの数を構成する。 このプロパティは、キャッシュの作成時にのみ構成できます。 | Standard と Premium |
Azure Cache for Redis を作成するには
Azure Cache for Redis インスタンスを新規作成するには、New-AzRedisCache コマンドレットを使用します。
重要
Azure portal を使用してサブスクリプションに初めて Azure Cache for Redis を作成すると、そのサブスクリプションの Microsoft.Cache
名前空間がポータルにより登録されます。 PowerShell を使用してサブスクリプションに最初の Azure Cache for Redis を作成する場合は、先に次のコマンドを使用して名前空間を登録する必要があります。これを実行しないと、New-AzRedisCache
や Get-AzRedisCache
などのコマンドレットが失敗します。
Register-AzResourceProvider -ProviderNamespace "Microsoft.Cache"
New-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help New-AzRedisCache -detailed
NAME
New-AzRedisCache
SYNOPSIS
Creates a new Azure Cache for Redis.
SYNTAX
New-AzRedisCache -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-AzRedisCache cmdlet creates a new Azure Cache for Redis.
PARAMETERS
-Name <String>
Name of the Azure Cache for Redis to create.
-ResourceGroupName <String>
Name of resource group in which to create the Azure Cache for Redis.
-Location <String>
Location in which to create the Azure Cache for Redis.
-RedisVersion <String>
RedisVersion is deprecated and will be removed in future release.
-Size <String>
Size of the Azure Cache for Redis. 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 Azure Cache for Redis. 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 Cache for Redis. 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 Azure Cache for Redis in. Example format: /subscriptions/{
subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.ClassicNetwork/VirtualNetworks/{vnetName}
-Subnet <String>
Required when deploying an Azure Cache for Redis inside an existing Azure Virtual Network.
-StaticIP <String>
Required when deploying an Azure Cache for Redis 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
既定のパラメーターを使用してキャッシュを作成するには、次のコマンドを実行します。
New-AzRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US"
ResourceGroupName
、Name
、Location
は必須のパラメーターですが、残りのものは省略可能で、それぞれに既定値があります。 前述のコマンドを実行すると、指定された名前、場所、およびリソース グループで Standard SKU の Azure Cache for Redis インスタンスが作成されます。 インスタンスのサイズは 1 GB で、SSL 以外のポートは無効になっています。
Premium キャッシュを作成する場合は、P1 (6 GB ~ 60 GB)、P2 (13 GB ~ 130 GB)、P3 (26 GB ~ 260 GB)、P4 (53 GB ~ 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
RedisConfiguration
の値を指定する場合は、@{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}
のように、キー/値のペアとして値を {}
で囲みます。 次の例では、allkeys-random
に設定された maxmemory ポリシーと KEA
に設定されたキースペース通知を使用して、Standard の 1 GB のキャッシュを作成しています。 詳細については、「キースペース通知 (詳細設定)」および「メモリ ポリシー」をご覧ください。
New-AzRedisCache -ResourceGroupName myGroup -Name mycache -Location "North Central US" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random", "notify-keyspace-events" = "KEA"}
キャッシュの作成時にデータベースの設定を構成するには
databases
の設定は、キャッシュの作成中にのみ構成することができます。 次の例では、New-AzRedisCache コマンドレットを使用して、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 サーバー構成) をご覧ください。 New-AzRedisCache コマンドレットを使用してキャッシュを作成する方法の詳細については、上記の「Azure Cache for Redis を作成するには」のセクションをご覧ください。
Azure Cache for Redis を更新するには
Azure Cache for Redis インスタンスを更新するには、Set-AzRedisCache コマンドレットを使用します。
Set-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Set-AzRedisCache -detailed
NAME
Set-AzRedisCache
SYNOPSIS
Set Azure Cache for Redis updatable parameters.
SYNTAX
Set-AzRedisCache -Name <String> -ResourceGroupName <String> [-Size <String>] [-Sku <String>]
[-MaxMemoryPolicy <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-ShardCount
<Integer>] [<CommonParameters>]
DESCRIPTION
The Set-AzRedisCache cmdlet sets Azure Cache for Redis parameters.
PARAMETERS
-Name <String>
Name of the Azure Cache for Redis to update.
-ResourceGroupName <String>
Name of the resource group for the cache.
-Size <String>
Size of the Azure Cache for Redis. 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 Azure Cache for Redis. 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 Cache for Redis. 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
Set-AzRedisCache
コマンドレットを使用して、Size
、Sku
、EnableNonSslPort
、RedisConfiguration
の値などのプロパティを更新できます。
次のコマンドを実行すると、myCache という名前の Azure Cache for Redis の maxmemory-policy が更新されます。
Set-AzRedisCache -ResourceGroupName "myGroup" -Name "myCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"}
Azure Cache for Redis をスケーリングするには
Size
、Sku
、または ShardCount
のプロパティが変更されたときに、Set-AzRedisCache
を使用して、Azure Cache for Redis インスタンスをスケーリングできます。
Note
PowerShell を使用してキャッシュをスケールする場合、Azure ポータルからキャッシュをスケールする場合と同じ制限とガイドラインが適用されます。 別の価格レベルにスケーリングできますが、次のような制約があります。
- 上位の価格レベルから下位の価格レベルにスケーリングすることはできません。
- Premium キャッシュから Standard または Basic キャッシュにスケールすることはできません。
- Standard キャッシュから Basic キャッシュにスケールすることはできません。
- Basic キャッシュから Standard キャッシュにスケールすることはできますが、同時にサイズを変更することはできません。 サイズを変更する必要がある場合、後続のスケーリング操作でサイズを変更できます。
- Basic キャッシュから直接 Premium キャッシュにスケールすることはできません。 1 回のスケーリング操作で Basic から Standard にスケールし、その後の操作で Standard から Premium にスケールする必要があります。
- C0 (250 MB) サイズにそれより大きなサイズからスケールダウンすることはできません。
詳細については、「How to Scale Azure Cache for Redis」 (Azure Cache for Redis のスケーリング方法) をご覧ください。
次の例は、myCache
という名前のキャッシュを 2.5 GB のキャッシュにスケーリングする方法を示しています。 このコマンドは、Basic と Standard の両方のキャッシュで使用できます。
Set-AzRedisCache -ResourceGroupName myGroup -Name myCache -Size 2.5GB
このコマンドが発行された後、キャッシュの状態が返されます (Get-AzRedisCache
の呼び出しと同様)。 ProvisioningState
に Scaling
が設定されています。
PS C:\> Set-AzRedisCache -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 :
スケーリング処理が完了すると、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 についての情報を取得するには
Get-AzRedisCache コマンドレットを使用してキャッシュに関する情報を取得できます。
Get-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Get-AzRedisCache -detailed
NAME
Get-AzRedisCache
SYNOPSIS
Gets details about a single cache or all caches in the specified resource group or all caches in the current
subscription.
SYNTAX
Get-AzRedisCache [-Name <String>] [-ResourceGroupName <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzRedisCache cmdlet gets the details about a cache or caches depending on input parameters. If both
ResourceGroupName and Name parameters are provided then Get-AzRedisCache 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-AzRedisCache
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-AzRedisCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
現在のサブスクリプションのすべてのキャッシュに関する情報を取得するには、パラメーターを指定せずに Get-AzRedisCache
を実行します。
Get-AzRedisCache
特定のリソース グループのすべてのキャッシュに関する情報を取得するには、ResourceGroupName
パラメーターを指定して Get-AzRedisCache
を実行します。
Get-AzRedisCache -ResourceGroupName myGroup
特定のキャッシュに関する情報を取得するには、キャッシュの名前を Name
パラメーターに設定し、そのキャッシュが含まれているリソース グループを ResourceGroupName
パラメーターに設定して、Get-AzRedisCache
を実行します。
PS C:\> Get-AzRedisCache -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 :
Azure Cache for Redis インスタンスのアクセス キーを取得するには
キャッシュのアクセス キーを取得するには、 Get-AzRedisCacheKey コマンドレットを使用します。
Get-AzRedisCacheKey
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Get-AzRedisCacheKey -detailed
NAME
Get-AzRedisCacheKey
SYNOPSIS
Gets the accesskeys for the specified Azure Cache for Redis.
SYNTAX
Get-AzRedisCacheKey -Name <String> -ResourceGroupName <String> [<CommonParameters>]
DESCRIPTION
The Get-AzRedisCacheKey cmdlet gets the access keys for the specified cache.
PARAMETERS
-Name <String>
Name of the Azure Cache for Redis.
-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 (https://go.microsoft.com/fwlink/?LinkID=113216).
キャッシュのキーを取得するには、 Get-AzRedisCacheKey
コマンドレットを呼び出し、キャッシュの名前と、そのキャッシュが含まれているリソース グループの名前を渡します。
PS C:\> Get-AzRedisCacheKey -Name myCache -ResourceGroupName myGroup
PrimaryKey : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : ABhfB757JgjIgt785JgKH9865eifmekfnn649303JKL=
Azure Cache for Redis インスタンスのアクセス キーを生成するには
キャッシュのアクセス キーを再生成するには、 New-AzRedisCacheKey コマンドレットを使用します。
New-AzRedisCacheKey
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help New-AzRedisCacheKey -detailed
NAME
New-AzRedisCacheKey
SYNOPSIS
Regenerates the access key of an Azure Cache for Redis.
SYNTAX
New-AzRedisCacheKey -Name <String> -ResourceGroupName <String> -KeyType <String> [-Force] [<CommonParameters>]
DESCRIPTION
The New-AzRedisCacheKey cmdlet regenerate the access key of an Azure Cache for Redis.
PARAMETERS
-Name <String>
Name of the Azure Cache for Redis.
-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 (https://go.microsoft.com/fwlink/?LinkID=113216).
キャッシュのプライマリ キーまたはセカンダリ キーを再生成するには、New-AzRedisCacheKey
コマンドレットを呼び出し、名前とリソース グループを渡して、KeyType
パラメーターに Primary
または Secondary
を指定します。 次の例では、キャッシュのセカンダリ アクセス キーが再生成されます。
PS C:\> New-AzRedisCacheKey -Name myCache -ResourceGroupName myGroup -KeyType Secondary
Confirm
Are you sure you want to regenerate Secondary key for Azure Cache for Redis 'myCache'?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
PrimaryKey : b2wdt43sfetlju4hfbryfnregrd9wgIcc6IA3zAO1lY=
SecondaryKey : c53hj3kh4jhHjPJk8l0jji785JgKH9865eifmekfnn6=
Azure Cache for Redis を削除するには
Azure Cache for Redis を削除するには、Remove-AzRedisCache コマンドレットを使用します。
Remove-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Remove-AzRedisCache -detailed
NAME
Remove-AzRedisCache
SYNOPSIS
Remove Azure Cache for Redis if exists.
SYNTAX
Remove-AzRedisCache -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [<CommonParameters>
DESCRIPTION
The Remove-AzRedisCache cmdlet removes an Azure Cache for Redis if it exists.
PARAMETERS
-Name <String>
Name of the Azure Cache for Redis 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-AzRedisCache removes the cache and does not return any value. If the PassThru par
is provided then Remove-AzRedisCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次の例では、 myCache
という名前のキャッシュが削除されます。
PS C:\> Remove-AzRedisCache -Name myCache -ResourceGroupName myGroup
Confirm
Are you sure you want to remove Azure Cache for Redis 'myCache'?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
Azure Cache for Redis をインポートするには
Azure Cache for Redis インスタンスにデータをインポートするには、Import-AzRedisCache
コマンドレットを使用します。
重要
Import/Export は、Premium レベルのキャッシュでのみ使用できます。 インポート/エクスポートの詳細については、「Import and Export data in Azure Cache for Redis」 (Azure Cache for Redis でデータをインポートおよびエクスポートする) をご覧ください。
Import-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Import-AzRedisCache -detailed
NAME
Import-AzRedisCache
SYNOPSIS
Import data from blobs to Azure Cache for Redis.
SYNTAX
Import-AzRedisCache -Name <String> -ResourceGroupName <String> -Files <String[]> [-Format <String>] [-Force]
[-PassThru] [<CommonParameters>]
DESCRIPTION
The Import-AzRedisCache cmdlet imports data from the specified blobs into Azure Cache for Redis.
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-AzRedisCache imports data in cache and does not return any value. If the PassThru
parameter is provided then Import-AzRedisCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、SAS URI で指定された BLOB から Azure Cache for Redis にデータをインポートします。
PS C:\>Import-AzRedisCache -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
Azure Cache for Redis をエクスポートするには
Azure Cache for Redis インスタンスからデータをエクスポートするには、Export-AzRedisCache
コマンドレットを使用します。
重要
Import/Export は、Premium レベルのキャッシュでのみ使用できます。 インポート/エクスポートの詳細については、「Import and Export data in Azure Cache for Redis」 (Azure Cache for Redis でデータをインポートおよびエクスポートする) をご覧ください。
Export-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Export-AzRedisCache -detailed
NAME
Export-AzRedisCache
SYNOPSIS
Exports data from Azure Cache for Redis to a specified container.
SYNTAX
Export-AzRedisCache -Name <String> -ResourceGroupName <String> -Prefix <String> -Container <String> [-Format
<String>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Export-AzRedisCache cmdlet exports data from Azure Cache for Redis 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-AzRedisCache does not return any value. If the PassThru parameter is provided
then Export-AzRedisCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、Azure Cache for Redis インスタンスから、SAS URI で指定されたコンテナーにデータをエクスポートします。
PS C:\>Export-AzRedisCache -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"
Azure Cache for Redis を再起動するには
Azure Cache for Redis インスタンスを再起動するには、Reset-AzRedisCache
コマンドレットを使用します。
重要
再起動は、Basic、Standard、Premium レベルのキャッシュでのみ使用できます。 キャッシュの再起動の詳細については、 キャッシュ管理 - 再起動に関するセクションをご覧ください。
Reset-AzRedisCache
で使用可能なパラメーターとその説明の一覧を表示するには、次のコマンドを実行します。
PS C:\> Get-Help Reset-AzRedisCache -detailed
NAME
Reset-AzRedisCache
SYNOPSIS
Reboot specified node(s) of an Azure Cache for Redis instance.
SYNTAX
Reset-AzRedisCache -Name <String> -ResourceGroupName <String> -RebootType <String> [-ShardId <Integer>]
[-Force] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Reset-AzRedisCache cmdlet reboots the specified node(s) of an Azure Cache for Redis 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-AzRedisCache does not return any value. If the PassThru parameter is provided
then Reset-AzRedisCache 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 (https://go.microsoft.com/fwlink/?LinkID=113216).
次のコマンドは、指定されたキャッシュの両方のノードを再起動します。
PS C:\>Reset-AzRedisCache -ResourceGroupName "resourceGroupName" -Name "cacheName" -RebootType "AllNodes"
-Force
次のステップ
Azure での Windows PowerShell の使用の詳細については、次のリソースをご覧ください。
- MSDN 上の Azure Cache for Redis コマンドレットのドキュメント
- Azure Resource Manager コマンドレットに関するページ: Azure Resource Manager モジュールのコマンドレットを使用する方法について説明します。
- リソース グループを使用した Azure リソースの管理: Azure ポータルでリソース グループを作成して管理する方法について説明します。
- Azure blog (Azure のブログ): Azure の新機能について説明します。
- Windows PowerShell blog (Windows PowerShell ブログ): Windows PowerShell の新機能について説明します。
- "Hey, Scripting Guy!" ブログ: 実践で使えるヒントとテクニックを Windows PowerShell コミュニティから得られます。