Backup Instances - Validate For Backup

Kontrollera om ad hoc-säkerhetskopieringen lyckas eller inte

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

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å säkerhetskopieringsvalvet.

api-version
query True

string

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

Innehåller ytterligare information som jobb-ID

202 Accepted

Åtgärden slutförs asynkront.

Headers

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

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto.

Exempel

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

Definitioner

Name Description
AzureOperationalStoreParameters

Parametrar för Operational-Tier DataStore

BackupInstance

Säkerhetskopieringsinstans

BlobBackupDatasourceParameters

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

CloudError

CloudError

CurrentProtectionState

Anger resursens aktuella skyddstillstånd

Datasource

Datakälla

DatasourceSet

DatasourceSet

DataStoreTypes

typ av datalager. Drift/valv/arkiv

Error

Svar på resurshanteringsfel.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

InnerError

InnerError

KubernetesClusterBackupDatasourceParameters

Parametrar för Datasource för säkerhetskopiering av Kubernetes-kluster

OperationJobExtendedInfo

OperationJobExtendedInfo

PolicyInfo

PolicyInfo

PolicyParameters

Parametrar i princip

ProtectionStatusDetails

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

Autentiseringsuppgifter baserade på hemligt arkiv.

SecretStoreResource

Klass som representerar en hemlighetslagringsresurs.

SecretStoreType

Hämtar eller anger typen av hemligt arkiv

Status

Anger skyddsstatus för resursen

UserFacingError

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

ValidateForBackupRequest

ValidateForBackupRequest

ValidationType

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

AzureOperationalStoreParameters

Parametrar för Operational-Tier DataStore

Name Typ Description
dataStoreType

DataStoreTypes

typ av datalager. Drift/valv/arkiv

objectType string:

AzureOperationalStoreParameters

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

resourceGroupId

string

Hämtar eller anger URI:n för resursgruppen för ögonblicksbilder.

BackupInstance

Säkerhetskopieringsinstans

Name Typ Description
currentProtectionState

CurrentProtectionState

Anger resursens aktuella skyddstillstånd

dataSourceInfo

Datasource

Datakälla
Hämtar eller anger datakällans information.

dataSourceSetInfo

DatasourceSet

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 ett eget namn för säkerhetskopieringsinstansen.

objectType

string

policyInfo

PolicyInfo

PolicyInfo
Hämtar eller anger principinformationen.

protectionErrorDetails

UserFacingError

Anger resursens skyddsfel

protectionStatus

ProtectionStatusDetails

ProtectionStatusDetails
Anger skyddsstatus för resursen

provisioningState

string

Anger etableringstillståndet för resursen, t.ex. etablering/uppdatering/lyckades/misslyckades

validationType

ValidationType

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

BlobBackupDatasourceParameters

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 avserialisering

CloudError

CloudError

Name Typ Description
error

Error

Svar på resurshanteringsfel.

CurrentProtectionState

Anger resursens aktuella skyddstillstånd

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

Datakälla

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

Datakällans plats.

resourceName

string

Unik identifierare för resursen i kontexten för överordnad.

resourceType

string

Resurstyp för datakälla.

resourceUri

string

Resursens URI.

DatasourceSet

DatasourceSet

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

Datakällans plats.

resourceName

string

Unik identifierare för resursen i kontexten för överordnad.

resourceType

string

Resurstyp för datakälla.

resourceUri

string

Resursens URI.

DataStoreTypes

typ av datalager. Drift/valv/arkiv

Name Typ Description
ArchiveStore

string

OperationalStore

string

VaultStore

string

Error

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

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

InnerError

InnerError

Name Typ Description
additionalInfo

object

Alla nyckel/värde-par som kan tillhandahållas till klienten för ytterligare utförlig information.

code

string

Unik kod för det här felet

embeddedInnerError

InnerError

InnerError
Underordnat inre fel för att tillåta kapsling.

KubernetesClusterBackupDatasourceParameters

Parametrar för Datasource för säkerhetskopiering av Kubernetes-kluster

Name Typ Description
excludedNamespaces

string[]

Hämtar eller anger egenskapen exclude namespaces. Den här egenskapen anger vilka namnområden som ska undantas under återställningen.

excludedResourceTypes

string[]

Hämtar eller anger egenskapen exkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska undantas under återställningen.

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 återställningen.

includedNamespaces

string[]

Hämtar eller anger egenskapen include namespaces. Den här egenskapen anger vilka namnområden som ska inkluderas under återställningen.

includedResourceTypes

string[]

Hämtar eller anger egenskapen inkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska inkluderas under återställningen.

labelSelectors

string[]

Hämtar eller anger egenskapen LabelSelectors. Den här egenskapen anger att resursen med sådana etikettväljare ska inkluderas under återställningen.

objectType string:

KubernetesClusterBackupDatasourceParameters

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

snapshotVolumes

boolean

Hämtar eller anger egenskapen för volymögonblicksbild. Om den här egenskapen är aktiverad tas ögonblicksbilder av volymen under återställningen.

OperationJobExtendedInfo

OperationJobExtendedInfo

Name Typ Description
jobId

string

Arm-ID för jobbet som skapades för den här åtgärden.

objectType string:

OperationJobExtendedInfo

Denna egenskap kommer att användas som diskriminator för att bestämma de specifika typerna i den polymorfa kedjan av typer.

PolicyInfo

PolicyInfo

Name Typ Description
policyId

string

policyParameters

PolicyParameters

Principparametrar för säkerhetskopieringsinstansen

policyVersion

string

PolicyParameters

Parametrar i princip

Name Typ Description
backupDatasourceParametersList BackupDatasourceParameters[]:

Hämtar eller anger parametrar för säkerhetskopieringsdatakälla

dataStoreParametersList DataStoreParameters[]:

AzureOperationalStoreParameters[]

Hämtar eller anger DataStore-parametrarna

ProtectionStatusDetails

ProtectionStatusDetails

Name Typ Description
errorDetails

UserFacingError

Anger skyddsstatusfelet för resursen

status

Status

Anger skyddsstatus för resursen

SecretStoreBasedAuthCredentials

Autentiseringsuppgifter baserade på hemligt arkiv.

Name Typ Description
objectType string:

SecretStoreBasedAuthCredentials

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

secretStoreResource

SecretStoreResource

Resurs för hemligt arkiv

SecretStoreResource

Klass som representerar en hemlighetslagringsresurs.

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ärdet som lagras i resursen för hemligt arkiv

SecretStoreType

Hämtar eller anger typen av hemligt arkiv

Name Typ Description
AzureKeyVault

string

Invalid

string

Status

Anger skyddsstatus för resursen

Name Typ Description
ConfiguringProtection

string

ConfiguringProtectionFailed

string

ProtectionConfigured

string

ProtectionStopped

string

SoftDeleted

string

SoftDeleting

string

UserFacingError

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

InnerError
Inre fel

isRetryable

boolean

Om åtgärden ska kunna göras om eller inte

isUserError

boolean

Om åtgärden beror på ett användarfel eller ett tjänstfel

message

string

properties

object

Alla nyckel/värde-par som kan matas in i felobjekt

recommendedAction

string[]

RecommendedAction lokaliserad.

target

string

Målet för felet.

ValidateForBackupRequest

ValidateForBackupRequest

Name Typ Description
backupInstance

BackupInstance

Säkerhetskopieringsinstans

ValidationType

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

Name Typ Description
DeepValidation

string

ShallowValidation

string