Backup Instances - Validate For Backup

Überprüfen, ob die Adhoc-Sicherung erfolgreich ist

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

vaultName
path True

string

Der Name des Sicherungstresors.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
backupInstance True

BackupInstance

Sicherungsinstanz

Antworten

Name Typ Beschreibung
200 OK

OperationJobExtendedInfo

Enthält zusätzliche Informationen wie auftrags-ID.

202 Accepted

Der Vorgang wird asynchron abgeschlossen.

Headers

  • Location: string
  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identität Ihres Benutzerkontos annehmen.

Beispiele

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

Definitionen

Name Beschreibung
AzureOperationalStoreParameters

Parameter für Operational-Tier DataStore

BackupInstance

Sicherungsinstanz

BlobBackupDatasourceParameters

Parameter, die während der Konfiguration der Sicherung von Blobs verwendet werden sollen

CloudError

CloudError

CurrentProtectionState

Gibt den aktuellen Schutzstatus der Ressource an.

Datasource

Datenquelle

DatasourceSet

DatasourceSet

DataStoreTypes

Art des Datenspeichers; Betrieb/Tresor/Archiv

Error

Die Fehlerantwort für die Ressourcenverwaltung.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

InnerError

InnerError

KubernetesClusterBackupDatasourceParameters

Parameter für die Datenquelle für die Kubernetes-Clustersicherung

OperationJobExtendedInfo

OperationJobExtendedInfo

PolicyInfo

PolicyInfo

PolicyParameters

Parameter in Der Richtlinie

ProtectionStatusDetails

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

Anmeldeinformationen für die geheimnisbasierte Authentifizierung.

SecretStoreResource

Klasse, die eine Geheimnisspeicherressource darstellt.

SecretStoreType

Ruft den Typ des Geheimnisspeichers ab oder legt den Typ fest.

Status

Gibt den Schutz status der Ressource an.

UserFacingError

Fehlerobjekt, das von Ebenen verwendet wird, die Zugriff auf lokalisierte Inhalte haben, und diesen an den Benutzer weitergeben

ValidateForBackupRequest

ValidateForBackupRequest

ValidationType

Gibt den Typ der Überprüfung an. Im Fall von DeepValidation werden alle Überprüfungen der /validateForBackup-API erneut ausgeführt.

AzureOperationalStoreParameters

Parameter für Operational-Tier DataStore

Name Typ Beschreibung
dataStoreType

DataStoreTypes

Art des Datenspeichers; Betrieb/Tresor/Archiv

objectType string:

AzureOperationalStoreParameters

Typ des spezifischen Objekts – wird für die Deserialisierung verwendet.

resourceGroupId

string

Ruft den Momentaufnahmeressourcengruppen-URI ab oder legt diese fest.

BackupInstance

Sicherungsinstanz

Name Typ Beschreibung
currentProtectionState

CurrentProtectionState

Gibt den aktuellen Schutzstatus der Ressource an.

dataSourceInfo

Datasource

Datenquelle
Ruft die Datenquelleninformationen ab oder legt sie fest.

dataSourceSetInfo

DatasourceSet

DatasourceSet
Ruft die Informationen zum Datenquellensatz ab oder legt sie fest.

datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

Anmeldeinformationen, die für die Authentifizierung beim Datenquellenanbieter verwendet werden sollen.

friendlyName

string

Ruft den Anzeigenamen der Backup-Instanz ab oder legt den Anzeigenamen fest.

objectType

string

policyInfo

PolicyInfo

PolicyInfo
Ruft die Richtlinieninformationen ab oder legt sie fest.

protectionErrorDetails

UserFacingError

Gibt den Schutzfehler der Ressource an.

protectionStatus

ProtectionStatusDetails

ProtectionStatusDetails
Gibt den Schutz status der Ressource an.

provisioningState

string

Gibt den Bereitstellungsstatus der Ressource an, d. h. Bereitstellung/Aktualisierung/Erfolgreich/Fehler

validationType

ValidationType

Gibt den Typ der Überprüfung an. Im Fall von DeepValidation werden alle Überprüfungen der /validateForBackup-API erneut ausgeführt.

