Backup Instances - Validate For Backup

Validar se a cópia de segurança adhoc será ou não bem-sucedida

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

Parâmetros do URI

Name Em Necessário Tipo Description
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
backupInstance True

BackupInstance

Instância de Cópia de Segurança

Respostas

Name Tipo Description
200 OK

OperationJobExtendedInfo

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

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 o motivo 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 For Backup

Sample Request

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/validateForBackup?api-version=2023-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"
    }
  }
}

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
AzureOperationalStoreParameters

Parâmetros para Operational-Tier DataStore

BackupInstance

Instância de Cópia de Segurança

BlobBackupDatasourceParameters

Parâmetros a utilizar durante a configuração da cópia de segurança de blobs

CloudError

CloudError

CurrentProtectionState

Especifica o estado de proteção atual do recurso

Datasource

Origem de dados

DatasourceSet

Conjunto de Origens de Dados

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

Error

A resposta ao erro de gestão de recursos.

ErrorAdditionalInfo

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

InnerError

InnerError

KubernetesClusterBackupDatasourceParameters

Parâmetros para a Origem de Dados de Cópia de Segurança do Cluster do Kubernetes

OperationJobExtendedInfo

OperationJobExtendedInfo

PolicyInfo

PolicyInfo

PolicyParameters

Parâmetros na Política

ProtectionStatusDetails

ProtectionStatusDetails

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 de segredos

Status

Especifica o estado de proteção do recurso

UserFacingError

Objeto de erro utilizado por camadas que têm acesso a conteúdo localizado e propaga-o para o utilizador

ValidateForBackupRequest

ValidateForBackupRequest

ValidationType

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

AzureOperationalStoreParameters

Parâmetros para Operational-Tier DataStore

Name Tipo Description
dataStoreType

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

objectType string:

AzureOperationalStoreParameters

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

resourceGroupId

string

Obtém ou define o Uri do Grupo de Recursos de Instantâneo.

BackupInstance

Instância de Cópia de Segurança

Name Tipo Description
currentProtectionState

CurrentProtectionState

Especifica o estado de proteção atual do recurso

dataSourceInfo

Datasource

Origem de dados
Obtém ou define as informações da origem de dados.

dataSourceSetInfo

DatasourceSet

Conjunto de Origens de Dados
Obtém ou define as informações do conjunto de origens de dados.

datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

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

friendlyName

string

Obtém ou define o nome amigável da Instância de Cópia de Segurança.

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 estado de proteção do recurso

provisioningState

string

Especifica o estado de aprovisionamento do recurso, ou seja, aprovisionamento/atualização/Com êxito/Falha

validationType

ValidationType

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

BlobBackupDatasourceParameters

Parâmetros a utilizar durante a configuração da cópia de segurança de blobs

Name Tipo Description
containersList

string[]

Lista de contentores a criar cópias de segurança durante a configuração da cópia de segurança de blobs

objectType string:

BlobBackupDatasourceParameters

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

CloudError

CloudError

Name Tipo Description
error

Error

A resposta ao erro de gestão de recursos.

CurrentProtectionState

Especifica o estado de proteção atual do recurso

Name Tipo Description
BackupSchedulesSuspended

string

ConfiguringProtection

string

ConfiguringProtectionFailed

string

Invalid

string

NotProtected

string

ProtectionConfigured

string

ProtectionError

string

ProtectionStopped

string

RetentionSchedulesSuspended

string

SoftDeleted

string

SoftDeleting

string

UpdatingProtection

string

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.

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

Name Tipo Description
ArchiveStore

string

OperationalStore

string

VaultStore

string

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.

InnerError

InnerError

Name Tipo Description
additionalInfo

object

Todos os pares chave de valor que podem ser fornecidos ao cliente para obter informações verbosas adicionais.

code

string

Código exclusivo para este erro

embeddedInnerError

InnerError

InnerError
Erro Interno subordinado, para permitir o Aninhamento.

KubernetesClusterBackupDatasourceParameters

Parâmetros para a Origem de Dados de Cópia de Segurança do Cluster do Kubernetes

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

objectType string:

KubernetesClusterBackupDatasourceParameters

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

snapshotVolumes

boolean

Obtém ou define a propriedade instantâneo de volume. Esta propriedade, se ativada, terá instantâneos de volume durante o restauro.

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.

PolicyInfo

PolicyInfo

Name Tipo Description
policyId

string

policyParameters

PolicyParameters

Parâmetros de política para a instância de cópia de segurança

policyVersion

string

PolicyParameters

Parâmetros na Política

Name Tipo Description
backupDatasourceParametersList BackupDatasourceParameters[]:

Obtém ou define os Parâmetros da Origem de Dados de Cópia de Segurança

dataStoreParametersList DataStoreParameters[]:

AzureOperationalStoreParameters[]

Obtém ou define os Parâmetros do DataStore

ProtectionStatusDetails

ProtectionStatusDetails

Name Tipo Description
errorDetails

UserFacingError

Especifica o erro de estado de proteção do recurso

status

Status

Especifica o estado de proteção do recurso

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 de segredos

Name Tipo Description
AzureKeyVault

string

Invalid

string

Status

Especifica o estado de proteção do recurso

Name Tipo Description
ConfiguringProtection

string

ConfiguringProtectionFailed

string

ProtectionConfigured

string

ProtectionStopped

string

SoftDeleted

string

SoftDeleting

string

UserFacingError

Objeto de erro utilizado por camadas que têm acesso a conteúdo localizado e propaga-o para o utilizador

Name Tipo Description
code

string

Código exclusivo para este erro

details

UserFacingError[]

Erros Relacionados Adicionais

innerError

InnerError

InnerError
Erro Interno

isRetryable

boolean

Se a operação será ou não reativada

isUserError

boolean

Se a operação se deve a um erro de utilizador ou erro de serviço

message

string

properties

object

Todos os pares de valores chave que podem ser injetados dentro do objeto de erro

recommendedAction

string[]

RecommendedAction localizado.

target

string

Destino do erro.

ValidateForBackupRequest

ValidateForBackupRequest

Name Tipo Description
backupInstance

BackupInstance

Instância de Cópia de Segurança

ValidationType

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

Name Tipo Description
DeepValidation

string

ShallowValidation

string