Update-AzDataProtectionBackupVault

Aktualisieren Sie eine BackupVault-Ressource, die zu einer Ressourcengruppe gehört.

Syntax

UpdateExpanded (Standard)

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

UpdateViaIdentityExpanded

Update-AzDataProtectionBackupVault
    -InputObject <IDataProtectionIdentity>
    [-Token <String>]
    [-XmsDeletedVaultId <String>]
    [-AzureMonitorAlertsForAllJobFailure <String>]
    [-CrossRegionRestoreState <String>]
    [-CrossSubscriptionRestoreState <String>]
    [-ETag <String>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-EncryptionSetting <IEncryptionSettings>]
    [-ImmutabilityState <String>]
    [-ReplicatedRegion <String[]>]
    [-ResourceGuardOperationRequest <String[]>]
    [-SoftDeleteRetentionDurationInDay <Double>]
    [-SoftDeleteState <String>]
    [-StorageSetting <IStorageSetting[]>]
    [-Tag <Hashtable>]
    [-UserAssignedIdentity <String[]>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beschreibung

Aktualisieren Sie eine BackupVault-Ressource, die zu einer Ressourcengruppe gehört.

Beispiele

Beispiel 1: Hinzufügen von Tags zu einem vorhandenen Sicherungstresor

$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

Der erste Befehl erstellt eine neue Taghashtable mit Tags und deren Werten. Der zweite Befehl fügt dem Sicherungstresor die angegebenen Tags hinzu.

Beispiel 2: Deaktivieren Azure Überwachen von Warnungen auf Auftragsfehler

Update-AzDataProtectionBackupVault -ResourceGroupName "rgName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -AzureMonitorAlertsForAllJobFailure 'Disabled'
Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

Mit diesem Befehl werden die Monitorbenachrichtigungen für alle Auftragsfehler für den Sicherungstresor deaktiviert. Zulässige Werte sind: Aktiviert, deaktiviert. Beachten Sie, dass diese Einstellung standardmäßig aktiviert ist.

Beispiel 3: Update Vault ImmutabilityState, CrossSubscriptionRestoreState, Einstellungen für vorläufiges Löschen

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

Dieser Befehl wird verwendet, um den Unveränderlichkeitszustand, den Zustand der abonnementübergreifenden Wiederherstellung, die Einstellungen für das vorläufige Löschen des Tresors zu ändern. Diese Parameter sind optional und können unabhängig verwendet werden.

Beispiel 4: Aktualisieren des Tresors CmkIdentityType von UserAssignedManagedIdentity auf SystemAssignedManagedIdentity und 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

Dieser Befehl wird verwendet, um CmkIdentityType und CmkEncryptionKeyUri zu ändern. Diese Parameter sind optional und können unabhängig verwendet werden.

Beispiel 5: Aktualisieren des Tresors CmkIdentityType von SystemAssignedManagedIdentity auf 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

Dieser Befehl wird verwendet, um CmkIdentityType von SystemAssigned in UserAssgined zu ändern. CmkIdenityId ist ein erforderlicher Parameter.

Beispiel 6: Aktualisieren des Tresors zum Zuweisen einer vom Benutzer zugewiesenen verwalteten Identität (User Assigned Managed Identity, UAMI)

$UAMI = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userAssignedIdentityName"

$vault = Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity -UserAssignedIdentity $UAMI -SubscriptionId "00000000-0000-0000-0000-000000000000" -VaultName "vaultName" -ResourceGroupName "resourceGroupName"
Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned, UserAssigned

Definieren Sie zunächst die ARM-Ressourcen-ID (User Assigned Managed Identity, UAMI). Verwenden Sie als Nächstes das Cmdlet Update-AzDataProtectionBackupVault, um das UAMI dem Sicherungstresor zuzuweisen, während die vom System zugewiesene verwaltete Identität beibehalten wird. Der switch -EnableSystemAssignedIdentity ermöglicht die vom System zugewiesene Identität, und der parameter -UserAssignedIdentity gibt die vom Benutzer zugewiesene Identität an, die dem Tresor zugeordnet werden soll.

Parameter

-AsJob

Ausführen des Befehls als Auftrag

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AzureMonitorAlertsForAllJobFailure

Parameter zum Aktivieren oder Deaktivieren integrierter Azure-Monitorbenachrichtigungen für Auftragsfehler. Sicherheitswarnungen können nicht deaktiviert werden.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CmkEncryptionKeyUri

Der Schlüssel-URI des CMK-Schlüssels, der für die Verschlüsselung verwendet werden soll. Um die automatische Drehung von Schlüsseln zu aktivieren, schließen Sie die Versionskomponente aus dem Schlüssel-URI aus.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CmkEncryptionState

Aktivieren Sie den CMK-Verschlüsselungsstatus für einen Sicherungstresor.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CmkIdentityType

Der Identitätstyp, der für die CMK-Verschlüsselung verwendet werden soll – SystemAssigned oder UserAssigned Identity.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CmkUserAssignedIdentityId

Dieser Parameter ist erforderlich, wenn der Identitätstyp "UserAssigned" ist. Fügen Sie die vom Benutzer zugewiesene verwaltete Identitäts-ID hinzu, die über Zugriffsberechtigungen für die Key Vault verfügt.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Cf

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CrossRegionRestoreState

Regionsübergreifender Wiederherstellungszustand des Tresors. Zulässige Werte sind "Disabled", "Enabled".

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CrossSubscriptionRestoreState

Abonnementübergreifender Wiederherstellungsstatus des Tresors. Zulässige Werte sind "Disabled", "Enabled", "PermanentlyDisabled".

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DefaultProfile

Der Parameter DefaultProfile ist nicht funktionsfähig. Verwenden Sie den Parameter "SubscriptionId", wenn sie verfügbar ist, wenn Sie das Cmdlet für ein anderes Abonnement ausführen.

Parametereigenschaften

Typ:PSObject
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AzureRMContext, AzureCredential

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-EnableSystemAssignedIdentity

Bestimmt, ob eine vom System zugewiesene Identität für die Ressource aktiviert werden soll.

Parametereigenschaften

Typ:

Nullable<T>[Boolean]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-EncryptionSetting

Vom Kunden verwaltete Schlüsseldetails der Ressource.

Parametereigenschaften

Typ:IEncryptionSettings
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ETag

Optionales ETag.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ImmutabilityState

Unveränderlichkeitszustand des Tresors. Zulässige Werte sind "Disabled", "Unlocked", "Locked".

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InputObject

Identity-Parameter

Parametereigenschaften

Typ:IDataProtectionIdentity
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-NoWait

Asynchrones Ausführen des Befehls

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ReplicatedRegion

Liste der replizierten Regionen für den Sicherungstresor

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ResourceGroupName

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ResourceGuardOperationRequest

Resource Guard-Vorgangsanforderung im Format ähnlich wie <ResourceGuard-ARMID>/operation</>default. Verwenden Sie diesen Parameter, wenn der Vorgang MUA-geschützt ist. Zu den unterstützten Vorgängen gehören "dppReduceImmutabilityStateRequests", "dppReduceSoftDeleteSecurityRequests" und "dppModifyEncryptionSettingsRequests".

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SecureToken

Parameter zum Autorisieren von Vorgängen, die durch mandantenübergreifenden Ressourcenschutz geschützt sind. Befehl verwenden (Get-AzAccessToken -TenantId "xxxxxx-xxxx-xxxx-xxxx-xxxx-xxxx -AsSecureString"). Token zum Abrufen des Autorisierungstokens für verschiedene Mandanten.

Parametereigenschaften

Typ:SecureString
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SoftDeleteRetentionDurationInDay

Aufbewahrungsdauer für vorläufige Löschungen in Tagen.

Parametereigenschaften

Typ:Double
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SoftDeleteState

Vorläufiger Löschstatus des Tresors. Zulässige Werte sind "Off", "On", "AlwaysOn".

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-StorageSetting

Speichereinstellungen

Parametereigenschaften

Typ:

IStorageSetting[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SubscriptionId

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Tag

Ressourcenkennzeichnungen.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Token

Parameter veraltet. Verwenden Sie stattdessen SecureToken.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-UserAssignedIdentity

Das Array der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Elemente im Array sind ARM-Ressourcen-IDs in der Form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}.'

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-VaultName

Der Name des Backup-Tresors.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateExpanded
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-XmsDeletedVaultId

Die ID des gelöschten Sicherungstresors, aus dem während des Wiederherstellungsvorgangs wiederhergestellt werden soll.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

UpdateViaIdentityExpanded
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

IDataProtectionIdentity

Ausgaben

IBackupVaultResource