Backup Instances - Validate For Backup

Reference

Služba:: Data Protection

Verze rozhraní API:: 2025-01-01

Ověřte, jestli bude adhoc zálohování úspěšné nebo ne.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
vaultName	path	True	string	Název trezoru záloh.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
backupInstance	True	BackupInstance	Instance zálohování

Odpovědi

Name	Typ	Description
200 OK	OperationJobExtendedInfo	Obsahuje další informace, jako je ID úlohy.
202 Accepted		Operace bude dokončena asynchronně. Hlavičky Location: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

OperationJobExtendedInfo

Obsahuje další informace, jako je ID úlohy.

202 Accepted

Operace bude dokončena asynchronně.

Hlavičky

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

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnit váš uživatelský účet.

Příklady

Validate For Backup

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Stavový kód:: 200

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

Definice

Name	Description
AKSVolumeTypes	Získá nebo nastaví zahrnout typ svazku vlastnost. Tato vlastnost nastaví typy svazků, které mají být zahrnuty během zálohování.
AzureOperationalStoreParameters	Parametry úložiště dat Operational-Tier
BackupInstance	Instance zálohování
BlobBackupDatasourceParameters	Parametry, které se mají použít při konfiguraci zálohování objektů blob
CloudError	CloudError
CurrentProtectionState	Určuje aktuální stav ochrany prostředku.
Datasource	Zdroj dat
DatasourceSet	Sada zdrojů dat
DataStoreTypes	typ úložiště dat; Provozní/ Trezor / Archiv
DefaultResourceProperties	Výchozí vlastnosti zdroje
Error	Odpověď na chybu správy prostředků.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
IdentityDetails
InnerError	Vnitřní chyba
KubernetesClusterBackupDatasourceParameters	Parametry pro zdroj dat zálohování clusteru Kubernetes
NamespacedNameResource	NamespacedNameResource
OperationJobExtendedInfo	OperationJobExtendedInfo
PolicyInfo	PolicyInfo
PolicyParameters	Parametry v zásadách
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	Přihlašovací údaje pro ověřování založené na úložišti tajných kódů.
SecretStoreResource	Třída představující prostředek úložiště tajných kódů
SecretStoreType	Získá nebo nastaví typ úložiště tajných kódů.
Status	Určuje stav ochrany prostředku.
UserFacingError	Objekt chyby používaný vrstvami, které mají přístup k lokalizovaného obsahu, a rozšířit ho na uživatele
ValidateForBackupRequest	ValidateForBackupRequest
ValidationType	Určuje typ ověření. V případě DeepValidation se všechna ověření z rozhraní /validateForBackup API spustí znovu.

AKSVolumeTypes

Enumeration

Získá nebo nastaví zahrnout typ svazku vlastnost. Tato vlastnost nastaví typy svazků, které mají být zahrnuty během zálohování.

Hodnota	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Parametry úložiště dat Operational-Tier

Name	Typ	Description
dataStoreType	DataStoreTypes	typ úložiště dat; Provozní/ Trezor / Archiv
objectType	string: AzureOperationalStoreParameters	Typ konkrétního objektu – slouží k deserializaci
resourceGroupId	string	Získá nebo nastaví identifikátor URI skupiny prostředků snímku.

BackupInstance

Object

Instance zálohování

Name	Typ	Description
currentProtectionState	CurrentProtectionState	Určuje aktuální stav ochrany prostředku.
dataSourceInfo	Datasource	Zdroj dat Získá nebo nastaví informace o zdroji dat.
dataSourceSetInfo	DatasourceSet	Sada zdrojů dat Získá nebo nastaví informace o sadě zdrojů dat.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Přihlašovací údaje, které se mají použít k ověření u poskytovatele zdroje dat.
friendlyName	string	Získá nebo nastaví popisný název instance zálohování.
identityDetails	IdentityDetails	Obsahuje informace opodrobnostch Pokud má hodnotu null, bude výchozí hodnota považována za přiřazenou systémem.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Získá nebo nastaví informace o zásadách.
protectionErrorDetails	UserFacingError	Určuje chybu ochrany prostředku.
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails Určuje stav ochrany prostředku.
provisioningState	string	Určuje stav zřizování prostředku, tj. zřizování, aktualizace, úspěch nebo selhání.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests, na které se provede kontrola LAC
validationType	ValidationType	Určuje typ ověření. V případě DeepValidation se všechna ověření z rozhraní /validateForBackup API spustí znovu.

