Backup Instances - Validate For Backup

Referência

Serviço:: Data Protection

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

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup?api-version=2025-01-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.
vaultName	path	True	string	O nome do cofre de backup.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
backupInstance	True	BackupInstance	Instância de Backup

Respostas

Nome	Tipo	Description
200 OK	OperationJobExtendedInfo	Contém informações adicionais, como a ID do trabalho
202 Accepted		A operação será concluída de forma assíncrona. Cabeçalhos Location: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

OperationJobExtendedInfo

Contém informações adicionais, como a ID do trabalho

202 Accepted

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

Cabeçalhos

Location: string
Azure-AsyncOperation: string
Retry-After: integer

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

Validate For Backup

Solicitação de exemplo

HTTP

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

{
  "backupInstance": {
    "objectType": "BackupInstance",
    "friendlyName": "harshitbi2",
    "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": "OssDB"
    },
    "dataSourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    }
  }
}

Resposta de exemplo

Código de status:: 202

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

Código de status:: 200

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

Definições

Nome	Description
AKSVolumeTypes	Obtém ou define a propriedade incluir tipos de volume. Essa propriedade define os tipos de volume a serem incluídos durante o backup.
AzureOperationalStoreParameters	Parâmetros para Operational-Tier DataStore
BackupInstance	Instância de Backup
BlobBackupDatasourceParameters	Parâmetros a serem usados durante a configuração do backup de blobs
CloudError	CloudError
CurrentProtectionState	Especifica o estado de proteção atual do recurso
Datasource	Fonte de dados
DatasourceSet	Conjunto de Fontes de Dados
DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto
DefaultResourceProperties	Propriedades de origem padrão
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
IdentityDetails
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Parâmetros para a fonte de dados de backup do cluster do Kubernetes
NamespacedNameResource	NamespacedNameResource
OperationJobExtendedInfo	OperationJobExtendedInfo
PolicyInfo	PolicyInfo
PolicyParameters	Parâmetros na política
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	Credenciais de autenticação baseadas em repositório secreto.
SecretStoreResource	Classe que representa um recurso do repositório de segredos.
SecretStoreType	Obtém ou define o tipo de repositório secreto
Status	Especifica o status de proteção do recurso
UserFacingError	Objeto de erro usado por camadas que têm acesso ao conteúdo localizado e propagam isso para o usuário
ValidateForBackupRequest	ValidateForBackupRequest
ValidationType	Especifica o tipo de validação. No caso do DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

AKSVolumeTypes

Enumeration

Obtém ou define a propriedade incluir tipos de volume. Essa propriedade define os tipos de volume a serem incluídos durante o backup.

Valor	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Parâmetros para Operational-Tier DataStore

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

BackupInstance

Object

Instância de Backup

Nome	Tipo	Description
currentProtectionState	CurrentProtectionState	Especifica o estado de proteção atual do recurso
dataSourceInfo	Datasource	Fonte de dados Obtém ou define as informações da fonte de dados.
dataSourceSetInfo	DatasourceSet	Conjunto de Fontes de Dados 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 de 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 nulo, o padrão será considerado como Atribuído pelo Sistema.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Obtém ou define as informações da política.
protectionErrorDetails	UserFacingError	Especifica o erro de proteção do recurso
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails Especifica o status de proteção do recurso
provisioningState	string	Especifica o estado de provisionamento do recurso, ou seja, provisionamento/atualização/êxito/com falha
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests no qual a verificação LAC será executada
validationType	ValidationType	Especifica o tipo de validação. No caso do DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

BlobBackupDatasourceParameters

Object

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

Nome	Tipo	Description
containersList	string[]	Lista de contêineres a serem armazenados em backup durante a configuração do backup de blobs
objectType	string: BlobBackupDatasourceParameters	Tipo do objeto específico – usado para desserializar

CloudError

Object

CloudError

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

CurrentProtectionState

Enumeration

Especifica o estado de proteção atual do recurso

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

Datasource

Object

Fonte de dados

Nome	Tipo	Description
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
resourceID	string	ID completa do ARM do recurso. Para recursos do Azure, essa é a ID do ARM. Para recursos que não são do Azure, essa será a ID criada pelo serviço de backup por meio do Fabric/Vault.
resourceLocation	string	Local 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 de fonte de dados.
resourceUri	string	Uri do recurso.

DatasourceSet

Object

Conjunto de Fontes de Dados

Nome	Tipo	Description
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto
resourceID	string	ID completa do ARM do recurso. Para recursos do Azure, essa é a ID do ARM. Para recursos que não são do Azure, essa será a ID criada pelo serviço de backup por meio do Fabric/Vault.
resourceLocation	string	Local 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 de fonte de dados.
resourceUri	string	Uri do recurso.

DataStoreTypes

Enumeration

tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto

Valor	Description
ArchiveStore
OperationalStore
VaultStore