BlobBackupDatasourceParameters

Parameter, die während der Konfiguration der Sicherung von Blobs verwendet werden sollen

Name Typ Beschreibung
containersList

string[]

Liste der Container, die während der Konfiguration der Sicherung von Blobs gesichert werden sollen

objectType string:

BlobBackupDatasourceParameters

Typ des spezifischen Objekts – wird für die Deserialisierung verwendet.

CloudError

CloudError

Name Typ Beschreibung
error

Error

Die Fehlerantwort für die Ressourcenverwaltung.

CurrentProtectionState

Gibt den aktuellen Schutzstatus der Ressource an.

Name Typ Beschreibung
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

Datenquelle

Name Typ Beschreibung
datasourceType

string

DatasourceType der Ressource.

objectType

string

Typ des Datenquellenobjekts, der zum Initialisieren des rechten geerbten Typs verwendet wird

resourceID

string

Vollständige ARM-ID der Ressource. Für Azure-Ressourcen ist dies die ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird.

resourceLocation

string

Speicherort der Datenquelle.

resourceName

string

Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements.

resourceType

string

Ressourcentyp der Datenquelle.

resourceUri

string

URI der Ressource.

DatasourceSet

DatasourceSet

Name Typ Beschreibung
datasourceType

string

DatasourceType der Ressource.

objectType

string

Typ des Datenquellenobjekts, der zum Initialisieren des rechten geerbten Typs verwendet wird

resourceID

string

Vollständige ARM-ID der Ressource. Für Azure-Ressourcen ist dies die ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird.

resourceLocation

string

Speicherort der Datenquelle.

resourceName

string

Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements.

resourceType

string

Ressourcentyp der Datenquelle.

resourceUri

string

URI der Ressource.

DataStoreTypes

Art des Datenspeichers; Betrieb/Tresor/Archiv

Name Typ Beschreibung
ArchiveStore

string

OperationalStore

string

VaultStore

string

Error

Die Fehlerantwort für die Ressourcenverwaltung.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

