Update-AzDataProtectionBackupVault

Uppdatera en BackupVault-resurs som tillhör en resursgrupp.

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>]

Description

Uppdatera en BackupVault-resurs som tillhör en resursgrupp.

Exempel

Exempel 1: Lägga till taggar i ett befintligt säkerhetskopieringsvalv

$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

Det första kommandot skapar en ny tagg-hashtable med taggar och deras värden. Det andra kommandot lägger till de angivna taggarna i säkerhetskopieringsvalvet.

Exempel 2: Inaktivera Azure övervaka aviseringar för jobbfel

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

Det här kommandot inaktiverar övervakningsaviseringar för alla jobbfel för säkerhetskopieringsvalvet. Tillåtna värden är: Aktiverad, Inaktiverad. Observera att den här inställningen är aktiverad som standard.

Exempel 3: Uppdatera valvet ImmutabilityState, CrossSubscriptionRestoreState, inställningar för mjuk borttagning

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

Det här kommandot används för att ändra oföränderlighetstillstånd, återställningstillstånd för flera prenumerationer, inställningar för mjuk borttagning av valvet. Dessa parametrar är valfria och kan användas oberoende av varandra.

Exempel 4: Uppdatera valvet CmkIdentityType från UserAssignedManagedIdentity till SystemAssignedManagedIdentity och 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

Det här kommandot används för att ändra CmkIdentityType och CmkEncryptionKeyUri. Dessa parametrar är valfria och kan användas oberoende av varandra.

Exempel 5: Uppdatera valvet CmkIdentityType från SystemAssignedManagedIdentity till 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

Det här kommandot används för att ändra CmkIdentityType från SystemAssigned till UserAssgined. CmkIdenityId är en obligatorisk parameter.

Exempel 6: Uppdatera valvet för att tilldela en användartilldelad hanterad identitet (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

Definiera först ARM-resurs-ID för användartilldelad hanterad identitet (UAMI). Använd sedan cmdleten Update-AzDataProtectionBackupVault för att tilldela UAMI till säkerhetskopieringsvalvet samtidigt som du behåller den systemtilldelade hanterade identiteten. Växeln -EnableSystemAssignedIdentity aktiverar den systemtilldelade identiteten och parametern -UserAssignedIdentity anger den användartilldelade identitet som ska associeras med valvet.

Parametrar

-AsJob

Kör kommandot som ett jobb

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-AzureMonitorAlertsForAllJobFailure

Parameter för att aktivera eller inaktivera inbyggda Azure Monitor-aviseringar för jobbfel. Säkerhetsaviseringar kan inte inaktiveras.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CmkEncryptionKeyUri

Nyckel-URI:n för CMK-nyckeln som ska användas för kryptering. Om du vill aktivera automatisk rotation av nycklar undantar du versionskomponenten från nyckel-URI:n.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CmkEncryptionState

Aktivera CMK-krypteringstillstånd för ett Säkerhetskopieringsvalv.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CmkIdentityType

Den identitetstyp som ska användas för CMK-kryptering – SystemAssigned eller UserAssigned Identity.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CmkUserAssignedIdentityId

Den här parametern krävs om identitetstypen är UserAssigned. Lägg till det användartilldelade hanterade identitets-ID som ska användas som har åtkomstbehörighet till Key Vault.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CrossRegionRestoreState

Återställningstillstånd för valvet mellan regioner. Tillåtna värden är Inaktiverade, Aktiverade.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CrossSubscriptionRestoreState

Återställningstillstånd för flera prenumerationer för valvet. Tillåtna värden är Inaktiverade, Aktiverade, PermanentDisabled.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Parametern DefaultProfile fungerar inte. Använd parametern SubscriptionId när den är tillgänglig om du kör cmdleten mot en annan prenumeration.

Parameteregenskaper

Typ:PSObject
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzureRMContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableSystemAssignedIdentity

Avgör om du vill aktivera en systemtilldelad identitet för resursen.

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EncryptionSetting

Kundhanterad nyckelinformation om resursen.

Parameteregenskaper

Typ:IEncryptionSettings
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ETag

Valfri ETag.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ImmutabilityState

Valvets oföränderlighetstillstånd. Tillåtna värden är Inaktiverade, Upplåst, Låst.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Identitetsparameter

Parameteregenskaper

Typ:IDataProtectionIdentity
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NoWait

Kör kommandot asynkront

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ReplicatedRegion

Lista över replikerade regioner för Backup Vault

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGuardOperationRequest

Resursskyddsåtgärdsbegäran i samma format som <ResourceGuard-ARMID>/<operation>/default. Använd den här parametern när åtgärden är MUA-skyddad. Åtgärder som stöds är dppReduceImmutabilityStateRequests, dppReduceSoftDeleteSecurityRequests och dppModifyEncryptionSettingsRequests.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-SecureToken

Parameter för att auktorisera åtgärder som skyddas av resursskydd mellan klientorganisationer. Använd kommandot (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx -AsSecureString"). Token för att hämta auktoriseringstoken för en annan klientorganisation.

Parameteregenskaper

Typ:SecureString
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-SoftDeleteRetentionDurationInDay

Varaktighet för kvarhållning av mjuk borttagning i dagar.

Parameteregenskaper

Typ:Double
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-SoftDeleteState

Mjukt borttagningstillstånd för valvet. Tillåtna värden är Av, På, AlwaysOn.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-StorageSetting

Lagringsinställningar

Parameteregenskaper

Typ:

IStorageSetting[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-SubscriptionId

ID för målprenumerationen. Värdet måste vara ett UUID.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Tag

Resursetiketter.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Token

Parametern är inaktuell. Använd SecureToken i stället.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-UserAssignedIdentity

Matrisen med användartilldelade identiteter som är associerade med resursen. Elementen i matrisen är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-VaultName

Namnet på säkerhetskopieringsvalvet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateExpanded
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-XmsDeletedVaultId

ID:t för det borttagna säkerhetskopieringsvalvet som ska återställas från under flödet för att ta bort borttagningen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateViaIdentityExpanded
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

IDataProtectionIdentity

Utdata

IBackupVaultResource