BlobBackupDatasourceParameters

Object

Parametry, které se mají použít při konfiguraci zálohování objektů blob

Name	Typ	Description
containersList	string[]	Seznam kontejnerů, které se mají zálohovat během konfigurace zálohování objektů blob
objectType	string: BlobBackupDatasourceParameters	Typ konkrétního objektu – slouží k deserializaci

CloudError

Object

CloudError

Name	Typ	Description
error	Error	Odpověď na chybu správy prostředků.

CurrentProtectionState

Enumeration

Určuje aktuální stav ochrany prostředku.

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

Datasource

Object

Zdroj dat

Name	Typ	Description
datasourceType	string	DatasourceType prostředku.
objectType	string	Typ objektu Datasource, který se používá k inicializaci zděděného typu vpravo
resourceID	string	Úplné ID ARM prostředku U prostředků Azure se jedná o ID ARM. V případě jiných prostředků než Azure to bude ID vytvořené službou backup prostřednictvím prostředků Fabric/Vault.
resourceLocation	string	Umístění zdroje dat
resourceName	string	Jedinečný identifikátor prostředku v kontextu nadřazeného objektu.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Vlastnosti specifické pro zdroj dat
resourceType	string	Typ zdroje dat
resourceUri	string	Identifikátor URI prostředku.

DatasourceSet

Object

Sada zdrojů dat

Name	Typ	Description
datasourceType	string	DatasourceType prostředku.
objectType	string	Typ objektu Datasource, který se používá k inicializaci zděděného typu vpravo
resourceID	string	Úplné ID ARM prostředku U prostředků Azure se jedná o ID ARM. V případě jiných prostředků než Azure to bude ID vytvořené službou backup prostřednictvím prostředků Fabric/Vault.
resourceLocation	string	Umístění zdroje dat
resourceName	string	Jedinečný identifikátor prostředku v kontextu nadřazeného objektu.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Vlastnosti specifické pro sadu zdrojů dat
resourceType	string	Typ zdroje dat
resourceUri	string	Identifikátor URI prostředku.

DataStoreTypes

Enumeration

typ úložiště dat; Provozní/ Trezor / Archiv

Hodnota	Description
ArchiveStore
OperationalStore
VaultStore

DefaultResourceProperties

Object

Výchozí vlastnosti zdroje

Name	Typ	Description
objectType	string: DefaultResourceProperties	Typ konkrétního objektu – slouží k deserializaci

Error

Object