DefaultResourceProperties

Object

Propriedades de origem padrão

Nome	Tipo	Description
objectType	string: DefaultResourceProperties	Tipo do objeto específico – usado para desserializar

Error

Object

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

Object

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.

IdentityDetails

Object

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

InnerError

Object

InnerError

Nome	Tipo	Description
additionalInfo	object	Todos os pares de valor chave que podem ser fornecidos ao cliente para obter informações detalhadas adicionais.
code	string	Código exclusivo para este erro
embeddedInnerError	InnerError	InnerError Erro interno filho, para permitir o aninhamento.

KubernetesClusterBackupDatasourceParameters

Object

Parâmetros para a fonte de dados de backup do cluster do Kubernetes

Nome	Tipo	Description
backupHookReferences	NamespacedNameResource[]	Obtém ou define as referências de gancho de backup. Essa propriedade define a referência de gancho a ser executada durante o backup.
excludedNamespaces	string[]	Obtém ou define a propriedade excluir namespaces. Essa propriedade define os namespaces a serem excluídos durante o backup.
excludedResourceTypes	string[]	Obtém ou define a propriedade excluir tipos de recurso. Essa propriedade define os tipos de recurso a serem excluídos durante o backup.
includeClusterScopeResources	boolean	Obtém ou define a propriedade incluir recursos de cluster. Essa propriedade, se habilitada, incluirá recursos de escopo de cluster durante o backup.
includedNamespaces	string[]	Obtém ou define a propriedade de namespaces de inclusão. Essa propriedade define os namespaces a serem incluídos durante o backup.
includedResourceTypes	string[]	Obtém ou define a propriedade incluir tipos de recurso. Essa propriedade define os tipos de recurso a serem incluídos durante o backup.
includedVolumeTypes	AKSVolumeTypes[]	Obtém ou define a propriedade incluir tipos de volume. Essa propriedade define os tipos de volume a serem incluídos durante o backup.
labelSelectors	string[]	Obtém ou define a propriedade LabelSelectors. Essa 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 desserializar
snapshotVolumes	boolean	Obtém ou define a propriedade de instantâneo de volume. Essa propriedade, se habilitada, tirará instantâneos de volume durante o backup.

NamespacedNameResource

Object

NamespacedNameResource

Nome	Tipo	Description
name	string	Nome do recurso
namespace	string	Namespace no qual o recurso existe

OperationJobExtendedInfo

Object

OperationJobExtendedInfo

Nome	Tipo	Description
jobId	string	Nome ou ID do braço do trabalho criado para esta operação.
objectType	string: OperationJobExtendedInfo	Essa propriedade será usada como discriminatória para decidir os tipos específicos na cadeia polimórfica de tipos.

PolicyInfo

Object

PolicyInfo

Nome	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

Nome	Tipo	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: 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 do DataStore

ProtectionStatusDetails

Object

ProtectionStatusDetails

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

SecretStoreBasedAuthCredentials

Object

Credenciais de autenticação baseadas em repositório secreto.

Nome	Tipo	Description
objectType	string: SecretStoreBasedAuthCredentials	Tipo do objeto específico – usado para desserializar
secretStoreResource	SecretStoreResource	Recurso do repositório de segredos

SecretStoreResource

Object

Classe que representa um recurso do repositório de segredos.

Nome	Tipo	Description
secretStoreType	SecretStoreType	Obtém ou define o tipo de repositório secreto
uri	string	Uri para acessar o recurso
value	string	Obtém ou define o valor armazenado no recurso do repositório de segredos

SecretStoreType

Enumeration

Obtém ou define o tipo de repositório secreto

Valor	Description
AzureKeyVault
Invalid

Status

Enumeration

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 ao conteúdo localizado e propagam isso para o usuário

Nome	Tipo	Description
code	string	Código exclusivo para este erro
details	UserFacingError[]	Erros adicionais relacionados
innerError	InnerError	InnerError Erro interno
isRetryable	boolean	Se a operação será repetível ou não
isUserError	boolean	Se a operação é devido a um erro de usuário ou erro de serviço
message	string
properties	object	Todos os pares de valores de chave que podem ser injetados dentro do objeto de erro
recommendedAction	string[]	RecommendedAction localizado.
target	string	Destino do erro.

ValidateForBackupRequest

Object

ValidateForBackupRequest

Nome	Tipo	Description
backupInstance	BackupInstance	Instância de Backup

ValidationType

Enumeration

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

Valor	Description
DeepValidation
ShallowValidation

Compartilhar via

Backup Instances - Validate For Backup

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Validate For Backup

Solicitação de exemplo

Resposta de exemplo

Definições

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BlobBackupDatasourceParameters

CloudError

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

OperationJobExtendedInfo

PolicyInfo

PolicyParameters

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

UserFacingError

ValidateForBackupRequest

ValidationType

Recursos adicionais