Backup Instances - Create Or Update
Erstellen oder Aktualisieren eines Sicherungs-instance in einem Sicherungstresor
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}?api-version=2023-01-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
backup
|
path | True |
string |
Der Name des sicherungs-instance. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string uuid |
Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein. |
vault
|
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 | Typ | Beschreibung |
---|---|---|
properties |
BackupInstanceResource-Eigenschaften |
|
tags |
object |
Proxyressourcentags. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
201 Created |
Erstellt |
|
202 Accepted |
Akzeptiert Headers
|
|
Other Status Codes |
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
Create BackupInstance
Sample Request
PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1?api-version=2023-01-01
{
"tags": {
"key1": "val1"
},
"properties": {
"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": "Microsoft.DBforPostgreSQL/servers/databases"
},
"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": "Microsoft.DBforPostgreSQL/servers/databases"
},
"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",
"policyParameters": {
"dataStoreParametersList": [
{
"objectType": "AzureOperationalStoreParameters",
"dataStoreType": "OperationalStore",
"resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
}
]
}
},
"validationType": "ShallowValidation"
}
}
Sample Response
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
{
"id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"tags": {
"key1": "val1"
},
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
"datasourceType": "OssDB",
"resourceName": "testdb",
"resourceType": "OssDB",
"resourceLocation": "",
"objectType": "Datasource"
},
"dataSourceSetInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
"resourceUri": "",
"datasourceType": "OssDB",
"resourceName": "viveksipgtest",
"resourceType": "OssDB",
"resourceLocation": "",
"objectType": "DatasourceSet"
},
"policyInfo": {
"policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
"policyVersion": "3.2",
"policyParameters": {
"dataStoreParametersList": [
{
"objectType": "AzureOperationalStoreParameters",
"dataStoreType": "OperationalStore",
"resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
}
]
}
},
"protectionStatus": {
"status": "NotProtected"
},
"provisioningState": "Provisioning",
"objectType": "BackupInstance"
}
}
Azure-AsyncOperation: https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01
Location: https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01
Retry-After: 60
{
"id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"tags": {
"key1": "val1"
},
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
"datasourceType": "OssDB",
"resourceName": "testdb",
"resourceType": "OssDB",
"resourceLocation": "",
"objectType": "Datasource"
},
"dataSourceSetInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
"resourceUri": "",
"datasourceType": "OssDB",
"resourceName": "viveksipgtest",
"resourceType": "OssDB",
"resourceLocation": "",
"objectType": "DatasourceSet"
},
"policyInfo": {
"policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
"policyVersion": "3.2",
"policyParameters": {
"dataStoreParametersList": [
{
"objectType": "AzureOperationalStoreParameters",
"dataStoreType": "OperationalStore",
"resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
}
]
}
},
"protectionStatus": {
"status": "NotProtected"
},
"provisioningState": "Provisioned",
"objectType": "BackupInstance"
}
}
Definitionen
Name | Beschreibung |
---|---|
Azure |
Parameter für Operational-Tier DataStore |
Backup |
Sicherungsinstanz |
Backup |
BackupInstanceResource |
Blob |
Parameter, die während der Konfiguration der Sicherung von Blobs verwendet werden sollen |
Cloud |
CloudError |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Current |
Gibt den aktuellen Schutzstatus der Ressource an. |
Datasource |
Datenquelle |
Datasource |
DatasourceSet |
Data |
Art des Datenspeichers; Betrieb/Tresor/Archiv |
Error |
Die Fehlerantwort für die Ressourcenverwaltung. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Inner |
InnerError |
Kubernetes |
Parameter für die Datenquelle für die Kubernetes-Clustersicherung |
Policy |
PolicyInfo |
Policy |
Parameter in Der Richtlinie |
Protection |
ProtectionStatusDetails |
Secret |
Anmeldeinformationen für die geheimnisbasierte Authentifizierung. |
Secret |
Klasse, die eine Geheimnisspeicherressource darstellt. |
Secret |
Ruft den Typ des Geheimnisspeichers ab oder legt den Typ fest. |
Status |
Gibt den Schutz status der Ressource an. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
User |
Fehlerobjekt, das von Ebenen verwendet wird, die Zugriff auf lokalisierte Inhalte haben, und diesen an den Benutzer weitergeben |
Validation |
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 |
Art des Datenspeichers; Betrieb/Tresor/Archiv |
|
objectType | string: |
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 |
Gibt den aktuellen Schutzstatus der Ressource an. |
|
dataSourceInfo |
Datenquelle |
|
dataSourceSetInfo |
DatasourceSet |
|
datasourceAuthCredentials | AuthCredentials: |
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 |
|
protectionErrorDetails |
Gibt den Schutzfehler der Ressource an. |
|
protectionStatus |
ProtectionStatusDetails |
|
provisioningState |
string |
Gibt den Bereitstellungsstatus der Ressource an, d. h. Bereitstellung/Aktualisierung/Erfolgreich/Fehler |
validationType |
Gibt den Typ der Überprüfung an. Im Fall von DeepValidation werden alle Überprüfungen der /validateForBackup-API erneut ausgeführt. |
BackupInstanceResource
BackupInstanceResource
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Proxyressourcen-ID stellt den vollständigen Pfad zur Ressource dar. |
name |
string |
Proxyressourcenname, der der Ressource zugeordnet ist. |
properties |
BackupInstanceResource-Eigenschaften |
|
systemData |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
|
tags |
object |
Proxyressourcentags. |
type |
string |
Proxyressourcentyp stellt den vollständigen Pfad des Formulars Namespace/ResourceType/ResourceType/... dar. |
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: |
Typ des spezifischen Objekts – wird für die Deserialisierung verwendet. |
CloudError
CloudError
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerantwort für die Ressourcenverwaltung. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
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 |
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 |
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: |
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. |
PolicyInfo
PolicyInfo
Name | Typ | Beschreibung |
---|---|---|
policyId |
string |
|
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[]: |
Ruft die Datenspeicherparameter ab oder legt sie fest. |
ProtectionStatusDetails
ProtectionStatusDetails
Name | Typ | Beschreibung |
---|---|---|
errorDetails |
Gibt den Schutz status Fehler der Ressource an. |
|
status |
Gibt den Schutz status der Ressource an. |
SecretStoreBasedAuthCredentials
Anmeldeinformationen für die geheimnisbasierte Authentifizierung.
Name | Typ | Beschreibung |
---|---|---|
objectType | string: |
Typ des spezifischen Objekts – wird für die Deserialisierung verwendet. |
secretStoreResource |
Geheimnisspeicherressource |
SecretStoreResource
Klasse, die eine Geheimnisspeicherressource darstellt.
Name | Typ | Beschreibung |
---|---|---|
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 |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
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 |
Weitere verwandte Fehler |
|
innerError |
InnerError |
|
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. |
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 |