Backup Instances - Validate For Backup

Tjänst:: Data Protection

API-version:: 2025-09-01

Kontrollera om adhoc-säkerhetskopieringen lyckas eller inte

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
vaultName	path	True	string	Namnet på BackupVaultResource
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
backupInstance	True	BackupInstance	Säkerhetskopieringsinstans

Svar

Name	Typ	Description
200 OK	OperationJobExtendedInfo	Azure-åtgärden har slutförts.
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	Ett oväntat felsvar.

Name

Typ

Description

200 OK

OperationJobExtendedInfo

Azure-åtgärden har slutförts.

202 Accepted

Resursåtgärden har godkänts.

Sidhuvuden

Azure-AsyncOperation: string
Location: string

Other Status Codes

CloudError

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Validate For Backup

Exempelbegäran

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"
    }
  }
}

Exempelsvar

Statuskod:: 200

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

Statuskod:: 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

Definitioner

Name	Description
AdlsBlobBackupDatasourceParameters	Parametrar som ska användas vid konfiguration av säkerhetskopiering av Azure Data Lake Storage-kontoblobar
AKSVolumeTypes
AzureOperationalStoreParameters	Parametrar för Operational-Tier DataStore
BackupInstance	Säkerhetskopieringsinstans
BlobBackupDatasourceParameters	Parametrar som ska användas vid konfiguration av säkerhetskopiering av blobar
CloudError	Ett felsvar från Azure Backup.
CurrentProtectionState	Anger resursens aktuella skyddstillstånd
Datasource	Datakälla som ska säkerhetskopieras
DatasourceSet	DatasourceSet-information om datakälla som ska säkerhetskopieras
DataStoreTypes	typ av datalager. Operational/Vault/Archive
DefaultResourceProperties	Standardkällegenskaper
Error	Svar på resurshanteringsfel.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
IdentityDetails
InnerError	Inre fel
KubernetesClusterBackupDatasourceParameters	Parametrar för Kubernetes-klustersäkerhetskopieringsdatakälla
NamespacedNameResource	Klass för att referera till resurser som innehåller namnområde och namn
OperationJobExtendedInfo	Utökad information om åtgärdsjobb
PolicyInfo	Principinformation i backupInstance
PolicyParameters	Parametrar i princip
ProtectionStatusDetails	Information om skyddsstatus
ResourcePropertiesObjectType	Typ av det specifika objektet – används för deserialisering
SecretStoreBasedAuthCredentials	Hemliga lagringsbaserade autentiseringsuppgifter.
SecretStoreResource	Klass som representerar en hemlig lagringsresurs.
SecretStoreType	Hämtar eller anger typen av hemligt arkiv
Status	Anger resursens skyddsstatus
UserFacingError	Felobjekt som används av lager som har åtkomst till lokaliserat innehåll och som sprids till användaren
ValidateForBackupRequest	Verifiera för säkerhetskopieringsbegäran
ValidationType	Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

AdlsBlobBackupDatasourceParameters

Objekt

Parametrar som ska användas vid konfiguration av säkerhetskopiering av Azure Data Lake Storage-kontoblobar

Name	Typ	Description
containersList	string[]	Lista över containrar som ska säkerhetskopieras under konfigurationen av säkerhetskopiering av blobar
objectType	string: AdlsBlobBackupDatasourceParameters	Typ av det specifika objektet – används för deserialisering

AKSVolumeTypes

Uppräkning

Värde	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Objekt

Parametrar för Operational-Tier DataStore

Name	Typ	Description
dataStoreType	DataStoreTypes	typ av datalager. Operational/Vault/Archive
objectType	string: AzureOperationalStoreParameters	Typ av det specifika objektet – används för deserialisering
resourceGroupId	string	Hämtar eller anger URI:n för resursgruppen för ögonblicksbilder.

BackupInstance

Objekt

Säkerhetskopieringsinstans

Name	Typ	Description
currentProtectionState	CurrentProtectionState	Anger resursens aktuella skyddstillstånd
dataSourceInfo	Datasource	Hämtar eller anger datakällans information.
dataSourceSetInfo	DatasourceSet	Hämtar eller anger datakällans uppsättningsinformation.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Autentiseringsuppgifter som ska användas för att autentisera med datakällans provider.
friendlyName	string	Hämtar eller anger det egna namnet på säkerhetskopieringsinstansen.
identityDetails	IdentityDetails	Innehåller information om identitetsinformationen för BI. Om den är null betraktas standardvärdet som Systemtilldelade.
objectType	string
policyInfo	PolicyInfo	Hämtar eller anger principinformationen.
protectionErrorDetails	UserFacingError	Anger resursens skyddsfel
protectionStatus	ProtectionStatusDetails	Anger resursens skyddsstatus
provisioningState	string	Anger etableringstillståndet för resursen, t.ex. etablering/uppdatering/Lyckades/Misslyckades
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests som LAC-kontrollen ska utföras på
validationType	ValidationType	Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

