Add-AzKeyVaultManagedStorageAccount
Key Vault サービスによって管理されるキーの既存の Azure Storage アカウントを、指定したキー コンテナーに追加します。
構文
Add-AzKeyVaultManagedStorageAccount
[-VaultName] <String>
[-AccountName] <String>
[-AccountResourceId] <String>
[-ActiveKeyName] <String>
[-DisableAutoRegenerateKey]
[-RegenerationPeriod <TimeSpan>]
[-Disable]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Key Vault によって管理されるストレージ アカウント キー用に、Key Vault を使用して既存の Azure ストレージ アカウントを設定します。 ストレージ アカウントは既に存在している必要があります。 ストレージ キーが呼び出し元に公開されることはありません。 Key Vault では、再生成期間に基づいてアクティブなキーが自動的に再生成され、切り替わります。 この機能の概要については、「 Azure Key Vault マネージド ストレージ アカウント - PowerShell 」を参照してください。
例
例 1: Key Vault を使用して Azure Storage アカウントを設定し、そのキーを管理する
$storage = Get-AzStorageAccount -ResourceGroupName "mystorageResourceGroup" -StorageAccountName "mystorage"
$servicePrincipal = Get-AzADServicePrincipal -ServicePrincipalName cfa8b339-82a2-471a-a3c9-0fc0be7a4093
New-AzRoleAssignment -ObjectId $servicePrincipal.Id -RoleDefinitionName 'Storage Account Key Operator Service Role' -Scope $storage.Id
$userPrincipalId = $(Get-AzADUser -SearchString "developer@contoso.com").Id
Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ObjectId $userPrincipalId -PermissionsToStorage get, set
$regenerationPeriod = [System.Timespan]::FromDays(90)
Add-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount' -ActiveKeyName 'key1' -RegenerationPeriod $regenerationPeriod
Id : https://myvault.vault.azure.net:443/storage/mystorageaccount
Vault Name : myvault
AccountName : mystorageaccount
Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St
orage/storageAccounts/mystorageaccount
Active Key Name : key1
Auto Regenerate Key : True
Regeneration Period : 90.00:00:00
Enabled : True
Created : 5/21/2018 11:55:58 PM
Updated : 5/21/2018 11:55:58 PM
Tags :
Key Vault によって管理されるキーのストレージ アカウントを Key Vault に設定します。 アクティブなキー セットは 'key1' です。 このキーは、SAS トークンの生成に使用されます。 Key Vault は、このコマンドの時点からの再生成期間後に 'key2' キーを再生成し、アクティブ キーとして設定します。 この自動再生成プロセスは、'key1' と 'key2' の間で継続され、ギャップは 90 日です。
例 2: Key Vault を使用してクラシック Azure ストレージ アカウントを設定し、そのキーを管理する
$regenerationPeriod = [System.Timespan]::FromDays(90)
Add-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount' -ActiveKeyName 'Primary' -RegenerationPeriod $regenerationPeriod
Id : https://myvault.vault.azure.net:443/storage/mystorageaccount
Vault Name : myvault
AccountName : mystorageaccount
Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myvault/providers/Microsoft.Cl
assicStorage/storageAccounts/mystorageaccount
Active Key Name : Primary
Auto Regenerate Key : True
Regeneration Period : 90.00:00:00
Enabled : True
Created : 5/21/2018 11:55:58 PM
Updated : 5/21/2018 11:55:58 PM
Tags :
Key Vault によって管理されるキーのクラシック ストレージ アカウントを Key Vault に設定します。 アクティブなキー セットは 'Primary' です。 このキーは、SAS トークンの生成に使用されます。 Key Vault は、このコマンドの時点からの再生成期間の後に "セカンダリ" キーを再生成し、アクティブ キーとして設定します。 この自動再生成プロセスは、"プライマリ" と "セカンダリ" の間で継続され、ギャップは 90 日です。
パラメーター
-AccountName
Key Vault マネージド ストレージ アカウント名。 コマンドレットは、コンテナー名、現在選択されている環境、および管理されたストレージ アカウント名から、マネージド ストレージ アカウント名の FQDN を構築します。
型: | String |
Aliases: | StorageAccountName, Name |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AccountResourceId
ストレージ アカウントの Azure リソース ID。
型: | String |
Aliases: | StorageAccountResourceId |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ActiveKeyName
SAS トークンの生成に使用する必要があるストレージ アカウント キーの名前。
型: | String |
配置: | 3 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Disable
SAS トークンの生成にマネージド ストレージ アカウントのキーを使用できないようにします。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisableAutoRegenerateKey
キーを自動的に再生成します。 true の場合、マネージド ストレージ アカウントの非アクティブなキーは自動的に再生成され、再生成期間後に新しいアクティブ なキーになります。 false の場合、マネージド ストレージ アカウントのキーは自動再生成されません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RegenerationPeriod
再生成期間。 自動再生成キーが有効になっている場合、この値は、マネージド ストレージ アカウントの非アクティブなキーが自動的に再生成され、新しいアクティブ キーになる期間を指定します。
型: | Nullable<T>[TimeSpan] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
型: | Hashtable |
Aliases: | Tags |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-VaultName
コンテナー名。 コマンドレットは、名前と現在選択されている環境に基づいて、コンテナーの FQDN を構築します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[System.TimeSpan, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
出力
PSKeyVaultManagedStorageAccount
関連リンク
Azure PowerShell