Odpověď na chybu správy prostředků.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	Error[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Object

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

IdentityDetails

Object

Name	Typ	Description
useSystemAssignedIdentity	boolean	Určuje, jestli je BI chráněná identitou systému.
userAssignedIdentityArmUrl	string	Adresa URL ARM pro identitu přiřazenou uživatelem

InnerError

Object

Vnitřní chyba

Name	Typ	Description
additionalInfo	object	Všechny páry klíčových hodnot, které lze klientovi poskytnout pro další podrobné informace.
code	string	Jedinečný kód pro tuto chybu
embeddedInnerError	InnerError	Vnitřní chyba Podřízená vnitřní chyba, která umožňuje vnoření.

KubernetesClusterBackupDatasourceParameters

Object

Parametry pro zdroj dat zálohování clusteru Kubernetes

Name	Typ	Description
backupHookReferences	NamespacedNameResource[]	Získá nebo nastaví odkazy na zálohovací háky. Tato vlastnost nastaví odkaz na háku, který se má spustit během zálohování.
excludedNamespaces	string[]	Získá nebo nastaví vyloučit obory názvů vlastnost. Tato vlastnost nastaví obory názvů, které mají být vyloučeny během zálohování.
excludedResourceTypes	string[]	Získá nebo nastaví vlastnost vyloučit typy prostředků. Tato vlastnost nastaví typy prostředků, které mají být vyloučeny během zálohování.
includeClusterScopeResources	boolean	Získá nebo nastaví vlastnost zahrnout prostředky clusteru. Pokud je tato vlastnost povolená, bude během zálohování zahrnovat prostředky oboru clusteru.
includedNamespaces	string[]	Získá nebo nastaví include obory názvů vlastnost. Tato vlastnost nastaví obory názvů, které mají být zahrnuty během zálohování.
includedResourceTypes	string[]	Získá nebo nastaví zahrnout typ prostředku vlastnost. Tato vlastnost nastaví typy prostředků, které se mají zahrnout během zálohování.
includedVolumeTypes	AKSVolumeTypes[]	Získá nebo nastaví zahrnout typ svazku vlastnost. Tato vlastnost nastaví typy svazků, které mají být zahrnuty během zálohování.
labelSelectors	string[]	Získá nebo nastaví LabelSelectors vlastnost. Tato vlastnost nastaví prostředek s těmito selektory popisků, které se mají zahrnout během zálohování.
objectType	string: KubernetesClusterBackupDatasourceParameters	Typ konkrétního objektu – slouží k deserializaci
snapshotVolumes	boolean	Získá nebo nastaví vlastnost snímku svazku. Pokud je tato vlastnost povolená, pořídí snímky svazků během zálohování.

NamespacedNameResource

Object

NamespacedNameResource

Name	Typ	Description
name	string	Název prostředku
namespace	string	Obor názvů, ve kterém prostředek existuje

OperationJobExtendedInfo

Object

OperationJobExtendedInfo

Name	Typ	Description
jobId	string	Název nebo ID arm úlohy vytvořené pro tuto operaci
objectType	string: OperationJobExtendedInfo	Tato vlastnost se použije jako diskriminátor pro rozhodování o konkrétních typech v polymorfním řetězci typů.

PolicyInfo

Object

PolicyInfo

Name	Typ	Description
policyId	string
policyParameters	PolicyParameters	Parametry zásad pro instanci zálohování
policyVersion	string

PolicyParameters

Object

Parametry v zásadách

Name	Typ	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Získá nebo nastaví parametry záložního zdroje dat.
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Získá nebo nastaví parametry úložiště dat.

ProtectionStatusDetails

Object

ProtectionStatusDetails

Name	Typ	Description
errorDetails	UserFacingError	Určuje chybu stavu ochrany prostředku.
status	Status	Určuje stav ochrany prostředku.

SecretStoreBasedAuthCredentials

Object

Přihlašovací údaje pro ověřování založené na úložišti tajných kódů.

Name	Typ	Description
objectType	string: SecretStoreBasedAuthCredentials	Typ konkrétního objektu – slouží k deserializaci
secretStoreResource	SecretStoreResource	Prostředek úložiště tajných kódů

SecretStoreResource

Object

Třída představující prostředek úložiště tajných kódů

Name	Typ	Description
secretStoreType	SecretStoreType	Získá nebo nastaví typ úložiště tajných kódů.
uri	string	Identifikátor URI pro přístup k prostředku
value	string	Získá nebo nastaví hodnotu uloženou v prostředku úložiště tajných kódů.

SecretStoreType

Enumeration

Získá nebo nastaví typ úložiště tajných kódů.

Hodnota	Description
AzureKeyVault
Invalid

Status

Enumeration

Určuje stav ochrany prostředku.

Hodnota	Description
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Object

Objekt chyby používaný vrstvami, které mají přístup k lokalizovaného obsahu, a rozšířit ho na uživatele

Name	Typ	Description
code	string	Jedinečný kód pro tuto chybu
details	UserFacingError[]	Další související chyby
innerError	InnerError	Vnitřní chyba Vnitřní chyba
isRetryable	boolean	Jestli bude operace opakovatelná, nebo ne
isUserError	boolean	Jestli je operace způsobená chybou uživatele nebo chybou služby
message	string
properties	object	Všechny páry klíč-hodnota, které je možné vloženého do objektu chyby
recommendedAction	string[]	Lokalizovaná doporučená akce.
target	string	Cíl chyby.

ValidateForBackupRequest

Object

ValidateForBackupRequest

Name	Typ	Description
backupInstance	BackupInstance	Instance zálohování

ValidationType

Enumeration

Určuje typ ověření. V případě DeepValidation se všechna ověření z rozhraní /validateForBackup API spustí znovu.

Hodnota	Description
DeepValidation
ShallowValidation

Sdílet prostřednictvím

Backup Instances - Validate For Backup

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Validate For Backup

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály