Backup Instances - Validate For Backup

Serviço:: Data Protection

Versão da API:: 2025-09-01

Validar se o backup adhoc será bem-sucedido ou não

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup?api-version=2025-09-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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)	A ID da assinatura de destino. O valor deve ser um UUID.
vaultName	path	True	string	O nome do BackupVaultResource
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
backupInstance	True	BackupInstance	Instância de backup

Respostas

Name	Tipo	Description
200 OK	OperationJobExtendedInfo	Operação do Azure concluída com êxito.
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

Description

200 OK

OperationJobExtendedInfo

Operação do Azure concluída com êxito.

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	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Validate For Backup

Pedido de amostra

HTTP

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

{
  "backupInstance": {
    "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": ""
    },
    "datasourceAuthCredentials": {
      "objectType": "SecretStoreBasedAuthCredentials",
      "secretStoreResource": {
        "secretStoreType": "AzureKeyVault",
        "uri": "https://samplevault.vault.azure.net/secrets/credentials"
      }
    },
    "friendlyName": "harshitbi2",
    "identityDetails": {
      "useSystemAssignedIdentity": false,
      "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourcegroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
    },
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    }
  }
}

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==?api-version=2025-09-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

Definições

Name	Description
AdlsBlobBackupDatasourceParameters	Parâmetros a serem usados durante a configuração do backup de blobs de conta de armazenamento do azure data lake
AKSVolumeTypes
AzureOperationalStoreParameters	Parâmetros para Operational-Tier DataStore
BackupInstance	Instância de backup
BlobBackupDatasourceParameters	Parâmetros a serem usados durante a configuração de backup de blobs
CloudError	Uma resposta de erro do Backup do Azure.
CurrentProtectionState	Especifica o estado de proteção atual do recurso
Datasource	Fonte de dados para backup
DatasourceSet	DatasourceDefina detalhes da fonte de dados para backup
DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo
DefaultResourceProperties	Propriedades de origem padrão
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
IdentityDetails
InnerError	Erro interno
KubernetesClusterBackupDatasourceParameters	Parâmetros para a fonte de dados do Kubernetes Cluster Backup
NamespacedNameResource	Classe para referenciar recursos que contém namespace e nome
OperationJobExtendedInfo	Informações estendidas do trabalho de operação
PolicyInfo	Informações de política em backupInstance
PolicyParameters	Parâmetros na Política
ProtectionStatusDetails	Detalhes do status da proteção
ResourcePropertiesObjectType	Tipo do objeto específico - usado para desserialização
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
Status	Especifica o status de proteção do recurso
UserFacingError	Objeto de erro usado por camadas que têm acesso a conteúdo localizado e propagam isso para o usuário
ValidateForBackupRequest	Validar para solicitação de backup
ValidationType	Especifica o tipo de validação. No caso de DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

AdlsBlobBackupDatasourceParameters

Object

Parâmetros a serem usados durante a configuração do backup de blobs de conta de armazenamento do azure data lake

Name	Tipo	Description
containersList	string[]	Lista de contêineres para backup durante a configuração de backup de blobs
objectType	string: AdlsBlobBackupDatasourceParameters	Tipo do objeto específico - usado para desserialização

AKSVolumeTypes

Enumeração

Valor	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Parâmetros para Operational-Tier DataStore

Name	Tipo	Description
dataStoreType	DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo
objectType	string: AzureOperationalStoreParameters	Tipo do objeto específico - usado para desserialização
resourceGroupId	string	Obtém ou define o Uri do Grupo de Recursos de Instantâneo.

BackupInstance

Object

Instância de backup

Name	Tipo	Description
currentProtectionState	CurrentProtectionState	Especifica o estado de proteção atual do recurso
dataSourceInfo	Datasource	Obtém ou define as informações da fonte de dados.
dataSourceSetInfo	DatasourceSet	Obtém ou define as informações do conjunto de fontes de dados.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenciais a serem usadas para autenticar com o provedor da fonte de dados.
friendlyName	string	Obtém ou define o nome amigável da instância de backup.
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
policyInfo	PolicyInfo	Obtém ou define as informações da política.
protectionErrorDetails	UserFacingError	Especifica o erro de proteção do recurso
protectionStatus	ProtectionStatusDetails	Especifica o status de proteção do recurso
provisioningState	string	Especifica o estado de provisionamento do recurso, ou seja, provisionamento/atualização/êxito/falha
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests em que a verificação LAC será executada
validationType	ValidationType	Especifica o tipo de validação. No caso de DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

BlobBackupDatasourceParameters

Object

Parâmetros a serem usados durante a configuração de backup de blobs

Name	Tipo	Description
containersList	string[]	Lista de contêineres para backup durante a configuração de backup de blobs
objectType	string: BlobBackupDatasourceParameters	Tipo do objeto específico - usado para desserialização

CloudError

Object

Uma resposta de erro do Backup do Azure.

Name	Tipo	Description
error	Error	A resposta de erro de gerenciamento de recursos.

CurrentProtectionState

Enumeração

Especifica o estado de proteção atual do recurso

