Partager via

Update-AzDataProtectionBackupVault

Module:
Az.DataProtection Module

Met à jour une ressource BackupVault appartenant à un groupe de ressources. Par exemple, la mise à jour des balises pour une ressource.

Syntaxe

UpdateExpanded (Par défaut) 

Update-AzDataProtectionBackupVault
    -ResourceGroupName <String>
    -VaultName <String>
    [-Token <String>]
    [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
    [-CrossRegionRestoreState <CrossRegionRestoreState>]
    [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
    [-IdentityType <String>]
    [-IdentityUserAssignedIdentity <Hashtable>]
    [-ImmutabilityState <ImmutabilityState>]
    [-ResourceGuardOperationRequest <String[]>]
    [-SoftDeleteRetentionDurationInDay <Double>]
    [-SoftDeleteState <SoftDeleteState>]
    [-Tag <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-SubscriptionId <String>]
    [-CmkEncryptionState <EncryptionState>]
    [-CmkIdentityType <IdentityType>]
    [-CmkUserAssignedIdentityId <String>]
    [-CmkEncryptionKeyUri <String>]
    [-SecureToken <SecureString>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-AzDataProtectionBackupVault
    -InputObject <IDataProtectionIdentity>
    [-Token <String>]
    [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
    [-CrossRegionRestoreState <CrossRegionRestoreState>]
    [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
    [-EncryptionSetting <IEncryptionSettings>]
    [-IdentityType <String>]
    [-IdentityUserAssignedIdentity <Hashtable>]
    [-ImmutabilityState <ImmutabilityState>]
    [-ResourceGuardOperationRequest <String[]>]
    [-SoftDeleteRetentionDurationInDay <Double>]
    [-SoftDeleteState <SoftDeleteState>]
    [-Tag <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met à jour une ressource BackupVault appartenant à un groupe de ressources. Par exemple, la mise à jour des balises pour une ressource.

Exemples

Exemple 1 : Ajouter des balises à un coffre de sauvegarde existant

$tag = @{"Owner"="sarath";"Purpose"="AzureBackupTesting"}
Update-AzDataProtectionBackupVault -SubscriptionId "xxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Tag $tag

ETag IdentityPrincipalId                  IdentityTenantId                     IdentityType   Location      Name         Type
---- -------------------                  ----------------                     ------------   --------      ----         ----
     2ca1d5f7-38b3-4b61-aa45-8147d7e0edbc 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults

La première commande crée une table de hachage de balise avec des balises et leurs valeurs. La deuxième commande ajoute les balises données au coffre de sauvegarde.

Exemple 2 : Désactiver les alertes Azure Monitor pour les échecs de travail

Update-AzDataProtectionBackupVault -ResourceGroupName "rgName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -AzureMonitorAlertsForAllJobFailure 'Disabled'

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

Cette commande désactive les alertes de surveillance pour tous les échecs de travail pour le coffre de sauvegarde. Les valeurs autorisées sont : Activé, Désactivé. Notez que, par défaut, ce paramètre est activé.

Exemple 3 : Mettre à jour immutabilityState du coffre, CrossSubscriptionRestoreState, paramètres de suppression réversible

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CrossSubscriptionRestoreState Disabled -ImmutabilityState Disabled -SoftDeleteRetentionDurationInDay 99 -SoftDeleteState Off

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

Cette commande permet de modifier l’état immuabilité, l’état de restauration entre abonnements, les paramètres de suppression réversible du coffre. Ces paramètres sont facultatifs et peuvent être utilisés indépendamment.

Exemple 4 : Mettre à jour le coffre CmkIdentityType de UserAssignedManagedIdentity vers SystemAssignedManagedIdentity et CmkEncryptionKeyUri

$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri $cmkKeyUri

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

Cette commande est utilisée pour modifier CmkIdentityType et CmkEncryptionKeyUri. Ces paramètres sont facultatifs et peuvent être utilisés indépendamment.

Exemple 5 : Mettre à jour le coffre CmkIdentityType de SystemAssignedManagedIdentity vers UserAssignedManagedIdentity

$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults UserAssigned

Cette commande est utilisée pour remplacer CmkIdentityType de SystemAssigned par UserAssigned. CmkIdentityId est un paramètre obligatoire.

Exemple 6 : Mettre à jour le coffre pour affecter une identité managée affectée par l’utilisateur (UAMI)

$UAMI = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userAssignedIdentityName"=[Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api40.UserAssignedIdentity]::new()}

$vault = Update-AzDataProtectionBackupVault -AssignUserIdentity $UAMI -SubscriptionId "00000000-0000-0000-0000-000000000000" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" -IdentityType 'SystemAssigned,UserAssigned'

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned, UserAssigned

Tout d’abord, créez une table de hachage pour l’objet UAMI (User Assigned Managed Identity). Cet objet mappe l’ID de ressource UAMI à une nouvelle instance de UserAssignedIdentity. Ensuite, utilisez l’applet de commande Update-AzDataProtectionBackupVault pour affecter l’UAMI au coffre de sauvegarde tout en conservant l’identité managée affectée par le système. Le paramètre -IdentityType spécifie que les identités SystemAssigned et UserAssigned sont utilisées.

Paramètres

-AsJob

Exécuter la commande en tant que travail

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AzureMonitorAlertsForAllJobFailure

Paramètre permettant d’activer ou de désactiver les alertes Azure Monitor intégrées pour les échecs de travail. Les alertes de sécurité ne peuvent pas être désactivées.

Propriétés du paramètre

Type:AlertsState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CmkEncryptionKeyUri

URI de clé de la clé CMK à utiliser pour le chiffrement. Pour activer la rotation automatique des clés, excluez le composant de version de l’URI de clé.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CmkEncryptionState

Activez l’état de chiffrement CMK pour un coffre de sauvegarde.

Propriétés du paramètre

Type:EncryptionState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CmkIdentityType

Type d’identité à utiliser pour le chiffrement CMK - SystemAssigned ou UserAssigned Identity.

Propriétés du paramètre

Type:IdentityType
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CmkUserAssignedIdentityId

Ce paramètre est obligatoire si le type d’identité est UserAssigned. Ajoutez l’ID d’identité managée affecté par l’utilisateur à utiliser qui dispose des autorisations d’accès au coffre de clés.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CrossRegionRestoreState

État de restauration interrégion du coffre. Les valeurs autorisées sont Désactivées, Activées.

Propriétés du paramètre

Type:CrossRegionRestoreState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CrossSubscriptionRestoreState

État de restauration entre abonnements du coffre. Les valeurs autorisées sont Disabled, Enabled, PermanentlyDisabled.

Propriétés du paramètre

Type:CrossSubscriptionRestoreState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzureRMContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-EncryptionSetting

Détails de la clé gérée par le client de la ressource. Pour construire, consultez la section NOTES pour les propriétés ENCRYPTIONSETTING et créer une table de hachage.

Propriétés du paramètre

Type:IEncryptionSettings
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateViaIdentityExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IdentityType

IdentityType qui peut être SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' ou None

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IdentityUserAssignedIdentity

Obtient ou définit les identités affectées par l’utilisateur.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:UserAssignedIdentity, AssignUserIdentity

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ImmutabilityState

État d’immuabilité du coffre. Les valeurs autorisées sont désactivées, déverrouillées, verrouillées.

Propriétés du paramètre

Type:ImmutabilityState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Pour construire, consultez la section NOTES pour les propriétés INPUTOBJECT et créez une table de hachage.

Propriétés du paramètre

Type:IDataProtectionIdentity
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateViaIdentityExpanded
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-NoWait

Exécuter la commande de manière asynchrone

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ResourceGroupName

Nom du groupe de ressources. Le nom ne respecte pas la casse.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ResourceGuardOperationRequest

ResourceGuardOperationRequests sur laquelle la vérification LAC sera effectuée

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SecureToken

Paramètre permettant d’autoriser les opérations protégées par la protection des ressources interlocataires. Utilisez la commande (Get-AzAccessToken -TenantId « xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxx -AsSecureString »). Jeton permettant d’extraire le jeton d’autorisation pour un locataire différent.

Propriétés du paramètre

Type:SecureString
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SoftDeleteRetentionDurationInDay

Durée de rétention de suppression réversible en jours.

Propriétés du paramètre

Type:Double
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SoftDeleteState

État de suppression réversible du coffre. Les valeurs autorisées sont Off, On, AlwaysOn.

Propriétés du paramètre

Type:SoftDeleteState
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SubscriptionId

ID de l’abonnement cible. La valeur doit être un UUID.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Tag

Balises de ressource.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Token

Dépréciation du paramètre. Utilisez Plutôt SecureToken.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-VaultName

Nom du coffre de sauvegarde.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateExpanded
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

IDataProtectionIdentity

Sorties

IBackupVaultResource