BlobBackupDatasourceParameters

Objekt

Parametrar som ska användas vid konfiguration av säkerhetskopiering av blobar

Name	Typ	Description
containersList	string[]	Lista över containrar som ska säkerhetskopieras under konfigurationen av säkerhetskopiering av blobar
objectType	string: BlobBackupDatasourceParameters	Typ av det specifika objektet – används för deserialisering

CloudError

Objekt

Ett felsvar från Azure Backup.

Name	Typ	Description
error	Error	Svar på resurshanteringsfel.

CurrentProtectionState

Uppräkning

Anger resursens aktuella skyddstillstånd

Värde	Description
Invalid
NotProtected
ConfiguringProtection
ProtectionConfigured
BackupSchedulesSuspended
RetentionSchedulesSuspended
ProtectionStopped
ProtectionError
ConfiguringProtectionFailed
SoftDeleting
SoftDeleted
UpdatingProtection

Datasource

Objekt

Datakälla som ska säkerhetskopieras

Name	Typ	Description
datasourceType	string	DatasourceType för resursen.
objectType	string	Typ av Datasource-objekt som används för att initiera rätt ärvd typ
resourceID	string	Fullständigt ARM-ID för resursen. För Azure-resurser är detta ARM-ID. För icke-azure-resurser är detta det ID som skapas av säkerhetskopieringstjänsten via Fabric/Vault.
resourceLocation	string	Plats för datakälla.
resourceName	string	Unik identifierare för resursen i kontexten överordnad.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Egenskaper som är specifika för datakällan
resourceType	string	Resurstyp för datakälla.
resourceUri	string	Resursens URI.

DatasourceSet

Objekt

DatasourceSet-information om datakälla som ska säkerhetskopieras

Name	Typ	Description
datasourceType	string	DatasourceType för resursen.
objectType	string	Typ av Datasource-objekt som används för att initiera rätt ärvd typ
resourceID	string	Fullständigt ARM-ID för resursen. För Azure-resurser är detta ARM-ID. För icke-azure-resurser är detta det ID som skapas av säkerhetskopieringstjänsten via Fabric/Vault.
resourceLocation	string	Plats för datakälla.
resourceName	string	Unik identifierare för resursen i kontexten överordnad.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Egenskaper som är specifika för datakällans uppsättning
resourceType	string	Resurstyp för datakälla.
resourceUri	string	Resursens URI.

DataStoreTypes

Uppräkning

typ av datalager. Operational/Vault/Archive

Värde	Description
OperationalStore
VaultStore
ArchiveStore

DefaultResourceProperties

Objekt

Standardkällegenskaper

Name	Typ	Description
objectType	string: DefaultResourceProperties	Typ av det specifika objektet – används för deserialisering

Error

Objekt

