Backup Instances - Trigger Restore

Serviço:: Data Protection

Versão da API:: 2026-06-01

Aciona a restauração para um BackupInstance

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore?api-version=2026-06-01

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
backupInstanceName	path	True	string	O nome do BackupInstanceResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
vaultName	path	True	string minLength: 2 maxLength: 50 pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$	O nome do cofre de backup.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
x-ms-authorization-auxiliary		string

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name	Descrição
AzureBackupRecoveryPointBasedRestoreRequest	Solicitação de restauração baseada em backup do AzureSolicitação de restauração baseada em ponto
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime Solicitação de restauração baseada em PointTime
AzureBackupRestoreWithRehydrationRequest	AzureBackup Restore com solicitação de reidratação

AzureBackupRecoveryPointBasedRestoreRequest

Solicitação de restauração baseada em backup do AzureSolicitação de restauração baseada em ponto

Name	Obrigatório	Tipo	Descrição
objectType	True	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	True	string
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	True	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
identityDetails		IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
sourceResourceId		string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackup RecoveryPointTime Solicitação de restauração baseada em PointTime

Name	Obrigatório	Tipo	Descrição
objectType	True	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	True	string	O tempo de recuperação no exemplo de formato ISO 8601 - 2020-08-14T17:30:00.0000000Z.
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	True	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
identityDetails		IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
sourceResourceId		string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

AzureBackupRestoreWithRehydrationRequest

AzureBackup Restore com solicitação de reidratação

Name	Obrigatório	Tipo	Descrição
objectType	True	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	True	string
rehydrationPriority	True	RehydrationPriority	Prioridade a utilizar para reidratação. Valores Altos ou Padrão
rehydrationRetentionDuration	True	string	Duração da retenção no formato ISO 8601, ou seja, P10D.
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	True	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
identityDetails		IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
sourceResourceId		string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

Respostas

Name	Tipo	Descrição
200 OK	OperationJobExtendedInfo	Operação do Azure concluída com sucesso.
202 Accepted		Operação de recurso aceita. Cabeçalhos Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Name

Tipo

Descrição

200 OK

OperationJobExtendedInfo

Operação do Azure concluída com sucesso.

202 Accepted

Operação de recurso aceita.

Cabeçalhos

Azure-AsyncOperation: string
Location: string

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

Trigger Restore

Trigger Restore As Files

Trigger Restore with GenericRestoreDatasourceCriteria

Trigger Restore With Rehydration

Trigger Restore

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2026-06-01

