Compartilhar via


Backup Vaults - Get In Resource Group

Retorna a coleção de recursos pertencente a um grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

uuid

A ID da assinatura de destino. O valor deve ser uma UUID.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

BackupVaultResourceList

OKEY

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation represente sua conta de usuário.

Exemplos

Get BackupVaults in ResourceGroup

Solicitação de exemplo

GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01

Resposta de exemplo

{
  "value": [
    {
      "identity": {
        "type": "None"
      },
      "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
      "name": "ExampleVault1",
      "type": "Microsoft.DataProtection/BackupVaults",
      "location": "WestUS",
      "tags": {
        "key1": "val1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "storageSettings": [
          {
            "datastoreType": "VaultStore",
            "type": "LocallyRedundant"
          }
        ],
        "featureSettings": {
          "crossRegionRestoreSettings": {
            "state": "Enabled"
          }
        },
        "securitySettings": {
          "softDeleteSettings": {
            "state": "Enabled",
            "retentionDurationInDays": 14
          }
        },
        "secureScore": "Adequate",
        "bcdrSecurityLevel": "Good"
      }
    },
    {
      "identity": {
        "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
        "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
        "type": "SystemAssigned"
      },
      "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
      "name": "ExampleVault2",
      "type": "Microsoft.DataProtection/BackupVaults",
      "location": "WestUS",
      "tags": {
        "key1": "val1"
      },
      "properties": {
        "monitoringSettings": {
          "azureMonitorAlertSettings": {
            "alertsForAllJobFailures": "Enabled"
          }
        },
        "provisioningState": "Succeeded",
        "storageSettings": [
          {
            "datastoreType": "VaultStore",
            "type": "LocallyRedundant"
          }
        ],
        "featureSettings": {
          "crossRegionRestoreSettings": {
            "state": "Enabled"
          }
        },
        "securitySettings": {
          "softDeleteSettings": {
            "state": "Enabled",
            "retentionDurationInDays": 14
          }
        },
        "secureScore": "Adequate",
        "bcdrSecurityLevel": "Good"
      }
    }
  ]
}

Definições

Nome Description
AlertsState
AzureMonitorAlertSettings

Configurações para alertas baseados no Azure Monitor

BackupVault

BackupVault

BackupVaultResource

Recurso BackupVault

BackupVaultResourceList

BackupVaultResourceList

BCDRSecurityLevel

Nível de segurança do Cofre de Backup

CloudError

CloudError

CmkKekIdentity

Os detalhes da identidade gerenciada usada para o CMK

CmkKeyVaultProperties

As propriedades do Key Vault que hospeda o CMK

createdByType

O tipo de identidade que criou o recurso.

CrossRegionRestoreSettings
CrossRegionRestoreState

Estado CrossRegionRestore

CrossSubscriptionRestoreSettings

Configurações de CrossSubscriptionRestore

CrossSubscriptionRestoreState

Estado CrossSubscriptionRestore

DppIdentityDetails

DppIdentityDetails

encryptionSettings

Detalhes da Chave Gerenciada do Cliente do recurso.

EncryptionState

Estado de criptografia do Cofre de Backup.

Error

A resposta de erro de gerenciamento de recursos.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

FeatureSettings

Classe que contém as configurações de recurso do cofre

IdentityType

O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.

ImmutabilitySettings

Configurações de Imutabilidade no nível do cofre

ImmutabilityState

Estado de imutabilidade

InfrastructureEncryptionState

Habilitando/desabilitando o estado de Criptografia Dupla

MonitoringSettings

Configurações de monitoramento

ProvisioningState

Estado de provisionamento do recurso BackupVault

ResourceMoveDetails

ResourceMoveDetails será retornado em resposta à chamada GetResource do ARM

ResourceMoveState

Estado de movimentação de recursos para o cofre de backup

SecureScoreLevel

Classificação segura do Cofre de Backup

SecuritySettings

Classe que contém configurações de segurança do cofre

SoftDeleteSettings

Configurações relacionadas à exclusão reversível

SoftDeleteState

Estado da exclusão reversível

StorageSetting

StorageSetting

StorageSettingStoreTypes

Obtém ou define o tipo do armazenamento de dados.

StorageSettingTypes

Obtém ou define o tipo.

systemData

Metadados relativos à criação e última modificação do recurso.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

AlertsState

Nome Tipo Description
Disabled

string

Enabled

string

AzureMonitorAlertSettings

Configurações para alertas baseados no Azure Monitor

Nome Tipo Description
alertsForAllJobFailures

