Partilhar via

az dataprotection backup-vault

  • Referência

Nota

Essa referência faz parte da extensão de proteção de dados para a CLI do Azure (versão 2.57.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az dataprotection backup-vault . Saiba mais sobre extensões.

Gerencie o cofre de backup com proteção de dados.

Comandos

Name Description Tipo Estado
az dataprotection backup-vault create

Crie um recurso BackupVault pertencente a um grupo de recursos.

 Extensão GA
az dataprotection backup-vault delete

Exclua um recurso BackupVault do grupo de recursos.

 Extensão GA
az dataprotection backup-vault list

Obtém a lista do cofre de backup em uma assinatura ou em um grupo de recursos.

 Extensão GA
az dataprotection backup-vault list-from-resourcegraph

Liste cofres de backup em assinaturas, grupos de recursos e cofres.

 Extensão GA
az dataprotection backup-vault resource-guard-mapping

Gerencie mapeamentos do ResourceGuard para um cofre de backup.

 Extensão GA
az dataprotection backup-vault resource-guard-mapping create

Crie um mapeamento do ResourceGuard.

 Extensão GA
az dataprotection backup-vault resource-guard-mapping delete

Exclua o mapeamento do ResourceGuard.

 Extensão GA
az dataprotection backup-vault resource-guard-mapping show

Obtenha o objeto de mapeamento do ResourceGuard associado ao vault e que corresponda ao nome na solicitação.

 Extensão GA
az dataprotection backup-vault show

Obtenha um recurso pertencente a um grupo de recursos.

 Extensão GA
az dataprotection backup-vault update

Atualiza um recurso BackupVault pertencente a um grupo de recursos. Por exemplo, atualizar tags para um recurso.

 Extensão GA
az dataprotection backup-vault wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão GA

az dataprotection backup-vault create

Crie um recurso BackupVault pertencente a um grupo de recursos.

az dataprotection backup-vault create --resource-group
                                      --storage-setting
                                      --vault-name
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-infra-encryption {Disabled, Enabled}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--e-tag]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--location]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--retention-duration-in-days]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--tags]
                                      [--type]
                                      [--uami]

Exemplos

Criar BackupVault

az dataprotection backup-vault create --type "None" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Criar BackupVault com MSI

az dataprotection backup-vault create --type "systemAssigned" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Crie o BackupVault com criptografia CMK

az dataprotection backup-vault create -g "resourceGroupName" -v "vaultName" --location "eastasia" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --type "UserAssigned" --user-assigned-identities '{"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami":{}}' --cmk-encryption-key-uri "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1" --cmk-encryption-state "Enabled" --cmk-identity-type "UserAssigned" --cmk-infrastructure-encryption "Enabled" --cmk-user-assigned-identity-id  "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"

Parâmetros Obrigatórios

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--storage-setting --storage-settings

Configurações de armazenamento. Uso: --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais. Bandeiras singulares: --storage-settings.

--vault-name -v

O nome do cofre de backup.

Parâmetros Opcionais

--azure-monitor-alerts-for-job-failures --job-failure-alerts

Propriedade que especifica se os alertas internos do Azure Monitor devem ser disparados para todos os trabalhos com falha.

valores aceites: Disabled, Enabled
--cmk-encryption-key-uri

O URI da chave CMK a ser usado para criptografia. Para habilitar a rotação automática de chaves, exclua o componente versão do URI de chave.

--cmk-encryption-state

Habilite o estado de criptografia CMK para um Cofre de Backup.

valores aceites: Disabled, Enabled, Inconsistent
--cmk-identity-type

O tipo de identidade a ser usado para criptografia CMK - SystemAssigned ou UserAssigned Identity.

valores aceites: SystemAssigned, UserAssigned
--cmk-infra-encryption --cmk-infrastructure-encryption

Ativar/desativar a criptografia de infraestrutura com CMK neste cofre. A criptografia de infraestrutura deve ser configurada somente ao criar o cofre.

valores aceites: Disabled, Enabled
--cmk-uami --cmk-user-assigned-identity-id

Este parâmetro é necessário se o tipo de identidade for UserAssigned. Adicione o ID de identidade gerenciado atribuído ao usuário a ser usado que tenha permissões de acesso ao Cofre da Chave.

--cross-region-restore-state --crr-state

Defina o estado CrossRegionRestore. Uma vez ativado, não pode ser definido como desativado.

valores aceites: Disabled, Enabled
--cross-subscription-restore-state --csr-state

Estado CrossSubscriptionRestore.

valores aceites: Disabled, Enabled, PermanentlyDisabled
--e-tag

ETag opcional.

--immutability-state

Estado de imutabilidade.

valores aceites: Disabled, Locked, Unlocked
--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>. Quando não especificado, o local do grupo de recursos será usado.

--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--retention-duration-in-days --soft-delete-retention

Duração da retenção de exclusão suave.

valor predefinido: 14.0
--soft-delete-state