{
  "identityDetails": {
    "useSystemAssignedIdentity": false,
    "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
  },
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "restoreTargetInfo": {
    "datasourceAuthCredentials": {
      "objectType": "SecretStoreBasedAuthCredentials",
      "secretStoreResource": {
        "secretStoreType": "AzureKeyVault",
        "uri": "https://samplevault.vault.azure.net/secrets/credentials"
      }
    },
    "datasourceInfo": {
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
      "resourceLocation": "",
      "resourceName": "targetdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": ""
    },
    "datasourceSetInfo": {
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": ""
    },
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia"
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Resposta da amostra

Código de estado:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Código de estado:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Retry-After: 60

Trigger Restore As Files

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2026-06-01

{
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "restoreTargetInfo": {
    "objectType": "RestoreFilesTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia",
    "targetDetails": {
      "filePrefix": "restoredblob",
      "restoreTargetLocationType": "AzureBlobs",
      "url": "https://teststorage.blob.core.windows.net/restoretest"
    }
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Resposta da amostra

Código de estado:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Código de estado:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Retry-After: 60

Trigger Restore with GenericRestoreDatasourceCriteria

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2026-06-01

{
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "sourceDataStoreType": "OperationalStore",
  "restoreTargetInfo": {
    "restoreLocation": "southeastasia",
    "recoveryOption": "FailIfExists",
    "objectType": "ItemLevelRestoreTargetInfo",
    "datasourceInfo": {
      "resourceID": "/subscriptions/97cda027-4279-4cde-b4ff-19afa0021d87/resourceGroups/ESAN-ECYBVTRG/providers/Microsoft.ElasticSan/elasticSans/ecy-bvt-adhoc/volumeGroups/target-esan-volgroup",
      "resourceUri": "SampleresourceUri123",
      "datasourceType": "Microsoft.ElasticSan/elasticSans/volumeGroups",
      "resourceName": "target-esan-volgroup",
      "resourceType": "Microsoft.ElasticSan/elasticSans/volumeGroups",
      "resourceLocation": "eastus2euap",
      "objectType": "Datasource"
    },
    "datasourceSetInfo": {
      "resourceID": "/subscriptions/97cda027-4279-4cde-b4ff-19afa0021d87/resourceGroups/ESAN-ECYBVTRG/providers/Microsoft.ElasticSan/elasticSans/ecy-bvt-adhoc",
      "datasourceType": "Microsoft.ElasticSan/elasticSans/volumeGroups",
      "resourceType": "Microsoft.ElasticSan/elasticSans",
      "resourceLocation": "eastus2euap",
      "objectType": "DatasourceSet"
    },
    "restoreCriteria": [
      {
        "objectType": "GenericRestoreDatasourceCriteria",
        "resourceSelectors": {
          "objectType": "resourceListSelectionCriteria",
          "resourceIdentifiers": [
            "source-vol1",
            "source-vol2",
            "source-vol3"
          ],
          "resourceNameOverrides": {
            "source-vol1": "target-vol1",
            "source-vol2": "target-vol2"
          }
        }
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2026-06-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2026-06-01
Retry-After: 60

Código de estado:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Trigger Restore With Rehydration

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2026-06-01

{
  "objectType": "AzureBackupRestoreWithRehydrationRequest",
  "recoveryPointId": "hardcodedRP",
  "rehydrationPriority": "High",
  "rehydrationRetentionDuration": "7D",
  "restoreTargetInfo": {
    "datasourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": ""
    },
    "datasourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": ""
    },
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia"
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Resposta da amostra

Código de estado:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Código de estado:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==2026-06-01
Retry-After: 60

Definições

Name	Descrição
AzureBackupRecoveryPointBasedRestoreRequest	Solicitação de restauração baseada em backup do AzureSolicitação de restauração baseada em ponto
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime Solicitação de restauração baseada em PointTime
AzureBackupRestoreWithRehydrationRequest	AzureBackup Restore com solicitação de reidratação
CloudError	Uma resposta de erro do Backup do Azure.
Datasource	Fonte de dados para backup
DatasourceSet	DatasourceDefina detalhes da fonte de dados para backup
DefaultResourceProperties	Propriedades de origem padrão
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ExistingResourcePolicy	Obtém ou define a propriedade Política de Conflito. Esta propriedade define a política durante o conflito de recursos durante a restauração.
GenericRestoreDatasourceCriteria	Critérios genéricos a serem usados durante a restauração
IdentityDetails
ItemLevelRestoreTargetInfo	Restaurar informações de destino para a operação de restauração no nível do item
ItemPathBasedRestoreCriteria	Critérios de prefixo a serem usados durante a restauração
KubernetesClusterRestoreCriteria	Informações de destino do kubernetes Cluster Backup para operação de restauração
KubernetesClusterVaultTierRestoreCriteria	Informações de destino do kubernetes Cluster Backup para operação de restauração do vault
KubernetesPVRestoreCriteria	Informações de destino de volume persistente kubernetes de nível de item para operação de restauração
KubernetesStorageClassRestoreCriteria	Informações de destino da classe de armazenamento kubernetes de nível de item para operação de restauração
NamespacedNameResource	Classe para referenciar recursos que contém namespace e nome
OperationJobExtendedInfo	Informações estendidas do trabalho de operação
PersistentVolumeRestoreMode	Obtém ou define a propriedade PV (Volume Persistente) Modo de Restauração. Esta propriedade define se os volumes precisam ser restaurados.
RangeBasedItemLevelRestoreCriteria	Informações de destino de nível de item para operação de restauração
RecoveryOption	Opção de Recuperação
RehydrationPriority	Prioridade a utilizar para reidratação. Valores Altos ou Padrão
ResourceListSelectionCriteria	Especifica a lista de recursos a restaurar
ResourcePropertiesObjectType	Tipo do objeto específico - usado para desserialização
RestoreFilesTargetInfo	Classe encapsulando restaurar como parâmetros de destino de arquivos
RestoreTargetInfo	Classe encapsulando parâmetros de destino de restauração
RestoreTargetLocationType	Indica o local de destino onde os dados serão restaurados, valor da cadeia de caracteres para o enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
SecretStoreBasedAuthCredentials	Credenciais de autenticação baseadas em armazenamento secreto.
SecretStoreResource	Classe que representa um recurso de armazenamento secreto.
SecretStoreType	Obtém ou define o tipo de armazenamento secreto
SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
TargetDetails	Detalhes do destino de encapsulamento de classe, usados onde o destino não é uma fonte de dados

AzureBackupRecoveryPointBasedRestoreRequest

Object

Solicitação de restauração baseada em backup do AzureSolicitação de restauração baseada em ponto

Name	Tipo	Descrição
identityDetails	IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
sourceResourceId	string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

AzureBackupRecoveryTimeBasedRestoreRequest

Object

AzureBackup RecoveryPointTime Solicitação de restauração baseada em PointTime

Name	Tipo	Descrição
identityDetails	IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
objectType	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	string	O tempo de recuperação no exemplo de formato ISO 8601 - 2020-08-14T17:30:00.0000000Z.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
sourceResourceId	string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

AzureBackupRestoreWithRehydrationRequest

Object

AzureBackup Restore com solicitação de reidratação

Name	Tipo	Descrição
identityDetails	IdentityDetails	Contém informações dos Detalhes de Identidade para o BI. Se for null, o padrão será considerado como System Assigned.
objectType	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	string
rehydrationPriority	RehydrationPriority	Prioridade a utilizar para reidratação. Valores Altos ou Padrão
rehydrationRetentionDuration	string	Duração da retenção no formato ISO 8601, ou seja, P10D.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Obtém ou define as informações de destino de restauração.
sourceDataStoreType	SourceDataStoreType	Obtém ou define o tipo do armazenamento de dados de origem.
sourceResourceId	string	ID do Azure Resource Manager totalmente qualificada da fonte de dados que está sendo recuperada.

CloudError

Object

Uma resposta de erro do Backup do Azure.

Name	Tipo	Descrição
error	Error	A resposta de erro de gerenciamento de recursos.

Datasource

Object

Fonte de dados para backup

Name	Tipo	Descrição
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
resourceID	string	ID ARM completo do recurso. Para recursos do Azure, isso é ARM ID. Para recursos não Azure, este será o ID criado pelo serviço de backup via Fabric/Vault.
resourceLocation	string	Localização da fonte de dados.
resourceName	string	Identificador exclusivo do recurso no contexto do pai.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Propriedades específicas da fonte de dados
resourceType	string	Tipo de recurso da fonte de dados.
resourceUri	string	Uri do recurso.

DatasourceSet

Object

DatasourceDefina detalhes da fonte de dados para backup

Name	Tipo	Descrição
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
resourceID	string	ID ARM completo do recurso. Para recursos do Azure, isso é ARM ID. Para recursos não Azure, este será o ID criado pelo serviço de backup via Fabric/Vault.
resourceLocation	string	Localização da fonte de dados.
resourceName	string	Identificador exclusivo do recurso no contexto do pai.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Propriedades específicas do conjunto de fontes de dados
resourceType	string	Tipo de recurso da fonte de dados.
resourceUri	string	Uri do recurso.

DefaultResourceProperties

Object

Propriedades de origem padrão

Name	Tipo	Descrição
objectType	string: DefaultResourceProperties	Tipo do objeto específico - usado para desserialização

Error

Object

A resposta de erro de gerenciamento de recursos.

Name	Tipo	Descrição
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 alvo do erro.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ExistingResourcePolicy

Enumeração

Obtém ou define a propriedade Política de Conflito. Esta propriedade define a política durante o conflito de recursos durante a restauração.

Valor	Descrição
Skip
Patch

GenericRestoreDatasourceCriteria

Object

Critérios genéricos a serem usados durante a restauração

Name	Tipo	Descrição
objectType	string: GenericRestoreDatasourceCriteria	Tipo do objeto específico - usado para desserialização
resourceSelectors	ResourceListSelectionCriteria	Lista de identificadores de recursos que precisam de ser restaurados

IdentityDetails

Object

Name	Tipo	Descrição
useSystemAssignedIdentity	boolean	Especifica se o BI está protegido pela Identidade do Sistema.
userAssignedIdentityArmUrl	string	URL ARM para identidade atribuída ao usuário.

ItemLevelRestoreTargetInfo

Object

Restaurar informações de destino para a operação de restauração no nível do item

Name	Tipo	Descrição
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenciais a serem usadas para autenticar com o provedor da fonte de dados.
datasourceInfo	Datasource	Informação do DS alvo
datasourceSetInfo	DatasourceSet	Informações do DS set de destino
objectType	string: ItemLevelRestoreTargetInfo	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
recoveryOption	RecoveryOption	Opção de Recuperação
restoreCriteria	ItemLevelRestoreCriteria[]: GenericRestoreDatasourceCriteria[] ItemPathBasedRestoreCriteria[] KubernetesClusterRestoreCriteria[] KubernetesClusterVaultTierRestoreCriteria[] KubernetesPVRestoreCriteria[] KubernetesStorageClassRestoreCriteria[] RangeBasedItemLevelRestoreCriteria[]	Critérios de restauração
restoreLocation	string	Região de restauração de destino

ItemPathBasedRestoreCriteria

Object

Critérios de prefixo a serem usados durante a restauração

Name	Tipo	Descrição
isPathRelativeToBackupItem	boolean	Sinalizador para especificar se o caminho é relativo ao item de backup ou caminho completo
itemPath	string	O caminho do item a ser restaurado. Pode ser o caminho completo do item ou o caminho relativo ao item de backup
objectType	string: ItemPathBasedRestoreCriteria	Tipo do objeto específico - usado para desserialização
renameTo	string	Renomeie o item a ser restaurado. Restore renomeará o itemPath para esse novo nome se o valor for especificado, caso contrário, o itemPath será restaurado como o mesmo nome.
subItemPathPrefix	string[]	A lista de cadeias de caracteres de prefixo a serem usadas como critérios de filtro durante a restauração. Eles são relativos ao caminho do item especificado.

KubernetesClusterRestoreCriteria

Object

Informações de destino do kubernetes Cluster Backup para operação de restauração

Name	Tipo	Descrição
conflictPolicy	ExistingResourcePolicy	Obtém ou define a propriedade Política de Conflito. Esta propriedade define a política durante o conflito de recursos durante a restauração.
excludedNamespaces	string[]	Obtém ou define a propriedade exclude namespaces. Esta propriedade define os namespaces a serem excluídos durante a restauração.
excludedResourceTypes	string[]	Obtém ou define a propriedade excluir tipos de recursos. Esta propriedade define os tipos de recursos a serem excluídos durante a restauração.
includeClusterScopeResources	boolean	Obtém ou define a propriedade include cluster resources. Essa propriedade, se habilitada, incluirá recursos de escopo de cluster durante a restauração.
includedNamespaces	string[]	Obtém ou define a propriedade include namespaces. Esta propriedade define os namespaces a serem incluídos durante a restauração.
includedResourceTypes	string[]	Obtém ou define a propriedade include resource types. Esta propriedade define os tipos de recursos a serem incluídos durante a restauração.
labelSelectors	string[]	Obtém ou define a propriedade LabelSelectors. Esta propriedade define o recurso com esses seletores de rótulo a serem incluídos durante a restauração.
namespaceMappings	object	Obtém ou define a propriedade Namespace Mappings. Esta propriedade define se o namespace precisa ser alterado durante a restauração.
objectType	string: KubernetesClusterRestoreCriteria	Tipo do objeto específico - usado para desserialização
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	Obtém ou define a propriedade PV (Volume Persistente) Modo de Restauração. Esta propriedade define se os volumes precisam ser restaurados.
resourceModifierReference	NamespacedNameResource	Obtém ou define a referência do modificador de recursos. Esta propriedade define a referência para o modificador de recursos durante a restauração.
restoreHookReferences	NamespacedNameResource[]	Obtém ou define as referências de gancho de restauração. Esta propriedade define a referência de gancho a ser executada durante a restauração.

KubernetesClusterVaultTierRestoreCriteria

Object

Informações de destino do kubernetes Cluster Backup para operação de restauração do vault

Name	Tipo	Descrição
conflictPolicy	ExistingResourcePolicy	Obtém ou define a propriedade Política de Conflito. Esta propriedade define a política durante o conflito de recursos durante a restauração do vault.
excludedNamespaces	string[]	Obtém ou define a propriedade exclude namespaces. Esta propriedade define os namespaces a serem excluídos durante a restauração do vault.
excludedResourceTypes	string[]	Obtém ou define a propriedade excluir tipos de recursos. Esta propriedade define os tipos de recursos a serem excluídos durante a restauração do vault.
includeClusterScopeResources	boolean	Obtém ou define a propriedade include cluster resources. Essa propriedade, se habilitada, incluirá recursos de escopo de cluster durante a restauração do vault.
includedNamespaces	string[]	Obtém ou define a propriedade include namespaces. Esta propriedade define os namespaces a serem incluídos durante a restauração do vault.
includedResourceTypes	string[]	Obtém ou define a propriedade include resource types. Esta propriedade define os tipos de recursos a serem incluídos durante a restauração do vault.
labelSelectors	string[]	Obtém ou define a propriedade LabelSelectors. Esta propriedade define o recurso com esses seletores de rótulo a ser incluído durante a restauração do vault.
namespaceMappings	object	Obtém ou define a propriedade Namespace Mappings. Essa propriedade define se o namespace precisa ser alterado durante a restauração do vault.
objectType	string: KubernetesClusterVaultTierRestoreCriteria	Tipo do objeto específico - usado para desserialização
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	Obtém ou define a propriedade PV (Volume Persistente) Modo de Restauração. Essa propriedade define se os volumes precisam ser restaurados do vault.
resourceModifierReference	NamespacedNameResource	Obtém ou define a referência do modificador de recursos. Esta propriedade define a referência para o modificador de recursos durante a restauração.
restoreHookReferences	NamespacedNameResource[]	Obtém ou define as referências de gancho de restauração. Esta propriedade define a referência de gancho a ser executada durante a restauração do vault.
stagingResourceGroupId	string (arm-id)	Obtém ou define a ID RG de preparo para criar discos de preparo e instantâneos durante a restauração do vault.
stagingStorageAccountId	string (arm-id)	Obtém ou define o ID da Conta de Armazenamento de preparo para criar dados de armazenamento de objetos de extensão de backup durante a restauração do vault.

KubernetesPVRestoreCriteria

Object

Informações de destino de volume persistente kubernetes de nível de item para operação de restauração

Name	Tipo	Descrição
name	string	Nome da declaração de volume persistente selecionada
objectType	string: KubernetesPVRestoreCriteria	Tipo do objeto específico - usado para desserialização
storageClassName	string	Nome da classe de armazenamento selecionada para operação de restauração

KubernetesStorageClassRestoreCriteria

Object

Informações de destino da classe de armazenamento kubernetes de nível de item para operação de restauração

Name	Tipo	Descrição
objectType	string: KubernetesStorageClassRestoreCriteria	Tipo do objeto específico - usado para desserialização
provisioner	string	Provisionador da classe de armazenamento
selectedStorageClassName	string	Nome da classe de armazenamento selecionada

NamespacedNameResource

Object

Classe para referenciar recursos que contém namespace e nome

Name	Tipo	Descrição
name	string	O nome do recurso
namespace	string	Namespace no qual o recurso existe

OperationJobExtendedInfo

Object

Informações estendidas do trabalho de operação

Name	Tipo	Descrição
jobId	string	Nome ou Arm Id do trabalho criado para esta operação.
objectType	string: OperationJobExtendedInfo	Esta propriedade será usada como o discriminador para decidir os tipos específicos na cadeia polimórfica de tipos.

PersistentVolumeRestoreMode

Enumeração

Obtém ou define a propriedade PV (Volume Persistente) Modo de Restauração. Esta propriedade define se os volumes precisam ser restaurados.

Valor	Descrição
RestoreWithVolumeData
RestoreWithoutVolumeData

RangeBasedItemLevelRestoreCriteria

Object

Informações de destino de nível de item para operação de restauração

Name	Tipo	Descrição
maxMatchingValue	string	Valor máximo para correspondência de prefixo de intervalo
minMatchingValue	string	valor mínimo para correspondência de prefixo de intervalo
objectType	string: RangeBasedItemLevelRestoreCriteria	Tipo do objeto específico - usado para desserialização

RecoveryOption

Enumeração

Opção de Recuperação

Valor	Descrição
FailIfExists

RehydrationPriority

Enumeração

Prioridade a utilizar para reidratação. Valores Altos ou Padrão

Valor	Descrição
Invalid
High
Standard

ResourceListSelectionCriteria

Object

Especifica a lista de recursos a restaurar

Name	Tipo	Descrição
objectType	string	Tipo do objeto específico - usado para desserialização
resourceIdentifiers	string[]	Lista de identificadores de recursos a restaurar a partir de
resourceNameOverrides	object	Este é um mapa dos nomes de recursos de origem para nomes de recursos alvo para restaurar. Qualquer nome de origem que não esteja incluído no mapa será restaurado com um formato de nomenclatura por defeito

ResourcePropertiesObjectType

Enumeração

Tipo do objeto específico - usado para desserialização

Valor	Descrição
DefaultResourceProperties

RestoreFilesTargetInfo

Object

Classe encapsulando restaurar como parâmetros de destino de arquivos

Name	Tipo	Descrição
objectType	string: RestoreFilesTargetInfo	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
recoveryOption	RecoveryOption	Opção de Recuperação
restoreLocation	string	Região de restauração de destino
targetDetails	TargetDetails	Destino da operação RestoreAsFiles, quando o destino não é uma fonte de dados

RestoreTargetInfo

Object

Classe encapsulando parâmetros de destino de restauração

Name	Tipo	Descrição
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenciais a serem usadas para autenticar com o provedor da fonte de dados.
datasourceInfo	Datasource	Informação do DS alvo
datasourceSetInfo	DatasourceSet	Informações do DS set de destino
objectType	string: RestoreTargetInfo	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
recoveryOption	RecoveryOption	Opção de Recuperação
restoreLocation	string	Região de restauração de destino

RestoreTargetLocationType

Enumeração

Indica o local de destino onde os dados serão restaurados, valor da cadeia de caracteres para o enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}

Valor	Descrição
Invalid
AzureBlobs
AzureFiles

SecretStoreBasedAuthCredentials

Object

Credenciais de autenticação baseadas em armazenamento secreto.

Name	Tipo	Descrição
objectType	string: SecretStoreBasedAuthCredentials	Tipo do objeto específico - usado para desserialização
secretStoreResource	SecretStoreResource	Recurso de armazenamento secreto

SecretStoreResource

Object

Classe que representa um recurso de armazenamento secreto.

Name	Tipo	Descrição
secretStoreType	SecretStoreType	Obtém ou define o tipo de armazenamento secreto
uri	string	Uri para chegar ao recurso
value	string	Obtém ou define o valor armazenado no recurso de armazenamento secreto

SecretStoreType

Enumeração

Obtém ou define o tipo de armazenamento secreto

Valor	Descrição
Invalid
AzureKeyVault

SourceDataStoreType

Enumeração

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

Valor	Descrição
ArchiveStore
SnapshotStore
OperationalStore
VaultStore

TargetDetails

Object

Detalhes do destino de encapsulamento de classe, usados onde o destino não é uma fonte de dados

Name	Tipo	Descrição
filePrefix	string	Operação de restauração pode criar vários arquivos dentro do local apontado por Url Abaixo será o prefixo comum para todos eles
restoreTargetLocationType	RestoreTargetLocationType	Indica o local de destino onde os dados serão restaurados, valor da cadeia de caracteres para o enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
targetResourceArmId	string	ID ARM completo denotando o destino de restauração. É o ID ARM apontando para o contêiner / compartilhamento de arquivos Isso é opcional se a assinatura de destino puder ser identificada com o campo URL. Se não, isso é necessário se o campo CrossSubscriptionRestore do BackupVault estiver em qualquer um dos estados desativados
url	string	URL que indica o destino de restauração. Ele pode apontar para contêiner / compartilhamento de arquivos etc