Update-AzDataProtectionBackupVault
Atualize um recurso BackupVault pertencente a um grupo de recursos.
Sintaxe
UpdateExpanded (Default)
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
Atualize um recurso BackupVault pertencente a um grupo de recursos.
Exemplos
Exemplo 1: Adicionar marcas a um cofre de backup existente
$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
O primeiro comando cria um hashtable de marca com marcas e seus valores.
O segundo comando adiciona as marcas fornecidas ao cofre de backup.
Exemplo 2: Desabilitar Azure monitorar alertas para falhas de trabalho
Update-AzDataProtectionBackupVault -ResourceGroupName "rgName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -AzureMonitorAlertsForAllJobFailure 'Disabled'
Name Location Type IdentityType
---- -------- ---- ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned
Esse comando desabilita os alertas de monitor para todas as falhas de trabalho do cofre de backup.
Os valores permitidos são: Habilitado, Desabilitado.
Observe que, por padrão, essa configuração está habilitada.
Exemplo 3: Atualizar o cofre ImmutabilityState, CrossSubscriptionRestoreState, configurações de exclusão reversível
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
Esse comando é usado para modificar o estado de Imutabilidade, o estado de restauração entre assinaturas, as configurações de exclusão reversível do cofre.
Esses parâmetros são opcionais e podem ser usados independentemente.
Exemplo 4: Atualizar o CmkIdentityType do cofre de UserAssignedManagedIdentity para SystemAssignedManagedIdentity e 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
Esse comando é usado para modificar CmkIdentityType e CmkEncryptionKeyUri.
Esses parâmetros são opcionais e podem ser usados independentemente.
Exemplo 5: Atualizar o CmkIdentityType do cofre de SystemAssignedManagedIdentity para 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
Esse comando é usado para alterar CmkIdentityType de SystemAssigned para UserAssgined.
CmkIdenityId é um parâmetro necessário.
Exemplo 6: Atualizar o cofre para atribuir uma UAMI (Identidade Gerenciada Atribuída ao Usuário)
$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
Primeiro, defina a ID do recurso ARM da UAMI (Identidade Gerenciada Atribuída ao Usuário).
Em seguida, use o cmdlet Update-AzDataProtectionBackupVault para atribuir a interface do usuário ao cofre de backup, mantendo a Identidade Gerenciada Atribuída pelo Sistema.
A opção -EnableSystemAssignedIdentity habilita a identidade atribuída pelo sistema e o parâmetro -UserAssignedIdentity especifica a identidade atribuída pelo usuário a ser associada ao cofre.
Parâmetros
-AsJob
Executar o comando como um trabalho
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-AzureMonitorAlertsForAllJobFailure
Parâmetro para habilitar ou desabilitar alertas internos do Azure Monitor para falhas de trabalho.
Os alertas de segurança não podem ser desabilitados.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CmkEncryptionKeyUri
O URI de chave da chave CMK a ser usada para criptografia.
Para habilitar a rotação automática de chaves, exclua o componente de versão do URI da chave.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CmkEncryptionState
Habilite o estado de criptografia do CMK para um Cofre de Backup.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CmkIdentityType
O tipo de identidade a ser usado para criptografia CMK – SystemAssigned ou UserAssigned Identity.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CmkUserAssignedIdentityId
Esse parâmetro será necessário se o tipo de identidade for UserAssigned.
Adicione a ID de identidade gerenciada atribuída ao usuário a ser usada, que tem permissões de acesso ao Key Vault.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CrossRegionRestoreState
Estado de restauração entre regiões do cofre.
Os valores permitidos estão desabilitados, habilitados.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-CrossSubscriptionRestoreState
Estado de restauração entre assinaturas do cofre.
Os valores permitidos são Desabilitados, Habilitados, Permanentemente Desabilitados.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-DefaultProfile
O parâmetro DefaultProfile não está funcional.
Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.
Propriedades do parâmetro
Tipo: PSObject
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: AzureRMContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-EnableSystemAssignedIdentity
Determina se uma identidade atribuída pelo sistema deve ser habilitada para o recurso.
Propriedades do parâmetro
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-EncryptionSetting
Detalhes da Chave Gerenciada do Cliente do recurso.
Propriedades do parâmetro
Tipo: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IEncryptionSettings
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ETag
ETag opcional.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ImmutabilityState
Estado de imutabilidade do cofre.
Os valores permitidos são Desabilitados, Desbloqueados, Bloqueados.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
Parâmetro de identidade
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-NoWait
Execute o comando de forma assíncrona
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ReplicatedRegion
Lista de regiões replicadas para o Cofre de Backup
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ResourceGroupName
O nome do grupo de recursos.
O nome não diferencia maiúsculas de minúsculas.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ResourceGuardOperationRequest
Solicitação de operação do Resource Guard no formato semelhante a <ResourceGuard-ARMID>/<operation>/default.
Use esse parâmetro quando a operação estiver protegida por MUA.
As operações com suporte incluem dppReduceImmutabilityStateRequests, dppReduceSoftDeleteSecurityRequests e dppModifyEncryptionSettingsRequests.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-SecureToken
Parâmetro para autorizar operações protegidas pelo proteção de recursos entre locatários.
Use o comando (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxx-AsSecureString"). Token para buscar o token de autorização para um locatário diferente.
Propriedades do parâmetro
Tipo: SecureString
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-SoftDeleteRetentionDurationInDay
Duração da retenção de exclusão reversível em dias.
Propriedades do parâmetro
Tipo: Double
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-SoftDeleteState
Estado de exclusão reversível do cofre.
Os valores permitidos são Off, On, AlwaysOn.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-StorageSetting
Configurações de armazenamento
Propriedades do parâmetro
Tipo: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IStorageSetting [ ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-SubscriptionId
O ID da assinatura de destino.
O valor deve ser uma UUID.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Tag
Tags de recursos.
Propriedades do parâmetro
Tipo: Hashtable
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Token
Parâmetro preterido.
Em vez disso, use SecureToken.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-UserAssignedIdentity
A matriz de identidades atribuídas pelo usuário associadas ao recurso.
Os elementos na matriz serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-VaultName
O nome do cofre de backup.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateExpanded
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-XmsDeletedVaultId
A ID do cofre de backup excluído a ser restaurado durante o fluxo de recuperação.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
UpdateViaIdentityExpanded
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IBackupVaultResource