Partager via

Add-AzureKeyVaultManagedStorageAccount

  • Référence
Module:
AzureRM.KeyVault

Ajoute un compte Stockage Azure existant au coffre de clés spécifié pour que ses clés soient gérées par le service Key Vault.

Avertissement

Le module AzureRM PowerShell a été officiellement déprécié le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Il est possible que le module AzureRM fonctionne encore, mais il ne fait plus l’objet de maintenance ni de support. L’utilisateur peut continuer à s’en servir s’il le souhaite, à ses propres risques. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

Add-AzureKeyVaultManagedStorageAccount
   [-VaultName] <String>
   [-AccountName] <String>
   [-AccountResourceId] <String>
   [-ActiveKeyName] <String>
   [-DisableAutoRegenerateKey]
   [-RegenerationPeriod <TimeSpan>]
   [-Disable]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Configure un compte de Stockage Azure existant avec Key Vault pour les clés de compte de stockage à gérer par Key Vault. Le compte de stockage doit déjà exister. Les clés de stockage ne sont jamais exposées à l’appelant. Key Vault régénère et change automatiquement la clé active en fonction de la période de régénération.

Exemples

Exemple 1 : Définir un compte Stockage Azure avec Key Vault pour gérer ses clés

PS C:\> $storage = Get-AzureRmStorageAccount -ResourceGroupName "mystorageResourceGroup" -StorageAccountName "mystorage"
PS C:\> $servicePrincipal = Get-AzureRmADServicePrincipal -ServicePrincipalName cfa8b339-82a2-471a-a3c9-0fc0be7a4093
PS C:\> New-AzureRmRoleAssignment -ObjectId $servicePrincipal.Id -RoleDefinitionName 'Storage Account Key Operator Service Role' -Scope $storage.Id
PS C:\> $userPrincipalId = $(Get-AzureRmADUser -SearchString "developer@contoso.com").Id
PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName $keyVaultName -ObjectId $userPrincipalId -PermissionsToStorage get, set
PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90)
PS C:\> Add-AzureKeyVaultManagedStorageAccount -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                :

Définit un compte de stockage avec Key Vault pour que ses clés soient gérées par Key Vault. Le jeu de clés actives est « key1 ». Cette clé sera utilisée pour générer des jetons sas. Key Vault régénère la clé « key2 » après la période de régénération de la commande et la définit comme clé active. Ce processus de régénération automatique continuera entre « key1 » et « key2 » avec un écart de 90 jours.

Exemple 2 : Définir un compte de Stockage Azure classique avec Key Vault pour gérer ses clés

PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90)
PS C:\> Add-AzureKeyVaultManagedStorageAccount -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                :

Définit un compte de stockage classique avec Key Vault pour que ses clés soient gérées par Key Vault. Le jeu de clés actives est « Primary ». Cette clé sera utilisée pour générer des jetons sas. Key Vault régénère la clé « Secondaire » après la période de régénération de la commande et la définit comme clé active. Ce processus de régénération automatique continuera entre « Primary » et « Secondary » avec un écart de 90 jours.

Paramètres

-AccountName

Nom du compte de stockage managé Key Vault. L’applet de commande construit le nom de domaine complet d’un nom de compte de stockage managé à partir du nom du coffre, de l’environnement actuellement sélectionné et du nom du compte de stockage géré.

Type:String
Alias:StorageAccountName, Name
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-AccountResourceId

ID de ressource Azure du compte de stockage.

Type:String
Alias:StorageAccountResourceId
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ActiveKeyName

Nom de la clé de compte de stockage qui doit être utilisée pour générer des jetons sas.

Type:String
Position:3
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Disable

Désactive l’utilisation de la clé du compte de stockage managé pour la génération de jetons sas.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DisableAutoRegenerateKey

Régénérer automatiquement la clé. Si la valeur est true, la clé inactive du compte de stockage managé est régénérée automatiquement et devient la nouvelle clé active après la période de régénération. Si la valeur est false, les clés du compte de stockage managé ne sont pas régénérées automatiquement.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RegenerationPeriod

Période de régénération. Si la clé de régénération automatique est activée, cette valeur spécifie l’intervalle de temps après lequel les keygets inactifs du compte de stockage managé sont régénérés automatiquement et devient la nouvelle clé active.

Type:Nullable<T>[TimeSpan]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Tag

Paires clé-valeur sous la forme d’une table de hachage. Par exemple : @{key0="value0 » ; key1=$null ; key2="value2"}

Type:Hashtable
Alias:Tags
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-VaultName

Nom du coffre. L’applet de commande construit le nom de domaine complet d’un coffre en fonction du nom et de l’environnement actuellement sélectionné.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Nullable<T>[[System.TimeSpan, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Hashtable

Sorties

PSKeyVaultManagedStorageAccount