Backup Instances - Validate For Restore

Valida se o Restauro pode ser acionado para uma Origem de Dados

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

Parâmetros do URI

Name Em Necessário Tipo Description
backupInstanceName
path True

string

O nome da instância de cópia de segurança.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

subscriptionId
path True

string

uuid

O ID da subscrição de destino. O valor tem de ser um UUID.

vaultName
path True

string

O nome do cofre de cópias de segurança.

api-version
query True

string

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

Corpo do Pedido

Name Necessário Tipo Description
restoreRequestObject True AzureBackupRestoreRequest:

AzureBackupRestoreRequest
Obtém ou define o objeto de pedido de restauro.

Respostas

Name Tipo Description
200 OK

OperationJobExtendedInfo

Contém informações adicionais, como o ID da tarefa

202 Accepted

A operação será concluída de forma assíncrona.

Headers

  • Location: string
  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar a sua conta de utilizador.

Exemplos

Validate Restore

Sample Request

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

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

Sample Response

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60
{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Definições

Name Description
AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRestoreWithRehydrationRequest

AzureBackupRestoreWithRehydrationRequest

CloudError

CloudError

Datasource

Origem de dados

DatasourceSet

Conjunto de Origens de Dados

Error

A resposta ao erro de gestão de recursos.

ErrorAdditionalInfo

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

ExistingResourcePolicy

Obtém ou define a propriedade Política de Conflitos. Esta propriedade define a política durante o conflito de recursos durante o restauro.

ItemLevelRestoreTargetInfo

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

ItemPathBasedRestoreCriteria

Critérios de prefixo a utilizar durante o restauro

KubernetesClusterRestoreCriteria

informações de destino da Cópia de Segurança do Cluster do Kubernetes para a operação de restauro

KubernetesPVRestoreCriteria

Informações de destino de volume persistente do kubernetes ao nível do item para a operação de restauro

KubernetesStorageClassRestoreCriteria

Informações de destino da classe de armazenamento kubernetes ao nível do item para a operação de restauro

OperationJobExtendedInfo

OperationJobExtendedInfo

PersistentVolumeRestoreMode

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

RangeBasedItemLevelRestoreCriteria

Informações de destino do Nível do Item para a operação de restauro

RecoveryOption

Opção de Recuperação

RehydrationPriority

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

RestoreFilesTargetInfo

Restauro de encapsulamento de classes como parâmetros de destino de ficheiros

RestoreTargetInfo

Parâmetros de destino de restauro de encapsulamento de classes

RestoreTargetLocationType

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

SecretStoreBasedAuthCredentials

Credenciais de autenticação baseadas em arquivo secreto.

SecretStoreResource

Classe que representa um recurso de arquivo secreto.

SecretStoreType

Obtém ou define o tipo de arquivo secreto

SourceDataStoreType

Obtém ou define o tipo de arquivo de dados de origem.

TargetDetails

Detalhes de destino de encapsulamento de classes, utilizados em que o destino não é uma origem de dados

ValidateRestoreRequestObject

ValidateRestoreRequestObject

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryPointBasedRestoreRequest

Name Tipo Description
objectType string:

AzureBackupRecoveryPointBasedRestoreRequest

recoveryPointId

string

restoreTargetInfo RestoreTargetInfoBase:

Obtém ou define as informações de destino de restauro.

sourceDataStoreType

SourceDataStoreType

Obtém ou define o tipo de arquivo de dados de origem.

sourceResourceId

string

O Azure completamente qualificado Resource Manager ID da origem de dados que está a ser recuperada.

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

Name Tipo Description
objectType string:

AzureBackupRecoveryTimeBasedRestoreRequest

recoveryPointTime

string

O tempo de recuperação no exemplo de formato ISO 8601 – 2020-08-14T17:30:00.00000000Z.

restoreTargetInfo RestoreTargetInfoBase:

Obtém ou define as informações de destino de restauro.

sourceDataStoreType

SourceDataStoreType

Obtém ou define o tipo de arquivo de dados de origem.

sourceResourceId

string

O Azure completamente qualificado Resource Manager ID da origem de dados que está a ser recuperada.

AzureBackupRestoreWithRehydrationRequest

AzureBackupRestoreWithRehydrationRequest

Name Tipo Description
objectType string:

AzureBackupRestoreWithRehydrationRequest

recoveryPointId

string

rehydrationPriority

RehydrationPriority

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

rehydrationRetentionDuration

string

Duração da retenção no formato ISO 8601, ou seja, P10D.

restoreTargetInfo RestoreTargetInfoBase:

Obtém ou define as informações de destino de restauro.

sourceDataStoreType

SourceDataStoreType

Obtém ou define o tipo de arquivo de dados de origem.

sourceResourceId

string

O Azure completamente qualificado Resource Manager ID da origem de dados que está a ser recuperada.

CloudError

CloudError

Name Tipo Description
error

Error

A resposta ao erro de gestão de recursos.

Datasource

Origem de dados

Name Tipo Description
datasourceType

string

DatasourceType do recurso.

objectType

string

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

resourceID

string

ID do ARM completo do recurso. Para recursos do Azure, este é o ID do ARM. Para recursos não azure, este será o ID criado pelo serviço de cópia de segurança através do Fabric/Vault.

resourceLocation

string

Localização da origem de dados.

resourceName

string

Identificador exclusivo do recurso no contexto do principal.

resourceType

string

Tipo de Recurso de Origem de Dados.

resourceUri

string

Uri do recurso.

DatasourceSet

Conjunto de Origens de Dados

Name Tipo Description
datasourceType

string

DatasourceType do recurso.

objectType

string

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

resourceID

string

ID do ARM completo do recurso. Para recursos do Azure, este é o ID do ARM. Para recursos não azure, este será o ID criado pelo serviço de cópia de segurança através do Fabric/Vault.

resourceLocation

string

Localização da origem de dados.

resourceName

string

Identificador exclusivo do recurso no contexto do principal.

resourceType

string

Tipo de Recurso de Origem de Dados.

resourceUri

string

Uri do recurso.

Error

A resposta ao erro de gestão de recursos.

Name 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

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

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ExistingResourcePolicy

Obtém ou define a propriedade Política de Conflitos. Esta propriedade define a política durante o conflito de recursos durante o restauro.

Name Tipo Description
Patch

string

Skip

string

ItemLevelRestoreTargetInfo

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

Name Tipo Description
datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

Credenciais a utilizar para autenticar com o fornecedor de origem de dados.

datasourceInfo

Datasource

Origem de dados
Informações do DS de destino

datasourceSetInfo

DatasourceSet

Conjunto de Origens de Dados
Informações do Conjunto de DS de destino

objectType string:

ItemLevelRestoreTargetInfo

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

recoveryOption

RecoveryOption

Opção de Recuperação

restoreCriteria ItemLevelRestoreCriteria[]:

Critérios de Restauro

restoreLocation

string

Região de Restauro de Destino

ItemPathBasedRestoreCriteria

Critérios de prefixo a utilizar durante o restauro

Name Tipo Description
isPathRelativeToBackupItem

boolean

Sinalizar para especificar se o caminho é relativo ao item de cópia de segurança ou ao caminho completo

itemPath

string

O caminho do item a restaurar. Pode ser o caminho completo do item ou o caminho relativo ao item de cópia de segurança

objectType string:

ItemPathBasedRestoreCriteria

Tipo do objeto específico - utilizado para anular a serialização

subItemPathPrefix

string[]

A lista de cadeias de prefixo a utilizar como critérios de filtro durante o restauro. Estes são relativos ao caminho do item especificado.

KubernetesClusterRestoreCriteria

informações de destino da Cópia de Segurança do Cluster do Kubernetes para a operação de restauro

Name Tipo Description
conflictPolicy

ExistingResourcePolicy

Obtém ou define a propriedade Política de Conflitos. Esta propriedade define a política durante o conflito de recursos durante o restauro.

excludedNamespaces

string[]

Obtém ou define a propriedade excluir espaços de nomes. Esta propriedade define os espaços de nomes a serem excluídos durante o restauro.

excludedResourceTypes

string[]

Obtém ou define a propriedade excluir tipos de recursos. Esta propriedade define os tipos de recursos a serem excluídos durante o restauro.

includeClusterScopeResources

boolean

Obtém ou define a propriedade incluir recursos de cluster. Esta propriedade, se ativada, incluirá recursos de âmbito do cluster durante o restauro.

includedNamespaces

string[]

Obtém ou define a propriedade incluir espaços de nomes. Esta propriedade define os espaços de nomes a serem incluídos durante o restauro.

includedResourceTypes

string[]

Obtém ou define a propriedade incluir tipos de recursos. Esta propriedade define os tipos de recursos a serem incluídos durante o restauro.

labelSelectors

string[]

Obtém ou define a propriedade LabelSelectors. Esta propriedade define o recurso com esses seletores de etiquetas para serem incluídos durante o restauro.

namespaceMappings

object

Obtém ou define a propriedade Mapeamentos do Espaço de Nomes. Esta propriedade define se o espaço de nomes tem de ser alterado durante o restauro.

objectType string:

KubernetesClusterRestoreCriteria

Tipo do objeto específico - utilizado para anular a serialização

persistentVolumeRestoreMode

PersistentVolumeRestoreMode

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

KubernetesPVRestoreCriteria

Informações de destino de volume persistente do kubernetes ao nível do item para a operação de restauro

Name Tipo Description
name

string

Nome da afirmação de volume persistente selecionado

objectType string:

KubernetesPVRestoreCriteria

Tipo do objeto específico - utilizado para anular a serialização

storageClassName

string

Nome da classe de armazenamento selecionado para a operação de restauro

KubernetesStorageClassRestoreCriteria

Informações de destino da classe de armazenamento kubernetes ao nível do item para a operação de restauro

Name Tipo Description
objectType string:

KubernetesStorageClassRestoreCriteria

Tipo do objeto específico - utilizado para anular a serialização

provisioner

string

Aprovisionador da classe de armazenamento

selectedStorageClassName

string

Nome da classe de armazenamento selecionado

OperationJobExtendedInfo

OperationJobExtendedInfo

Name Tipo Description
jobId

string

ID do arm da tarefa criada para esta operação.

objectType string:

OperationJobExtendedInfo

Esta propriedade será utilizada como o discriminador para decidir os tipos específicos na cadeia polimórfica de tipos.

PersistentVolumeRestoreMode

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

Name Tipo Description
RestoreWithVolumeData

string

RestoreWithoutVolumeData

string

RangeBasedItemLevelRestoreCriteria

Informações de destino do Nível do Item para a operação de restauro

Name Tipo Description
maxMatchingValue

string

valor máximo da correspondência do prefixo do intervalo

minMatchingValue

string

valor mínimo para correspondência de prefixo de intervalo

objectType string:

RangeBasedItemLevelRestoreCriteria

Tipo do objeto específico - utilizado para anular a serialização

RecoveryOption

Opção de Recuperação

Name Tipo Description
FailIfExists

string

RehydrationPriority

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

Name Tipo Description
High

string

Invalid

string

Standard

string

RestoreFilesTargetInfo

Restauro de encapsulamento de classes como parâmetros de destino de ficheiros

Name Tipo Description
objectType string:

RestoreFilesTargetInfo

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

recoveryOption

RecoveryOption

Opção de Recuperação

restoreLocation

string

Região de Restauro de Destino

targetDetails

TargetDetails

Destino da operação RestoreAsFiles, quando o destino não é uma origem de dados

RestoreTargetInfo

Parâmetros de destino de restauro de encapsulamento de classes

Name Tipo Description
datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

Credenciais a utilizar para autenticar com o fornecedor de origem de dados.

datasourceInfo

Datasource

Origem de dados
Informações do DS de destino

datasourceSetInfo

DatasourceSet

Conjunto de Origens de Dados
Informações do Conjunto de DS de destino

objectType string:

RestoreTargetInfo

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

recoveryOption

RecoveryOption

Opção de Recuperação

restoreLocation

string

Região de Restauro de Destino

RestoreTargetLocationType

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

Name Tipo Description
AzureBlobs

string

AzureFiles

string

Invalid

string

SecretStoreBasedAuthCredentials

Credenciais de autenticação baseadas em arquivo secreto.

Name Tipo Description
objectType string:

SecretStoreBasedAuthCredentials

Tipo do objeto específico - utilizado para anular a serialização

secretStoreResource

SecretStoreResource

Recurso de arquivo secreto

SecretStoreResource

Classe que representa um recurso de arquivo secreto.

Name Tipo Description
secretStoreType

SecretStoreType

Obtém ou define o tipo de arquivo secreto

uri

string

Uri para aceder ao recurso

value

string

Obtém ou define o valor armazenado no recurso do arquivo de segredos

SecretStoreType

Obtém ou define o tipo de arquivo secreto

Name Tipo Description
AzureKeyVault

string

Invalid

string

SourceDataStoreType

Obtém ou define o tipo de arquivo de dados de origem.

Name Tipo Description
ArchiveStore

string

OperationalStore

string

SnapshotStore

string

VaultStore

string

TargetDetails

Detalhes de destino de encapsulamento de classes, utilizados em que o destino não é uma origem de dados

Name Tipo Description
filePrefix

string

A operação de restauro pode criar vários ficheiros dentro da localização apontados pelo URL Abaixo será o prefixo comum para todos eles

restoreTargetLocationType

RestoreTargetLocationType

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

targetResourceArmId

string

O ID do ARM completo indica o destino do restauro. É o ID do ARM que aponta para a partilha de contentores/ficheiros Isto é opcional se a subscrição de destino puder ser identificada com o campo URL. Caso contrário, será necessário se o campo CrossSubscriptionRestore do BackupVault estiver em qualquer um dos estados desativados

url

string

Url a indicar o destino do restauro. Pode apontar para contentor/partilha de ficheiros, etc.

ValidateRestoreRequestObject

ValidateRestoreRequestObject

Name Tipo Description
restoreRequestObject AzureBackupRestoreRequest:

AzureBackupRestoreRequest
Obtém ou define o objeto de pedido de restauro.