Error[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

InnerError

InnerError

Name Typ Beschreibung
additionalInfo

object

Alle Schlüsselwertpaare, die dem Client zur Verfügung gestellt werden können, um weitere ausführliche Informationen zu erhalten.

code

string

Eindeutiger Code für diesen Fehler

embeddedInnerError

InnerError

InnerError
Untergeordneter innerer Fehler, um das Schachteln zuzulassen.

KubernetesClusterBackupDatasourceParameters

Parameter für die Datenquelle für die Kubernetes-Clustersicherung

Name Typ Beschreibung
excludedNamespaces

string[]

Ruft die Eigenschaft exclude namespaces ab oder legt sie fest. Diese Eigenschaft legt die Namespaces fest, die während der Wiederherstellung ausgeschlossen werden sollen.

excludedResourceTypes

string[]

Ruft die Eigenschaft exclude resource types ab oder legt sie fest. Diese Eigenschaft legt die Ressourcentypen fest, die während der Wiederherstellung ausgeschlossen werden sollen.

includeClusterScopeResources

boolean

Ruft die Include-Clusterressourcen-Eigenschaft ab oder legt sie fest. Wenn diese Eigenschaft aktiviert ist, werden während der Wiederherstellung Clusterbereichsressourcen eingeschlossen.

includedNamespaces

string[]

Ruft die Include-Namespaces-Eigenschaft ab oder legt sie fest. Diese Eigenschaft legt die Namespaces fest, die während der Wiederherstellung eingeschlossen werden sollen.

includedResourceTypes

string[]

Ruft die Include-Ressourcentypen-Eigenschaft ab oder legt sie fest. Diese Eigenschaft legt die Ressourcentypen fest, die während der Wiederherstellung eingeschlossen werden sollen.

labelSelectors

string[]

Ruft die LabelSelectors-Eigenschaft ab oder legt sie fest. Diese Eigenschaft legt die Ressource mit solchen Bezeichnungsselektoren fest, die während der Wiederherstellung eingeschlossen werden sollen.

objectType string:

KubernetesClusterBackupDatasourceParameters

Typ des spezifischen Objekts – wird für die Deserialisierung verwendet.

snapshotVolumes

boolean

Ruft die Volume-Momentaufnahme-Eigenschaft ab oder legt sie fest. Wenn diese Eigenschaft aktiviert ist, werden während der Wiederherstellung Volumemomentaufnahmen erstellt.

OperationJobExtendedInfo

OperationJobExtendedInfo

Name Typ Beschreibung
jobId

string

Arm-ID des für diesen Vorgang erstellten Auftrags.

objectType string:

OperationJobExtendedInfo

Diese Eigenschaft wird als Diskriminator verwendet, um die spezifischen Typen in der polymorphen Kette von Typen zu bestimmen.

PolicyInfo

PolicyInfo

Name Typ Beschreibung
policyId

string

policyParameters

PolicyParameters

Richtlinienparameter für die sicherungsgesteuerte instance

policyVersion

string

PolicyParameters

Parameter in Der Richtlinie

Name Typ Beschreibung
backupDatasourceParametersList BackupDatasourceParameters[]:

Ruft die Sicherungsdatenquellparameter ab oder legt sie fest.

dataStoreParametersList DataStoreParameters[]:

AzureOperationalStoreParameters[]

Ruft die Datenspeicherparameter ab oder legt sie fest.

ProtectionStatusDetails

ProtectionStatusDetails

Name Typ Beschreibung
errorDetails

UserFacingError

Gibt den Schutz status Fehler der Ressource an.

status

Status

Gibt den Schutz status der Ressource an.

SecretStoreBasedAuthCredentials

Anmeldeinformationen für die geheimnisbasierte Authentifizierung.

Name Typ Beschreibung
objectType string:

SecretStoreBasedAuthCredentials

Typ des spezifischen Objekts – wird für die Deserialisierung verwendet.

secretStoreResource

SecretStoreResource

Geheimnisspeicherressource

SecretStoreResource

Klasse, die eine Geheimnisspeicherressource darstellt.

Name Typ Beschreibung
secretStoreType

SecretStoreType

Ruft den Typ des Geheimnisspeichers ab oder legt den Typ fest.

uri

string

URI zum Abrufen der Ressource

value

string

Ruft den wert ab, der in einer Geheimnisspeicherressource gespeichert ist, oder legt den Wert fest.

SecretStoreType

Ruft den Typ des Geheimnisspeichers ab oder legt den Typ fest.

Name Typ Beschreibung
AzureKeyVault

string

Invalid

string

Status

Gibt den Schutz status der Ressource an.

Name Typ Beschreibung
ConfiguringProtection

string

ConfiguringProtectionFailed

string

ProtectionConfigured

string

ProtectionStopped

string

SoftDeleted

string

SoftDeleting

string

UserFacingError

Fehlerobjekt, das von Ebenen verwendet wird, die Zugriff auf lokalisierte Inhalte haben, und diesen an den Benutzer weitergeben

Name Typ Beschreibung
code

string

Eindeutiger Code für diesen Fehler

details

UserFacingError[]

Weitere verwandte Fehler

innerError

InnerError

InnerError
Innerer Fehler

isRetryable

boolean

Gibt an, ob der Vorgang wiederholt werden kann oder nicht

isUserError

boolean

Gibt an, ob der Vorgang auf einen Benutzer- oder Dienstfehler zurückzuführen ist.

message

string

properties

object

Alle Schlüsselwertpaare, die in das Fehlerobjekt eingefügt werden können

recommendedAction

string[]

RecommendedAction lokalisiert.

target

string

Ziel des Fehlers.

ValidateForBackupRequest

ValidateForBackupRequest

Name Typ Beschreibung
backupInstance

BackupInstance

Sicherungsinstanz

ValidationType

Gibt den Typ der Überprüfung an. Im Fall von DeepValidation werden alle Überprüfungen der /validateForBackup-API erneut ausgeführt.

Name Typ Beschreibung
DeepValidation

string

ShallowValidation

string