Svar på resurshanteringsfel.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	Error[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

IdentityDetails

Objekt

Name	Typ	Description
useSystemAssignedIdentity	boolean	Anger om BI skyddas av systemidentitet.
userAssignedIdentityArmUrl	string	ARM-URL för användartilldelad identitet.

InnerError

Objekt

Inre fel

Name	Typ	Description
additionalInfo	object	Alla nyckelvärdepar som kan tillhandahållas klienten för ytterligare utförlig information.
code	string	Unik kod för det här felet
embeddedInnerError	InnerError	Underordnat inre fel för att tillåta kapsling.

KubernetesClusterBackupDatasourceParameters

Objekt

Parametrar för Kubernetes-klustersäkerhetskopieringsdatakälla

Name	Typ	Description
backupHookReferences	NamespacedNameResource[]	Hämtar eller anger referenserna för säkerhetskopieringskroken. Den här egenskapen anger att hookreferensen ska köras under säkerhetskopieringen.
excludedNamespaces	string[]	Hämtar eller anger egenskapen exclude namespaces. Den här egenskapen anger vilka namnområden som ska undantas under säkerhetskopieringen.
excludedResourceTypes	string[]	Hämtar eller anger egenskapen exkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska undantas under säkerhetskopieringen.
includeClusterScopeResources	boolean	Hämtar eller anger egenskapen inkludera klusterresurser. Den här egenskapen om den är aktiverad innehåller resurser för klusteromfång under säkerhetskopieringen.
includedNamespaces	string[]	Hämtar eller anger egenskapen include namespaces. Den här egenskapen anger vilka namnområden som ska inkluderas under säkerhetskopieringen.
includedResourceTypes	string[]	Hämtar eller anger egenskapen inkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska ingå under säkerhetskopieringen.
includedVolumeTypes	AKSVolumeTypes[]	Hämtar eller anger egenskapen inkludera volymtyper. Den här egenskapen anger vilka volymtyper som ska ingå under säkerhetskopieringen.
labelSelectors	string[]	Hämtar eller anger egenskapen LabelSelectors. Den här egenskapen anger resursen med sådana etikettväljare som ska inkluderas under säkerhetskopieringen.
objectType	string: KubernetesClusterBackupDatasourceParameters	Typ av det specifika objektet – används för deserialisering
snapshotVolumes	boolean	Hämtar eller anger egenskapen för ögonblicksbild av volymen. Den här egenskapen om den är aktiverad tar ögonblicksbilder av volymen under säkerhetskopieringen.

NamespacedNameResource

Objekt

Klass för att referera till resurser som innehåller namnområde och namn

Name	Typ	Description
name	string	Namn på resursen
namespace	string	Namnområde där resursen finns

OperationJobExtendedInfo

Objekt

Utökad information om åtgärdsjobb

Name	Typ	Description
jobId	string	Namn eller arm-ID för jobbet som skapades för den här åtgärden.
objectType	string: OperationJobExtendedInfo	Den här egenskapen används som diskriminerande för att bestämma de specifika typerna i den polymorfa typkedjan.

PolicyInfo

Objekt

Principinformation i backupInstance

Name	Typ	Description
policyId	string
policyParameters	PolicyParameters	Principparametrar för säkerhetskopieringsinstansen
policyVersion	string

PolicyParameters

Objekt

Parametrar i princip

Name	Typ	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: AdlsBlobBackupDatasourceParameters[] BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Hämtar eller anger parametrar för säkerhetskopiering av datakälla
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Hämtar eller anger DataStore-parametrarna

ProtectionStatusDetails

Objekt

Information om skyddsstatus

Name	Typ	Description
errorDetails	UserFacingError	Anger resursens skyddsstatusfel
status	Status	Anger resursens skyddsstatus

ResourcePropertiesObjectType

Uppräkning

Typ av det specifika objektet – används för deserialisering

Värde	Description
DefaultResourceProperties

SecretStoreBasedAuthCredentials

Objekt

Hemliga lagringsbaserade autentiseringsuppgifter.

Name	Typ	Description
objectType	string: SecretStoreBasedAuthCredentials	Typ av det specifika objektet – används för deserialisering
secretStoreResource	SecretStoreResource	Resurs för hemligt arkiv

SecretStoreResource

Objekt

Klass som representerar en hemlig lagringsresurs.

Name	Typ	Description
secretStoreType	SecretStoreType	Hämtar eller anger typen av hemligt arkiv
uri	string	Uri för att komma till resursen
value	string	Hämtar eller anger värde som lagras i en hemlig lagringsresurs

SecretStoreType

Uppräkning

Hämtar eller anger typen av hemligt arkiv

Värde	Description
Invalid
AzureKeyVault

Status

Uppräkning

Anger resursens skyddsstatus

Värde	Description
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Objekt

Felobjekt som används av lager som har åtkomst till lokaliserat innehåll och som sprids till användaren

Name	Typ	Description
code	string	Unik kod för det här felet
details	UserFacingError[]	Ytterligare relaterade fel
innerError	InnerError	Inre fel
isRetryable	boolean	Om åtgärden kommer att försöka igen eller inte
isUserError	boolean	Om åtgärden beror på ett användarfel eller ett tjänstfel
message	string
properties	object	Alla nyckelvärdepar som kan matas in i felobjekt
recommendedAction	string[]	RecommendedAction lokaliserad.
target	string	Målet för felet.

ValidateForBackupRequest

Objekt

Verifiera för säkerhetskopieringsbegäran

Name	Typ	Description
backupInstance	BackupInstance	Säkerhetskopieringsinstans

ValidationType

Uppräkning

Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

Värde	Description
ShallowValidation
DeepValidation

Dela via

Backup Instances - Validate For Backup

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Validate For Backup

Exempelbegäran

Exempelsvar

Definitioner

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