Estado de exclusão suave.

valores aceites: AlwaysOn, Off, On
valor predefinido: On
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--type

O identityType que pode ser "SystemAssigned", "UserAssigned", "SystemAssigned,UserAssigned" ou "None".

--uami --user-assigned-identities

Obtém ou define as identidades atribuídas ao usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault delete

Exclua um recurso BackupVault do grupo de recursos.

az dataprotection backup-vault delete [--ids]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--vault-name]
                                      [--yes]

Exemplos

Excluir BackupVault

az dataprotection backup-vault delete --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--vault-name -v

O nome do cofre de backup.

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault list

Obtém a lista do cofre de backup em uma assinatura ou em um grupo de recursos.

az dataprotection backup-vault list [--max-items]
                                    [--next-token]
                                    [--resource-group]

Exemplos

Listar cofre de backup em uma assinatura

az dataprotection backup-vault list

Listar cofre de backup em um grupo de recursos

az dataprotection backup-vault list -g sarath-rg

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault list-from-resourcegraph

Liste cofres de backup em assinaturas, grupos de recursos e cofres.

az dataprotection backup-vault list-from-resourcegraph [--resource-groups]
                                                       [--subscriptions]
                                                       [--vault-id]
                                                       [--vaults]

Exemplos

Buscar um cofre de backup específico

az dataprotection backup-vault list-from-resourcegraph --subscriptions 00000000-0000-0000-0000-000000000000 --resource-groups sample_rg --vaults sample_vault

Parâmetros Opcionais

--resource-groups

Lista de grupos de recursos.

--subscriptions

Lista de IDs de assinatura.

--vault-id

Especifique o filtro de ID do cofre a ser aplicado.

--vaults

Lista de nomes de cofres.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault show

Obtenha um recurso pertencente a um grupo de recursos.

az dataprotection backup-vault show [--ids]
                                    [--resource-group]
                                    [--subscription]
                                    [--vault-name]

Exemplos

Obtenha o BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Obtenha o BackupVault com MSI

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--vault-name -v

O nome do cofre de backup.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault update

Atualiza um recurso BackupVault pertencente a um grupo de recursos. Por exemplo, atualizar tags para um recurso.

az dataprotection backup-vault update [--add]
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--operation-requests]
                                      [--remove]
                                      [--resource-group]
                                      [--retention-duration-in-days]
                                      [--set]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--subscription]
                                      [--tags]
                                      [--tenant-id]
                                      [--type]
                                      [--uami]
                                      [--vault-name]

Exemplos

Patch BackupVault

az dataprotection backup-vault update --azure-monitor-alerts-for-job-failures "Enabled" --tags newKey="newVal" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

--azure-monitor-alerts-for-job-failures --job-failure-alerts

Propriedade que especifica se os alertas internos do Azure Monitor devem ser disparados para todos os trabalhos com falha.

valores aceites: Disabled, Enabled
--cmk-encryption-key-uri

O uri de chave da chave gerenciada pelo cliente.

--cmk-encryption-state

Habilite o estado de criptografia CMK para um Cofre de Backup.

valores aceites: Disabled, Enabled, Inconsistent
--cmk-identity-type

O tipo de identidade a ser usado para criptografia CMK - SystemAssigned ou UserAssigned Identity.

valores aceites: SystemAssigned, UserAssigned
--cmk-uami --cmk-user-assigned-identity-id

Este parâmetro é necessário se o tipo de identidade for UserAssigned. Adicione o ID de identidade gerenciado atribuído ao usuário a ser usado que tenha permissões de acesso ao Cofre da Chave.

--cross-region-restore-state --crr-state

Defina o estado CrossRegionRestore. Uma vez ativado, não pode ser definido como desativado.

valores aceites: Disabled, Enabled
--cross-subscription-restore-state --csr-state

Estado CrossSubscriptionRestore.

valores aceites: Disabled, Enabled, PermanentlyDisabled
--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--immutability-state

Estado de imutabilidade.

valores aceites: Disabled, Locked, Unlocked
--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--operation-requests --resource-guard-operation-requests

ResourceGuardOperationRequests em que a verificação LAC será executada suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais. Bandeiras singulares: --operation-requests.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--retention-duration-in-days --soft-delete-retention

Duração da retenção de exclusão suave.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.

--soft-delete-state

Estado de exclusão suave.

valores aceites: AlwaysOn, Off, On
--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--tenant-id

ID do locatário para chamadas entre locatários.

--type

O identityType que pode ser "SystemAssigned", "UserAssigned", "SystemAssigned,UserAssigned" ou "None".

--uami --user-assigned-identities

Obtém ou define as identidades atribuídas ao usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--vault-name -v

O nome do cofre de backup.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dataprotection backup-vault wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az dataprotection backup-vault wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]
                                    [--vault-name]

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

valor predefinido: False
--vault-name -v

O nome do cofre de backup.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.