AlertsState

BackupVault

BackupVault

Nome Tipo Description
bcdrSecurityLevel

BCDRSecurityLevel

Nível de segurança do Cofre de Backup

featureSettings

FeatureSettings

Configurações de recurso

isVaultProtectedByResourceGuard

boolean

É o cofre protegido pelo resource guard

monitoringSettings

MonitoringSettings

Configurações de monitoramento

provisioningState

ProvisioningState

Estado de provisionamento do recurso BackupVault

replicatedRegions

string[]

Lista de regiões replicadas para o Cofre de Backup

resourceGuardOperationRequests

string[]

ResourceGuardOperationRequests no qual a verificação LAC será executada

resourceMoveDetails

ResourceMoveDetails

Detalhes de movimentação de recursos para o cofre de backup

resourceMoveState

ResourceMoveState

Estado de movimentação de recursos para o cofre de backup

secureScore

SecureScoreLevel

Classificação segura do Cofre de Backup

securitySettings

SecuritySettings

Configurações de segurança

storageSettings

StorageSetting[]

Configurações de armazenamento

BackupVaultResource

Recurso BackupVault

Nome Tipo Description
eTag

string

ETag opcional.

id

string

A ID do recurso representa o caminho completo para o recurso.

identity

DppIdentityDetails

DppIdentityDetails
Detalhes da identidade gerenciada de entrada

location

string

Local do recurso.

name

string

Nome do recurso associado ao recurso.

properties

BackupVault

BackupVault
Propriedades de BackupVaultResource

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

tags

object

Marcas de recurso.

type

string

O tipo de recurso representa o caminho completo do formulário Namespace/ResourceType/ResourceType/...

BackupVaultResourceList

BackupVaultResourceList

Nome Tipo Description
nextLink

string

O uri para buscar a próxima página de recursos. A chamada ListNext() busca a próxima página de recursos.

value

BackupVaultResource[]

Lista de recursos.

BCDRSecurityLevel

Nível de segurança do Cofre de Backup

Nome Tipo Description
Excellent

string

Fair

string

Good

string

NotSupported

string

Poor

string

CloudError

CloudError

Nome Tipo Description
error

Error

A resposta de erro de gerenciamento de recursos.

CmkKekIdentity

Os detalhes da identidade gerenciada usada para o CMK

Nome Tipo Description
identityId

string

A identidade gerenciada a ser usada que tem permissões de acesso para o Key Vault. Forneça um valor aqui no caso de tipos de identidade: somente "UserAssigned".

identityType

IdentityType

O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.

CmkKeyVaultProperties

As propriedades do Key Vault que hospeda o CMK

Nome Tipo Description
keyUri

string

O uri de chave da chave gerenciada pelo cliente

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CrossRegionRestoreSettings

Nome Tipo Description
state

CrossRegionRestoreState

Estado CrossRegionRestore

CrossRegionRestoreState

Estado CrossRegionRestore

Nome Tipo Description
Disabled

string

Enabled

string

CrossSubscriptionRestoreSettings

Configurações de CrossSubscriptionRestore

Nome Tipo Description
state

CrossSubscriptionRestoreState

Estado CrossSubscriptionRestore

CrossSubscriptionRestoreState

Estado CrossSubscriptionRestore

Nome Tipo Description
Disabled

string

Enabled

string

PermanentlyDisabled

string

DppIdentityDetails

DppIdentityDetails

Nome Tipo Description
principalId

string

A ID do objeto da entidade de serviço para a identidade gerenciada que é usada para conceder acesso baseado em função a um recurso do Azure.

tenantId

string

Um GUID (Identificador Global exclusivo) que representa o locatário do Azure AD em que o recurso agora é membro.

type

string

O identityType que pode ser SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' ou None

userAssignedIdentities

<string,  UserAssignedIdentity>

Obtém ou define as identidades atribuídas pelo usuário.

encryptionSettings

Detalhes da Chave Gerenciada do Cliente do recurso.

Nome Tipo Description
infrastructureEncryption

InfrastructureEncryptionState

Habilitando/desabilitando o estado de Criptografia Dupla

kekIdentity

CmkKekIdentity

Os detalhes da identidade gerenciada usada para o CMK

keyVaultProperties

CmkKeyVaultProperties

As propriedades do Key Vault que hospeda o CMK

state

EncryptionState

Estado de criptografia do Cofre de Backup.

EncryptionState

Estado de criptografia do Cofre de Backup.

Nome Tipo Description
Disabled

string

