Backup Instances - Validate For Backup
Verificare se il backup ad hoc avrà esito positivo o negativo
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup?api-version=2023-01-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
subscription
|
path | True |
string uuid |
ID della sottoscrizione di destinazione. Il valore deve essere un UUID. |
vault
|
path | True |
string |
Nome dell'insieme di credenziali di backup. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
backupInstance | True |
Istanza di backup |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Contiene informazioni aggiuntive, ad esempio l'ID processo |
|
202 Accepted |
L'operazione verrà completata in modo asincrono. Headers
|
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente. |
Esempio
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"
}
Definizioni
Nome | Descrizione |
---|---|
Azure |
Parametri per Operational-Tier DataStore |
Backup |
Istanza di backup |
Blob |
Parametri da usare durante la configurazione del backup dei BLOB |
Cloud |
CloudError |
Current |
Specifica lo stato di protezione corrente della risorsa |
Datasource |
Origine dati |
Datasource |
DatasourceSet |
Data |
tipo di archivio dati; Operational/Vault/Archive |
Error |
Risposta all'errore di gestione delle risorse. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Inner |
InnerError |
Kubernetes |
Parametri per l'origine dati di backup del cluster Kubernetes |
Operation |
OperationJobExtendedInfo |
Policy |
PolicyInfo |
Policy |
Parametri nei criteri |
Protection |
ProtectionStatusDetails |
Secret |
Credenziali di autenticazione basate sull'archivio segreto. |
Secret |
Classe che rappresenta una risorsa dell'archivio segreti. |
Secret |
Ottiene o imposta il tipo di archivio dei segreti |
Status |
Specifica lo stato di protezione della risorsa |
User |
Oggetto errore usato dai livelli che hanno accesso al contenuto localizzato e propagano tale oggetto all'utente |
Validate |
ValidateForBackupRequest |
Validation |
Specifica il tipo di convalida. In caso di DeepValidation, tutte le convalide dell'API /validateForBackup verranno eseguite di nuovo. |
AzureOperationalStoreParameters
Parametri per Operational-Tier DataStore
Nome | Tipo | Descrizione |
---|---|---|
dataStoreType |
tipo di archivio dati; Operational/Vault/Archive |
|
objectType | string: |
Tipo dell'oggetto specifico : utilizzato per la deserializzazione |
resourceGroupId |
string |
Ottiene o imposta l'URI del gruppo di risorse snapshot. |
BackupInstance
Istanza di backup
Nome | Tipo | Descrizione |
---|---|---|
currentProtectionState |
Specifica lo stato di protezione corrente della risorsa |
|
dataSourceInfo |
Origine dati |
|
dataSourceSetInfo |
DatasourceSet |
|
datasourceAuthCredentials | AuthCredentials: |
Credenziali da usare per l'autenticazione con il provider dell'origine dati. |
friendlyName |
string |
Ottiene o imposta il nome descrittivo dell'istanza di backup. |
objectType |
string |
|
policyInfo |
PolicyInfo |
|
protectionErrorDetails |
Specifica l'errore di protezione della risorsa |
|
protectionStatus |
ProtectionStatusDetails |
|
provisioningState |
string |
Specifica lo stato di provisioning della risorsa, ad esempio provisioning/aggiornamento/riuscito/non riuscito |
validationType |
Specifica il tipo di convalida. In caso di DeepValidation, tutte le convalide dell'API /validateForBackup verranno eseguite di nuovo. |
BlobBackupDatasourceParameters
Parametri da usare durante la configurazione del backup dei BLOB
Nome | Tipo | Descrizione |
---|---|---|
containersList |
string[] |
Elenco di contenitori di cui eseguire il backup durante la configurazione del backup dei BLOB |
objectType | string: |
Tipo dell'oggetto specifico : utilizzato per la deserializzazione |
CloudError
CloudError
Nome | Tipo | Descrizione |
---|---|---|
error |
Risposta all'errore di gestione delle risorse. |
CurrentProtectionState
Specifica lo stato di protezione corrente della risorsa
Nome | Tipo | Descrizione |
---|---|---|
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
Origine dati
Nome | Tipo | Descrizione |
---|---|---|
datasourceType |
string |
DatasourceType della risorsa. |
objectType |
string |
Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto |
resourceID |
string |
ID arm completo della risorsa. Per le risorse di Azure, si tratta dell'ID ARM. Per le risorse non di Azure, questo sarà l'ID creato dal servizio di backup tramite Fabric/Vault. |
resourceLocation |
string |
Posizione dell'origine dati. |
resourceName |
string |
Identificatore univoco della risorsa nel contesto dell'elemento padre. |
resourceType |
string |
Tipo di risorsa dell'origine dati. |
resourceUri |
string |
URI della risorsa. |
DatasourceSet
DatasourceSet
Nome | Tipo | Descrizione |
---|---|---|
datasourceType |
string |
DatasourceType della risorsa. |
objectType |
string |
Tipo di oggetto Datasource, utilizzato per inizializzare il tipo ereditato corretto |
resourceID |
string |
ID arm completo della risorsa. Per le risorse di Azure, si tratta dell'ID ARM. Per le risorse non di Azure, questo sarà l'ID creato dal servizio di backup tramite Fabric/Vault. |
resourceLocation |
string |
Posizione dell'origine dati. |
resourceName |
string |
Identificatore univoco della risorsa nel contesto dell'elemento padre. |
resourceType |
string |
Tipo di risorsa dell'origine dati. |
resourceUri |
string |
URI della risorsa. |
DataStoreTypes
tipo di archivio dati; Operational/Vault/Archive
Nome | Tipo | Descrizione |
---|---|---|
ArchiveStore |
string |
|
OperationalStore |
string |
|
VaultStore |
string |
Error
Risposta all'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Error[] |
Dettagli dell'errore. |
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
InnerError
InnerError
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
object |
Qualsiasi coppia chiave valore che può essere fornita al client per informazioni dettagliate aggiuntive. |
code |
string |
Codice univoco per questo errore |
embeddedInnerError |
InnerError |
KubernetesClusterBackupDatasourceParameters
Parametri per l'origine dati di backup del cluster Kubernetes
Nome | Tipo | Descrizione |
---|---|---|
excludedNamespaces |
string[] |
Ottiene o imposta la proprietà exclude namespaces. Questa proprietà imposta gli spazi dei nomi da escludere durante il ripristino. |
excludedResourceTypes |
string[] |
Ottiene o imposta la proprietà exclude resource types. Questa proprietà imposta i tipi di risorsa da escludere durante il ripristino. |
includeClusterScopeResources |
boolean |
Ottiene o imposta la proprietà include risorse cluster. Questa proprietà, se abilitata, includerà le risorse dell'ambito del cluster durante il ripristino. |
includedNamespaces |
string[] |
Ottiene o imposta la proprietà include namespaces. Questa proprietà imposta gli spazi dei nomi da includere durante il ripristino. |
includedResourceTypes |
string[] |
Ottiene o imposta la proprietà include resource types. Questa proprietà imposta i tipi di risorsa da includere durante il ripristino. |
labelSelectors |
string[] |
Ottiene o imposta la proprietà LabelSelectors. Questa proprietà imposta la risorsa con selettori di etichetta da includere durante il ripristino. |
objectType | string: |
Tipo dell'oggetto specifico : utilizzato per la deserializzazione |
snapshotVolumes |
boolean |
Ottiene o imposta la proprietà snapshot del volume. Questa proprietà, se abilitata, crea snapshot del volume durante il ripristino. |
OperationJobExtendedInfo
OperationJobExtendedInfo
Nome | Tipo | Descrizione |
---|---|---|
jobId |
string |
ID arm del processo creato per questa operazione. |
objectType | string: |
Questa proprietà verrà utilizzata come discriminante per decidere i tipi specifici nella catena polimorfica di tipi. |
PolicyInfo
PolicyInfo
Nome | Tipo | Descrizione |
---|---|---|
policyId |
string |
|
policyParameters |
Parametri dei criteri per l'istanza di backup |
|
policyVersion |
string |
PolicyParameters
Parametri nei criteri
Nome | Tipo | Descrizione |
---|---|---|
backupDatasourceParametersList | BackupDatasourceParameters[]: |
Ottiene o imposta i parametri dell'origine dati di backup |
dataStoreParametersList | DataStoreParameters[]: |
Ottiene o imposta i parametri dell'archivio dati |
ProtectionStatusDetails
ProtectionStatusDetails
Nome | Tipo | Descrizione |
---|---|---|
errorDetails |
Specifica l'errore di stato di protezione della risorsa |
|
status |
Specifica lo stato di protezione della risorsa |
SecretStoreBasedAuthCredentials
Credenziali di autenticazione basate sull'archivio segreto.
Nome | Tipo | Descrizione |
---|---|---|
objectType | string: |
Tipo dell'oggetto specifico : utilizzato per la deserializzazione |
secretStoreResource |
Risorsa archivio segreti |
SecretStoreResource
Classe che rappresenta una risorsa dell'archivio segreti.
Nome | Tipo | Descrizione |
---|---|---|
secretStoreType |
Ottiene o imposta il tipo di archivio dei segreti |
|
uri |
string |
URI per accedere alla risorsa |
value |
string |
Ottiene o imposta il valore archiviato nella risorsa dell'archivio segreti |
SecretStoreType
Ottiene o imposta il tipo di archivio dei segreti
Nome | Tipo | Descrizione |
---|---|---|
AzureKeyVault |
string |
|
Invalid |
string |
Status
Specifica lo stato di protezione della risorsa
Nome | Tipo | Descrizione |
---|---|---|
ConfiguringProtection |
string |
|
ConfiguringProtectionFailed |
string |
|
ProtectionConfigured |
string |
|
ProtectionStopped |
string |
|
SoftDeleted |
string |
|
SoftDeleting |
string |
UserFacingError
Oggetto errore usato dai livelli che hanno accesso al contenuto localizzato e propagano tale oggetto all'utente
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice univoco per questo errore |
details |
Errori correlati aggiuntivi |
|
innerError |
InnerError |
|
isRetryable |
boolean |
Indica se l'operazione sarà riprovabile o meno |
isUserError |
boolean |
Indica se l'operazione è dovuta a un errore dell'utente o di un servizio |
message |
string |
|
properties |
object |
Qualsiasi coppia chiave-valore che può essere inserita all'interno dell'oggetto error |
recommendedAction |
string[] |
RecommendedAction localizzato. |
target |
string |
Destinazione dell'errore. |
ValidateForBackupRequest
ValidateForBackupRequest
Nome | Tipo | Descrizione |
---|---|---|
backupInstance |
Istanza di backup |
ValidationType
Specifica il tipo di convalida. In caso di DeepValidation, tutte le convalide dell'API /validateForBackup verranno eseguite di nuovo.
Nome | Tipo | Descrizione |
---|---|---|
DeepValidation |
string |
|
ShallowValidation |
string |