Valor	Description
Invalid
NotProtected
ConfiguringProtection
ProtectionConfigured
BackupSchedulesSuspended
RetentionSchedulesSuspended
ProtectionStopped
ProtectionError
ConfiguringProtectionFailed
SoftDeleting
SoftDeleted
UpdatingProtection

Datasource

Object

Fonte de dados para backup

Name	Tipo	Description
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, essa será a ID criada 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	Description
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, essa será a ID criada 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.

DataStoreTypes

Enumeração

tipo de armazenamento de dados; Operacional/Cofre/Arquivo

Valor	Description
OperationalStore
VaultStore
ArchiveStore

DefaultResourceProperties

Object

Propriedades de origem padrão

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

Error

Object

A resposta de erro de gerenciamento de recursos.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

O erro de gerenciamento de recursos informações adicionais.

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

IdentityDetails

Object

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

InnerError

Object

Erro interno

Name	Tipo	Description
additionalInfo	object	Quaisquer pares de valores de chave que possam ser fornecidos ao cliente para obter informações detalhadas adicionais.
code	string	Código exclusivo para este erro
embeddedInnerError	InnerError	Erro interno da criança, para permitir o aninhamento.

KubernetesClusterBackupDatasourceParameters

Object

Parâmetros para a fonte de dados do Kubernetes Cluster Backup

Name	Tipo	Description
backupHookReferences	NamespacedNameResource[]	Obtém ou define as referências de gancho de backup. Esta propriedade define a referência de gancho a ser executada durante o backup.
excludedNamespaces	string[]	Obtém ou define a propriedade exclude namespaces. Esta propriedade define os namespaces a serem excluídos durante o backup.
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 backup.
includeClusterScopeResources	boolean	Obtém ou define a propriedade include cluster resources. Essa propriedade, se habilitada, incluirá recursos de escopo de cluster durante o backup.
includedNamespaces	string[]	Obtém ou define a propriedade include namespaces. Esta propriedade define os namespaces a serem incluídos durante o backup.
includedResourceTypes	string[]	Obtém ou define a propriedade include resource types. Esta propriedade define os tipos de recursos a serem incluídos durante o backup.
includedVolumeTypes	AKSVolumeTypes[]	Obtém ou define a propriedade include volume types. Esta propriedade define os tipos de volume a serem incluídos durante o backup.
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 o backup.
objectType	string: KubernetesClusterBackupDatasourceParameters	Tipo do objeto específico - usado para desserialização
snapshotVolumes	boolean	Obtém ou define a propriedade de instantâneo de volume. Essa propriedade, se ativada, tirará instantâneos de volume durante o backup.

NamespacedNameResource

Object

Classe para referenciar recursos que contém namespace e nome

Name	Tipo	Description
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	Description
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.

PolicyInfo

Object

Informações de política em backupInstance

Name	Tipo	Description
policyId	string
policyParameters	PolicyParameters	Parâmetros de política para a instância de backup
policyVersion	string

PolicyParameters

Object

Parâmetros na Política

Name	Tipo	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: AdlsBlobBackupDatasourceParameters[] BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Obtém ou define os parâmetros da fonte de dados de backup
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Obtém ou define os parâmetros DataStore

ProtectionStatusDetails

Object

Detalhes do status da proteção

Name	Tipo	Description
errorDetails	UserFacingError	Especifica o erro de status de proteção do recurso
status	Status	Especifica o status de proteção do recurso

ResourcePropertiesObjectType

Enumeração

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

Valor	Description
DefaultResourceProperties

SecretStoreBasedAuthCredentials

Object

Credenciais de autenticação baseadas em armazenamento secreto.

Name	Tipo	Description
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	Description
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	Description
Invalid
AzureKeyVault

Status

Enumeração

Especifica o status de proteção do recurso

Valor	Description
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Object

Objeto de erro usado por camadas que têm acesso a conteúdo localizado e propagam isso para o usuário

Name	Tipo	Description
code	string	Código exclusivo para este erro
details	UserFacingError[]	Erros adicionais relacionados
innerError	InnerError	Erro interno
isRetryable	boolean	Se a operação será repetida ou não
isUserError	boolean	Se a operação é devido a um erro do usuário ou erro de serviço
message	string
properties	object	Qualquer par de valores de chave que possa ser injetado dentro do objeto de erro
recommendedAction	string[]	RecommendedAction localizado.
target	string	Alvo do erro.

ValidateForBackupRequest

Object

Validar para solicitação de backup

Name	Tipo	Description
backupInstance	BackupInstance	Instância de backup

ValidationType

Enumeração

Especifica o tipo de validação. No caso de DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

Valor	Description
ShallowValidation
DeepValidation

Partilhar via

Backup Instances - Validate For Backup

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Validate For Backup

Pedido de amostra

Resposta da amostra

Definições

AdlsBlobBackupDatasourceParameters

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BlobBackupDatasourceParameters

CloudError

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

OperationJobExtendedInfo

PolicyInfo

PolicyParameters

ProtectionStatusDetails

ResourcePropertiesObjectType

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

UserFacingError

ValidateForBackupRequest

ValidationType