Update-AzDataProtectionBackupVault

Moduł:
Az.DataProtection Module

Zaktualizuj zasób BackupVault należący do grupy zasobów.

Składnia

UpdateExpanded (domyślnie) 

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>]
    [-CostManagementGranularity <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>]
    [-CostManagementSettingGranularityLevel <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>]

Opis

Zaktualizuj zasób BackupVault należący do grupy zasobów.

Przykłady

Przykład 1. Dodawanie tagów do istniejącego magazynu kopii zapasowych

$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

Pierwsze polecenie tworzy nową tabelę skrótów tagów z tagami i ich wartościami. Drugie polecenie dodaje podane tagi do magazynu kopii zapasowych.

Przykład 2. Wyłączanie Azure monitorowanie alertów dotyczących niepowodzeń zadań

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

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

To polecenie wyłącza alerty monitorowania dla wszystkich niepowodzeń zadań dla magazynu kopii zapasowych. Dozwolone wartości to: Włączone, Wyłączone. Należy pamiętać, że to ustawienie jest domyślnie włączone.

Przykład 3: Aktualizowanie stanu Niezmienności magazynu, CrossSubscriptionRestoreState, ustawień usuwania nietrwałego

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

To polecenie służy do modyfikowania stanu niezmienności, stanu przywracania między subskrypcjami, ustawień usuwania nietrwałego magazynu. Te parametry są opcjonalne i mogą być używane niezależnie.

Przykład 4: Aktualizowanie magazynu CmkIdentityType z elementu UserAssignedManagedIdentity do elementu SystemAssignedManagedIdentity i 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

To polecenie służy do modyfikowania atrybutów CmkIdentityType i CmkEncryptionKeyUri. Te parametry są opcjonalne i mogą być używane niezależnie.

Przykład 5. Aktualizacja właściwości CmkIdentityType magazynu z elementu SystemAssignedManagedIdentity na 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

To polecenie służy do zmiany właściwości CmkIdentityType z elementu SystemAssigned na UserAssgined. CmkIdenityId jest wymaganym parametrem.

Przykład 6. Aktualizowanie magazynu w celu przypisania tożsamości zarządzanej przypisanej przez użytkownika (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

Najpierw zdefiniuj identyfikator zasobu arm przypisanej przez użytkownika (UAMI). Następnie użyj polecenia cmdlet Update-AzDataProtectionBackupVault, aby przypisać element UAMI do magazynu kopii zapasowych przy zachowaniu tożsamości zarządzanej przypisanej przez system. Przełącznik -EnableSystemAssignedIdentity włącza tożsamość przypisaną przez system, a parametr -UserAssignedIdentity określa tożsamość przypisaną przez użytkownika do skojarzenia z magazynem.

Parametry

-AsJob

Uruchamianie polecenia jako zadania

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AzureMonitorAlertsForAllJobFailure

Parametr włączania lub wyłączania wbudowanych alertów usługi Azure Monitor dla niepowodzeń zadań. Nie można wyłączyć alertów zabezpieczeń.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CmkEncryptionKeyUri

Identyfikator URI klucza klucza zarządzania kluczem do użycia na potrzeby szyfrowania. Aby włączyć automatyczne obracanie kluczy, wyklucz składnik wersji z identyfikatora URI klucza.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CmkEncryptionState

Włącz stan szyfrowania cmK dla magazynu kopii zapasowych.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CmkIdentityType

Typ tożsamości, który ma być używany do szyfrowania cmK — SystemAssigned lub UserAssigned Identity.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CmkUserAssignedIdentityId

Ten parametr jest wymagany, jeśli typ tożsamości to UserAssigned. Dodaj identyfikator tożsamości zarządzanej przypisanej przez użytkownika, który ma uprawnienia dostępu do Key Vault.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:por

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CostManagementGranularity

Stopień szczegółowości usługi Cost Management magazynu. Dozwolone wartości to VaultLevel, ProtectedItemLevel, ProtectedItemWithParentTag.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CostManagementSettingGranularityLevel

Ustawienia poziomu szczegółowości

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CrossRegionRestoreState

Stan przywracania między regionami magazynu. Dozwolone wartości to Wyłączone, Włączone.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-CrossSubscriptionRestoreState

Stan przywracania między subskrypcjami magazynu. Dozwolone wartości to Wyłączone, Włączone, TrwałeDisabled.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DefaultProfile

Parametr DefaultProfile nie działa. Użyj parametru SubscriptionId, jeśli jest dostępny, jeśli wykonuje polecenie cmdlet dla innej subskrypcji.

Właściwości parametru

Typ:PSObject
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AzureRMContext, AzureCredential

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-EnableSystemAssignedIdentity

Określa, czy włączyć tożsamość przypisaną przez system dla zasobu.

Właściwości parametru

Typ:

Nullable<T>[Boolean]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-EncryptionSetting

Szczegóły klucza zarządzanego przez klienta dotyczące zasobu.

Właściwości parametru

Typ:IEncryptionSettings
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ETag

Opcjonalny element ETag.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ImmutabilityState

Stan niezmienności magazynu. Dozwolone wartości to Wyłączone, Odblokowane, Zablokowane.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-InputObject

Parametr tożsamości

Właściwości parametru

Typ:IDataProtectionIdentity
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-NoWait

Uruchom polecenie asynchronicznie

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ReplicatedRegion

Lista zreplikowanych regionów dla magazynu kopii zapasowych

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceGroupName

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceGuardOperationRequest

Żądanie operacji ochrony zasobów w formacie podobnym do <ResourceGuard-ARMID>/<operation>/default. Użyj tego parametru, gdy operacja jest chroniona przez usługę MUA. Obsługiwane operacje obejmują dppReduceImmutabilityStateRequests, dppReduceSoftDeleteSecurityRequests i dppModifyEncryptionSettingsRequests.

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SecureToken

Parametr umożliwiający autoryzację operacji chronionych przez funkcję ochrony zasobów między dzierżawami. Użyj polecenia (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -AsSecureString"). Token do pobierania tokenu autoryzacji dla innej dzierżawy.

Właściwości parametru

Typ:SecureString
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SoftDeleteRetentionDurationInDay

Czas przechowywania usuwania nietrwałego w dniach.

Właściwości parametru

Typ:Double
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SoftDeleteState

Stan usuwania nietrwałego magazynu. Dozwolone wartości to Off, On, AlwaysOn.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-StorageSetting

Ustawienia magazynu

Właściwości parametru

Typ:

IStorageSetting[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SubscriptionId

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Tag

Tagi zasobów.

Właściwości parametru

Typ:Hashtable
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Token

Przestarzałe parametry. Zamiast tego użyj protokołu SecureToken.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-UserAssignedIdentity

Tablica tożsamości przypisanych przez użytkownika skojarzona z zasobem. Elementy w tablicy będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}".

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-VaultName

Nazwa magazynu kopii zapasowych.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateExpanded
Position:Named
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Wi

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-XmsDeletedVaultId

Identyfikator usuniętego magazynu kopii zapasowej, z którego ma zostać przywrócony podczas przepływu przywracania.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

UpdateViaIdentityExpanded
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

IDataProtectionIdentity

Dane wyjściowe

IBackupVaultResource