A criptografia cmk está desabilitada no Cofre de Backup. O usuário não poderá definir esse estado depois que o Estado de Criptografia estiver "Habilitado".

Enabled

string

A criptografia cmk está habilitada no Cofre de Backup

Inconsistent

string

A criptografia cmk está em estado inconsistente no Cofre de Backup. Esse estado indica que o usuário precisa repetir a operação de configurações de criptografia imediatamente para corrigir o estado.

Error

A resposta de erro de gerenciamento de recursos.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

Error[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

FeatureSettings

Classe que contém as configurações de recurso do cofre

Nome Tipo Description
crossRegionRestoreSettings

CrossRegionRestoreSettings

crossSubscriptionRestoreSettings

CrossSubscriptionRestoreSettings

Configurações de CrossSubscriptionRestore

IdentityType

O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.

Nome Tipo Description
SystemAssigned

string

UserAssigned

string

ImmutabilitySettings

Configurações de Imutabilidade no nível do cofre

Nome Tipo Description
state

ImmutabilityState

Estado de imutabilidade

ImmutabilityState

Estado de imutabilidade

Nome Tipo Description
Disabled

string

Locked

string

Unlocked

string

InfrastructureEncryptionState

Habilitando/desabilitando o estado de Criptografia Dupla

Nome Tipo Description
Disabled

string

Enabled

string

MonitoringSettings

Configurações de monitoramento

Nome Tipo Description
azureMonitorAlertSettings

AzureMonitorAlertSettings

Configurações para alertas baseados no Azure Monitor

ProvisioningState

Estado de provisionamento do recurso BackupVault

Nome Tipo Description
Failed

string

Provisioning

string

Succeeded

string

Unknown

string

Updating

string

ResourceMoveDetails

ResourceMoveDetails será retornado em resposta à chamada GetResource do ARM

Nome Tipo Description
completionTimeUtc

string

Tempo de conclusão em UTC da operação mais recente do ResourceMove tentada. Formato ISO 8601.

operationId

string

CorrelationId da última operação ResourceMove tentada

sourceResourcePath

string

Caminho de recurso do ARM do recurso de origem

startTimeUtc

string

Hora de início em UTC da operação mais recente do ResourceMove tentada. Formato ISO 8601.

targetResourcePath

string

Caminho de recurso do ARM do recurso de destino usado na operação ResourceMove mais recente

ResourceMoveState

Estado de movimentação de recursos para o cofre de backup

Nome Tipo Description
CommitFailed

string

CommitTimedout

string

CriticalFailure

string

Failed

string

InProgress

string

MoveSucceeded

string

PartialSuccess

string

PrepareFailed

string

PrepareTimedout

string

Unknown

string

SecureScoreLevel

Classificação segura do Cofre de Backup

Nome Tipo Description
Adequate

string

Maximum

string

Minimum

string

None

string

NotSupported

string

SecuritySettings

Classe que contém configurações de segurança do cofre

Nome Tipo Description
encryptionSettings

encryptionSettings

Detalhes da Chave Gerenciada do Cliente do recurso.

immutabilitySettings

ImmutabilitySettings

Configurações de Imutabilidade no nível do cofre

softDeleteSettings

SoftDeleteSettings

Configurações relacionadas à exclusão reversível

SoftDeleteSettings

Configurações relacionadas à exclusão reversível

Nome Tipo Description
retentionDurationInDays

number

Duração da retenção de exclusão reversível

state

SoftDeleteState

Estado da exclusão reversível

SoftDeleteState

Estado da exclusão reversível

Nome Tipo Description
AlwaysOn

string

A Exclusão Reversível está habilitada permanentemente para o BackupVault e a configuração não pode ser alterada

Off

string

A exclusão reversível está desativada para o BackupVault

On

string

A Exclusão Reversível está habilitada para o BackupVault, mas pode ser desativada

StorageSetting

StorageSetting

Nome Tipo Description
datastoreType

StorageSettingStoreTypes

Obtém ou define o tipo do armazenamento de dados.

type

StorageSettingTypes

Obtém ou define o tipo.

StorageSettingStoreTypes

Obtém ou define o tipo do armazenamento de dados.

Nome Tipo Description
ArchiveStore

string

OperationalStore

string

VaultStore

string

StorageSettingTypes

Obtém ou define o tipo.

Nome Tipo Description
GeoRedundant

string

LocallyRedundant

string

ZoneRedundant

string

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome Tipo Description
clientId

string

A ID do cliente da identidade atribuída.

principalId

string

A ID da entidade de segurança da identidade atribuída.