Update-AzKeyVaultManagedHsm
Mettez à jour l’état d’un HSM managé Azure.
Syntaxe
Update-AzKeyVaultManagedHsm
-Name <String>
-ResourceGroupName <String>
[-EnablePurgeProtection]
[-PublicNetworkAccess <String>]
[-UserAssignedIdentity <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Update-AzKeyVaultManagedHsm
-InputObject <PSManagedHsm>
[-EnablePurgeProtection]
[-PublicNetworkAccess <String>]
[-UserAssignedIdentity <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Update-AzKeyVaultManagedHsm
-ResourceId <String>
[-EnablePurgeProtection]
[-PublicNetworkAccess <String>]
[-UserAssignedIdentity <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Description
Cette applet de commande met à jour l’état d’un HSM managé Azure.
Exemples
Exemple 1 : Mettre à jour un Hsm managé directement
Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -Tag @{testKey="testValue"} | Format-List
Managed HSM Name : testmhsm
Resource Group Name : testmhsm
Location : eastus2euap
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testmhsm/provid
ers/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI :
Tenant ID : xxxxxx-xxxx-xxxx-xxxxxxxxxxxx
Initial Admin Object Ids : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SKU : StandardB1
Soft Delete Enabled? : True
Enabled Purge Protection? : False
Soft Delete Retention Period (days) : 90
Provisioning State : Provisioning
Status Message : Resource creation in progress. Starting service...
Tags :
Name Value
==== =====
testKey testValued
Met à jour les balises du Hsm managé nommé $hsmName
dans le groupe de ressources $resourceGroupName
.
Exemple 2 : Mettre à jour un Hsm managé à l’aide de piping
Get-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName | Update-AzKeyVaultManagedHsm -Tag @{testKey="testValue"}
Met à jour des balises pour le Hsm managé à l’aide de la syntaxe de piping.
Exemple 3 : Activer la protection contre le vidage pour un Hsm managé
Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -EnablePurgeProtection | Format-List
Managed HSM Name : testmhsm
Resource Group Name : test-rg
Location : eastus
Resource ID : /subscriptions/xxxxxx71-1bf0-4dda-aec3-xxxxxxxxxxxx/resourceGroups/test-rg/provide
rs/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI :
Tenant ID : 54xxxxxx-38d6-4fb2-bad9-xxxxxxxxxxxx
Initial Admin Object Ids : {xxxxxx9e-5be9-4f43-abd2-xxxxxxxxxxxx}
SKU : StandardB1
Soft Delete Enabled? : True
Enabled Purge Protection? : True
Soft Delete Retention Period (days) : 70
Provisioning State : Succeeded
Status Message : The Managed HSM is provisioned and ready to use.
Tags :
Active la protection contre le vidage du Hsm managé nommé $hsmName
dans le groupe de ressources $resourceGroupName
.
Exemple 4 : Mettre à jour l’identité affectée par l’utilisateur pour un Hsm managé
Update-AzKeyVaultManagedHsm -Name testmhsm -ResourceGroupName test-rg -UserAssignedIdentity /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bez-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bez-id02 | Format-List
Managed HSM Name : testmshm
Resource Group Name : test-rg
Location : eastus2euap
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/pro
viders/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Initial Admin Object Ids : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
SKU : StandardB1
Soft Delete Enabled? : True
Enabled Purge Protection? : False
Soft Delete Retention Period (days) : 70
Public Network Access : Enabled
IdentityType : UserAssigned
UserAssignedIdentities : /subscriptions/xxxx/resourceGroups/xxxx/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName
Provisioning State : Succeeded
Status Message : The Managed HSM is provisioned and ready to use.
Security Domain ActivationStatus : Active
Security Domain ActivationStatusMessage : Your HSM has been activated and can be used for cryptographic operations.
Regions :
Tags
Cette commande ajoute une identité affectée par l’utilisateur pour le Hsm managé nommé testmshm
dans le groupe de ressources test-rg
.
Paramètres
-Confirm
Vous invite à confirmer 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: | AzContext, 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 |
-EnablePurgeProtection
spécifiant si la protection contre le vidage est activée pour ce pool HSM managé. Le paramètre est effectif uniquement si la suppression réversible est également activée. L’activation de cette fonctionnalité est irréversible.
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 |
-InputObject
Objet HSM managé.
Type: | PSManagedHsm |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Name
Nom du HSM managé.
Type: | String |
Alias: | HsmName |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-PublicNetworkAccess
Contrôle l’autorisation pour le trafic du plan de données provenant de réseaux publics tandis que le point de terminaison privé est activé.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ResourceGroupName
Nom du groupe de ressources.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ResourceId
ID de ressource du HSM managé.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-SubscriptionId
ID de l’abonnement. Par défaut, les applets de commande sont exécutées dans l’abonnement défini dans le contexte actuel. Si l’utilisateur spécifie un autre abonnement, l’applet de commande actuelle est exécutée dans l’abonnement spécifié par l’utilisateur. La substitution d’abonnements prend effet uniquement pendant le cycle de vie de l’applet de commande actuelle. Il ne modifie pas l’abonnement dans le contexte et n’affecte pas les applets de commande suivantes.
Type: | String |
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
Table de hachage qui représente les balises de ressource.
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 |
-UserAssignedIdentity
Ensemble d’identités affectées par l’utilisateur associées au HSM managé. Sa valeur sera les ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».
Type: | String[] |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. 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 |