Freigeben über


Microsoft.DataProtection backupVaults/backupInstances

Bicep-Ressourcendefinition

Der ressourcentyp backupVaults/backupInstances kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Format der Ressource

Um eine Microsoft.DataProtection/backupVaults/backupInstances-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.DataProtection/backupVaults/backupInstances@2025-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    datasourceAuthCredentials: {
      objectType: 'string'
      // For remaining properties, see AuthCredentials objects
    }
    dataSourceInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceProperties: {
        objectType: 'string'
        // For remaining properties, see BaseResourceProperties objects
      }
      resourceType: 'string'
      resourceUri: 'string'
    }
    dataSourceSetInfo: {
      datasourceType: 'string'
      objectType: 'string'
      resourceID: 'string'
      resourceLocation: 'string'
      resourceName: 'string'
      resourceProperties: {
        objectType: 'string'
        // For remaining properties, see BaseResourceProperties objects
      }
      resourceType: 'string'
      resourceUri: 'string'
    }
    friendlyName: 'string'
    identityDetails: {
      userAssignedIdentityArmUrl: 'string'
      useSystemAssignedIdentity: bool
    }
    objectType: 'string'
    policyInfo: {
      policyId: 'string'
      policyParameters: {
        backupDatasourceParametersList: [
          {
            objectType: 'string'
            // For remaining properties, see BackupDatasourceParameters objects
          }
        ]
        dataStoreParametersList: [
          {
            dataStoreType: 'string'
            objectType: 'string'
            // For remaining properties, see DataStoreParameters objects
          }
        ]
      }
    }
    resourceGuardOperationRequests: [
      'string'
    ]
    validationType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupDatasourceParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AdlsBlobBackupDatasourceParameters Folgendes:

{
  containersList: [
    'string'
  ]
  objectType: 'AdlsBlobBackupDatasourceParameters'
}

Verwenden Sie für KubernetesClusterBackupDatasourceParameters:

{
  backupHookReferences: [
    {
      name: 'string'
      namespace: 'string'
    }
  ]
  excludedNamespaces: [
    'string'
  ]
  excludedResourceTypes: [
    'string'
  ]
  includeClusterScopeResources: bool
  includedNamespaces: [
    'string'
  ]
  includedResourceTypes: [
    'string'
  ]
  includedVolumeTypes: [
    'string'
  ]
  labelSelectors: [
    'string'
  ]
  objectType: 'KubernetesClusterBackupDatasourceParameters'
  snapshotVolumes: bool
}

AuthCredentials-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für SecretStoreBasedAuthCredentials Folgendes:

{
  objectType: 'SecretStoreBasedAuthCredentials'
  secretStoreResource: {
    secretStoreType: 'string'
    uri: 'string'
    value: 'string'
  }
}

BaseResourceProperties-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für DefaultResourceProperties Folgendes:

{
  objectType: 'DefaultResourceProperties'
}

DataStoreParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureOperationalStoreParameters Folgendes:

{
  objectType: 'AzureOperationalStoreParameters'
  resourceGroupId: 'string'
}

Eigenschaftswerte

Microsoft.DataProtection/backupVaults/backupInstances

Name Description Value
name Der Ressourcenname Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: backupVaults
properties BackupInstanceResource-Eigenschaften BackupInstance
tags Ressourcenetiketten Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

AdlsBlobBackupDatasourceParameters

Name Description Value
containersList Liste der Container, die während der Konfiguration der Sicherung von Blobs gesichert werden sollen string[] (erforderlich)
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AdlsBlobBackupDatasourceParameters' (erforderlich)

AuthCredentials

Name Description Value
objectType Legen Sie den Wert auf 'SecretStoreBasedAuthCredentials' für den Typ SecretStoreBasedAuthCredentials fest. 'SecretStoreBasedAuthCredentials' (erforderlich)

AzureOperationalStoreParameters

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AzureOperationalStoreParameters' (erforderlich)
resourceGroupId Dient zum Abrufen oder Festlegen des Snapshot Resource Group URI. string

BackupDatasourceParameters

Name Description Value
objectType Legen Sie den Wert auf 'AdlsBlobBackupDatasourceParameters' für den Typ AdlsBlobBackupDatasourceParameters fest. Legen Sie den Wert auf 'KubernetesClusterBackupDatasourceParameters' für den Typ KubernetesClusterBackupDatasourceParameters fest. 'AdlsBlobBackupDatasourceParameters'
'KubernetesClusterBackupDatasourceParameters' (erforderlich)

BackupInstance

Name Description Value
datasourceAuthCredentials Anmeldeinformationen, die für die Authentifizierung beim Datenquellenanbieter verwendet werden sollen. AuthCredentials
dataSourceInfo Ruft die Datenquelleninformationen ab oder legt sie fest. Datenquelle (erforderlich)
dataSourceSetInfo Ruft die Datenquellensatzinformationen ab oder legt sie fest. DatasourceSet
friendlyName Ruft den Anzeigenamen der Sicherungsinstanz ab oder legt diesen fest. string
identityDetails Enthält Informationen zu den Identitätsdetails für die BI.
Wenn er null ist, wird der Standardwert als "System zugewiesen" betrachtet.
IdentityDetails
objectType Zeichenfolge (erforderlich)
policyInfo Ruft die Richtlinieninformationen ab oder legt sie fest. PolicyInfo (erforderlich)
resourceGuardOperationRequests ResourceGuardOperationRequests, für die LAC-Überprüfung ausgeführt wird string[]
validationType Gibt den Typ der Überprüfung an. Bei DeepValidation werden alle Überprüfungen aus der /validateForBackup-API erneut ausgeführt. 'DeepValidation'
'ShallowValidation'

BackupInstanceResourceTags

Name Description Value

BaseResourceProperties

Name Description Value
objectType Legen Sie für den Typ DefaultResourceProperties den Wert auf ' DefaultResourceProperties' fest. 'DefaultResourceProperties' (erforderlich)

Datasource

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für die Datenquelle spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DatasourceSet

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für datenquellenspezifischen Satz spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DataStoreParameters

Name Description Value
dataStoreType Art des Datenspeichers; Operational/Vault/Archive 'ArchiveStore'
'OperationalStore'
'VaultStore' (erforderlich)
objectType Legen Sie den Typ AzureOperationalStoreParameters auf "AzureOperationalStoreParameters" fest. 'AzureOperationalStoreParameters' (erforderlich)

DefaultResourceProperties

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'DefaultResourceProperties' (erforderlich)

IdentityDetails

Name Description Value
userAssignedIdentityArmUrl ARM-URL für Benutzer zugewiesene Identität. string
useSystemAssignedIdentity Gibt an, ob die BI durch Systemidentität geschützt ist. bool

KubernetesClusterBackupDatasourceParameters

Name Description Value
backupHookReferences Ruft die Sicherungshakenverweise ab oder legt sie fest. Diese Eigenschaft legt den Hook-Verweis fest, der während der Sicherung ausgeführt werden soll. NamespacedNameResource[]
excludedNamespaces Dient zum Abrufen oder Festlegen der Exclude Namespaces -Eigenschaft. Diese Eigenschaft legt fest, dass die Namespaces während der Sicherung ausgeschlossen werden. string[]
excludedResourceTypes Dient zum Abrufen oder Festlegen der Eigenschaft "Ausschließen von Ressourcentypen". Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung ausgeschlossen werden sollen. string[]
includeClusterScopeResources Dient zum Abrufen oder Festlegen der Include-Clusterressourcen-Eigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, enthält Clusterbereichsressourcen während der Sicherung. bool (erforderlich)
includedNamespaces Dient zum Abrufen oder Festlegen der Include-Namespaces-Eigenschaft. Diese Eigenschaft legt die Namespaces fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedResourceTypes Dient zum Abrufen oder Festlegen der Include-Ressourcentypen-Eigenschaft. Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedVolumeTypes Dient zum Abrufen oder Festlegen der Include Volume types -Eigenschaft. Diese Eigenschaft legt die Volumetypen fest, die während der Sicherung eingeschlossen werden sollen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'AzureDisk'
'AzureFileShareSMB'
labelSelectors Dient zum Abrufen oder Festlegen der LabelSelectors -Eigenschaft. Diese Eigenschaft legt die Ressource mit solchen Bezeichnungsmarkierern fest, die während der Sicherung eingeschlossen werden sollen. string[]
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'KubernetesClusterBackupDatasourceParameters' (erforderlich)
snapshotVolumes Dient zum Abrufen oder Festlegen der Volumemomentaufnahmeeigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, nimmt während der Sicherung Volumemomentaufnahmen auf. bool (erforderlich)

NamespacedNameResource

Name Description Value
name Name der Ressource string
namespace Namespace, in dem die Ressource vorhanden ist string

PolicyInfo

Name Description Value
policyId Zeichenfolge (erforderlich)
policyParameters Richtlinienparameter für die Sicherungsinstanz PolicyParameters

PolicyParameters

Name Description Value
backupDatasourceParametersList Ruft die Parameter der Sicherungsdatenquelle ab oder legt diese fest. BackupDatasourceParameters[]
dataStoreParametersList Dient zum Abrufen oder Festlegen der DataStore-Parameter DataStoreParameters[]

SecretStoreBasedAuthCredentials

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'SecretStoreBasedAuthCredentials' (erforderlich)
secretStoreResource Ressource für geheimen Speicher SecretStoreResource

SecretStoreResource

Name Description Value
secretStoreType Dient zum Abrufen oder Festlegen des Typs des geheimen Speichers. 'AzureKeyVault'
'Ungültig' (erforderlich)
uri URI zum Abrufen der Ressource string
value Dient zum Abrufen oder Festlegen des Werts, der in der Ressource für den geheimen Speicher gespeichert ist. string

Verwendungsbeispiele

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bizeps-Datei Description
Erstellen von Datenträger-& den Schutz über backup Vault Vorlage, die einen Datenträger erstellt und den Schutz über den Sicherungstresor ermöglicht
Erstellen eines flexiblen MySQL-Servers und Aktivieren des Schutzes über Backup Vault Vorlage, die einen flexiblen MySQL-Server erstellt und den Schutz über backup Vault ermöglicht
Erstellen von PgFlex-Server & den Schutz über backup Vault Vorlage, die einen flexiblen PostgreSQL-Server erstellt und den Schutz über backup Vault ermöglicht
Speicherkonto erstellen und Schutz über Backup Vault aktivieren Vorlage zum Erstellen eines Speicherkontos und Aktivieren der betriebs- und tresorierten Sicherung über den Sicherungstresor

ARM-Vorlagenressourcendefinition

Der ressourcentyp backupVaults/backupInstances kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Format der Ressource

Um eine Microsoft.DataProtection/backupVaults/backupInstances-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "apiVersion": "2025-09-01",
  "name": "string",
  "properties": {
    "datasourceAuthCredentials": {
      "objectType": "string"
      // For remaining properties, see AuthCredentials objects
    },
    "dataSourceInfo": {
      "datasourceType": "string",
      "objectType": "string",
      "resourceID": "string",
      "resourceLocation": "string",
      "resourceName": "string",
      "resourceProperties": {
        "objectType": "string"
        // For remaining properties, see BaseResourceProperties objects
      },
      "resourceType": "string",
      "resourceUri": "string"
    },
    "dataSourceSetInfo": {
      "datasourceType": "string",
      "objectType": "string",
      "resourceID": "string",
      "resourceLocation": "string",
      "resourceName": "string",
      "resourceProperties": {
        "objectType": "string"
        // For remaining properties, see BaseResourceProperties objects
      },
      "resourceType": "string",
      "resourceUri": "string"
    },
    "friendlyName": "string",
    "identityDetails": {
      "userAssignedIdentityArmUrl": "string",
      "useSystemAssignedIdentity": "bool"
    },
    "objectType": "string",
    "policyInfo": {
      "policyId": "string",
      "policyParameters": {
        "backupDatasourceParametersList": [ {
          "objectType": "string"
          // For remaining properties, see BackupDatasourceParameters objects
        } ],
        "dataStoreParametersList": [ {
          "dataStoreType": "string",
          "objectType": "string"
          // For remaining properties, see DataStoreParameters objects
        } ]
      }
    },
    "resourceGuardOperationRequests": [ "string" ],
    "validationType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

BackupDatasourceParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AdlsBlobBackupDatasourceParameters Folgendes:

{
  "containersList": [ "string" ],
  "objectType": "AdlsBlobBackupDatasourceParameters"
}

Verwenden Sie für KubernetesClusterBackupDatasourceParameters:

{
  "backupHookReferences": [
    {
      "name": "string",
      "namespace": "string"
    }
  ],
  "excludedNamespaces": [ "string" ],
  "excludedResourceTypes": [ "string" ],
  "includeClusterScopeResources": "bool",
  "includedNamespaces": [ "string" ],
  "includedResourceTypes": [ "string" ],
  "includedVolumeTypes": [ "string" ],
  "labelSelectors": [ "string" ],
  "objectType": "KubernetesClusterBackupDatasourceParameters",
  "snapshotVolumes": "bool"
}

AuthCredentials-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für SecretStoreBasedAuthCredentials Folgendes:

{
  "objectType": "SecretStoreBasedAuthCredentials",
  "secretStoreResource": {
    "secretStoreType": "string",
    "uri": "string",
    "value": "string"
  }
}

BaseResourceProperties-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für DefaultResourceProperties Folgendes:

{
  "objectType": "DefaultResourceProperties"
}

DataStoreParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureOperationalStoreParameters Folgendes:

{
  "objectType": "AzureOperationalStoreParameters",
  "resourceGroupId": "string"
}

Eigenschaftswerte

Microsoft.DataProtection/backupVaults/backupInstances

Name Description Value
apiVersion Die API-Version '2025-09-01'
name Der Ressourcenname Zeichenfolge (erforderlich)
properties BackupInstanceResource-Eigenschaften BackupInstance
tags Ressourcenetiketten Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
type Der Ressourcentyp 'Microsoft.DataProtection/backupVaults/backupInstances'

AdlsBlobBackupDatasourceParameters

Name Description Value
containersList Liste der Container, die während der Konfiguration der Sicherung von Blobs gesichert werden sollen string[] (erforderlich)
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AdlsBlobBackupDatasourceParameters' (erforderlich)

AuthCredentials

Name Description Value
objectType Legen Sie den Wert auf 'SecretStoreBasedAuthCredentials' für den Typ SecretStoreBasedAuthCredentials fest. 'SecretStoreBasedAuthCredentials' (erforderlich)

AzureOperationalStoreParameters

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AzureOperationalStoreParameters' (erforderlich)
resourceGroupId Dient zum Abrufen oder Festlegen des Snapshot Resource Group URI. string

BackupDatasourceParameters

Name Description Value
objectType Legen Sie den Wert auf 'AdlsBlobBackupDatasourceParameters' für den Typ AdlsBlobBackupDatasourceParameters fest. Legen Sie den Wert auf 'KubernetesClusterBackupDatasourceParameters' für den Typ KubernetesClusterBackupDatasourceParameters fest. 'AdlsBlobBackupDatasourceParameters'
'KubernetesClusterBackupDatasourceParameters' (erforderlich)

BackupInstance

Name Description Value
datasourceAuthCredentials Anmeldeinformationen, die für die Authentifizierung beim Datenquellenanbieter verwendet werden sollen. AuthCredentials
dataSourceInfo Ruft die Datenquelleninformationen ab oder legt sie fest. Datenquelle (erforderlich)
dataSourceSetInfo Ruft die Datenquellensatzinformationen ab oder legt sie fest. DatasourceSet
friendlyName Ruft den Anzeigenamen der Sicherungsinstanz ab oder legt diesen fest. string
identityDetails Enthält Informationen zu den Identitätsdetails für die BI.
Wenn er null ist, wird der Standardwert als "System zugewiesen" betrachtet.
IdentityDetails
objectType Zeichenfolge (erforderlich)
policyInfo Ruft die Richtlinieninformationen ab oder legt sie fest. PolicyInfo (erforderlich)
resourceGuardOperationRequests ResourceGuardOperationRequests, für die LAC-Überprüfung ausgeführt wird string[]
validationType Gibt den Typ der Überprüfung an. Bei DeepValidation werden alle Überprüfungen aus der /validateForBackup-API erneut ausgeführt. 'DeepValidation'
'ShallowValidation'

BackupInstanceResourceTags

Name Description Value

BaseResourceProperties

Name Description Value
objectType Legen Sie für den Typ DefaultResourceProperties den Wert auf ' DefaultResourceProperties' fest. 'DefaultResourceProperties' (erforderlich)

Datasource

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für die Datenquelle spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DatasourceSet

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für datenquellenspezifischen Satz spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DataStoreParameters

Name Description Value
dataStoreType Art des Datenspeichers; Operational/Vault/Archive 'ArchiveStore'
'OperationalStore'
'VaultStore' (erforderlich)
objectType Legen Sie den Typ AzureOperationalStoreParameters auf "AzureOperationalStoreParameters" fest. 'AzureOperationalStoreParameters' (erforderlich)

DefaultResourceProperties

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'DefaultResourceProperties' (erforderlich)

IdentityDetails

Name Description Value
userAssignedIdentityArmUrl ARM-URL für Benutzer zugewiesene Identität. string
useSystemAssignedIdentity Gibt an, ob die BI durch Systemidentität geschützt ist. bool

KubernetesClusterBackupDatasourceParameters

Name Description Value
backupHookReferences Ruft die Sicherungshakenverweise ab oder legt sie fest. Diese Eigenschaft legt den Hook-Verweis fest, der während der Sicherung ausgeführt werden soll. NamespacedNameResource[]
excludedNamespaces Dient zum Abrufen oder Festlegen der Exclude Namespaces -Eigenschaft. Diese Eigenschaft legt fest, dass die Namespaces während der Sicherung ausgeschlossen werden. string[]
excludedResourceTypes Dient zum Abrufen oder Festlegen der Eigenschaft "Ausschließen von Ressourcentypen". Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung ausgeschlossen werden sollen. string[]
includeClusterScopeResources Dient zum Abrufen oder Festlegen der Include-Clusterressourcen-Eigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, enthält Clusterbereichsressourcen während der Sicherung. bool (erforderlich)
includedNamespaces Dient zum Abrufen oder Festlegen der Include-Namespaces-Eigenschaft. Diese Eigenschaft legt die Namespaces fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedResourceTypes Dient zum Abrufen oder Festlegen der Include-Ressourcentypen-Eigenschaft. Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedVolumeTypes Dient zum Abrufen oder Festlegen der Include Volume types -Eigenschaft. Diese Eigenschaft legt die Volumetypen fest, die während der Sicherung eingeschlossen werden sollen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'AzureDisk'
'AzureFileShareSMB'
labelSelectors Dient zum Abrufen oder Festlegen der LabelSelectors -Eigenschaft. Diese Eigenschaft legt die Ressource mit solchen Bezeichnungsmarkierern fest, die während der Sicherung eingeschlossen werden sollen. string[]
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'KubernetesClusterBackupDatasourceParameters' (erforderlich)
snapshotVolumes Dient zum Abrufen oder Festlegen der Volumemomentaufnahmeeigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, nimmt während der Sicherung Volumemomentaufnahmen auf. bool (erforderlich)

NamespacedNameResource

Name Description Value
name Name der Ressource string
namespace Namespace, in dem die Ressource vorhanden ist string

PolicyInfo

Name Description Value
policyId Zeichenfolge (erforderlich)
policyParameters Richtlinienparameter für die Sicherungsinstanz PolicyParameters

PolicyParameters

Name Description Value
backupDatasourceParametersList Ruft die Parameter der Sicherungsdatenquelle ab oder legt diese fest. BackupDatasourceParameters[]
dataStoreParametersList Dient zum Abrufen oder Festlegen der DataStore-Parameter DataStoreParameters[]

SecretStoreBasedAuthCredentials

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'SecretStoreBasedAuthCredentials' (erforderlich)
secretStoreResource Ressource für geheimen Speicher SecretStoreResource

SecretStoreResource

Name Description Value
secretStoreType Dient zum Abrufen oder Festlegen des Typs des geheimen Speichers. 'AzureKeyVault'
'Ungültig' (erforderlich)
uri URI zum Abrufen der Ressource string
value Dient zum Abrufen oder Festlegen des Werts, der in der Ressource für den geheimen Speicher gespeichert ist. string

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Template Description
Erstellen von Datenträger-& den Schutz über backup Vault

Bereitstellung in Azure
Vorlage, die einen Datenträger erstellt und den Schutz über den Sicherungstresor ermöglicht
Erstellen eines flexiblen MySQL-Servers und Aktivieren des Schutzes über Backup Vault

Bereitstellung in Azure
Vorlage, die einen flexiblen MySQL-Server erstellt und den Schutz über backup Vault ermöglicht
Erstellen von PgFlex-Server & den Schutz über backup Vault

Bereitstellung in Azure
Vorlage, die einen flexiblen PostgreSQL-Server erstellt und den Schutz über backup Vault ermöglicht
Speicherkonto erstellen und Schutz über Backup Vault aktivieren

Bereitstellung in Azure
Vorlage zum Erstellen eines Speicherkontos und Aktivieren der betriebs- und tresorierten Sicherung über den Sicherungstresor

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der ressourcentyp backupVaults/backupInstances kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Format der Ressource

Um eine Microsoft.DataProtection/backupVaults/backupInstances-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataProtection/backupVaults/backupInstances@2025-09-01"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      datasourceAuthCredentials = {
        objectType = "string"
        // For remaining properties, see AuthCredentials objects
      }
      dataSourceInfo = {
        datasourceType = "string"
        objectType = "string"
        resourceID = "string"
        resourceLocation = "string"
        resourceName = "string"
        resourceProperties = {
          objectType = "string"
          // For remaining properties, see BaseResourceProperties objects
        }
        resourceType = "string"
        resourceUri = "string"
      }
      dataSourceSetInfo = {
        datasourceType = "string"
        objectType = "string"
        resourceID = "string"
        resourceLocation = "string"
        resourceName = "string"
        resourceProperties = {
          objectType = "string"
          // For remaining properties, see BaseResourceProperties objects
        }
        resourceType = "string"
        resourceUri = "string"
      }
      friendlyName = "string"
      identityDetails = {
        userAssignedIdentityArmUrl = "string"
        useSystemAssignedIdentity = bool
      }
      objectType = "string"
      policyInfo = {
        policyId = "string"
        policyParameters = {
          backupDatasourceParametersList = [
            {
              objectType = "string"
              // For remaining properties, see BackupDatasourceParameters objects
            }
          ]
          dataStoreParametersList = [
            {
              dataStoreType = "string"
              objectType = "string"
              // For remaining properties, see DataStoreParameters objects
            }
          ]
        }
      }
      resourceGuardOperationRequests = [
        "string"
      ]
      validationType = "string"
    }
  }
}

BackupDatasourceParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AdlsBlobBackupDatasourceParameters Folgendes:

{
  containersList = [
    "string"
  ]
  objectType = "AdlsBlobBackupDatasourceParameters"
}

Verwenden Sie für KubernetesClusterBackupDatasourceParameters:

{
  backupHookReferences = [
    {
      name = "string"
      namespace = "string"
    }
  ]
  excludedNamespaces = [
    "string"
  ]
  excludedResourceTypes = [
    "string"
  ]
  includeClusterScopeResources = bool
  includedNamespaces = [
    "string"
  ]
  includedResourceTypes = [
    "string"
  ]
  includedVolumeTypes = [
    "string"
  ]
  labelSelectors = [
    "string"
  ]
  objectType = "KubernetesClusterBackupDatasourceParameters"
  snapshotVolumes = bool
}

AuthCredentials-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für SecretStoreBasedAuthCredentials Folgendes:

{
  objectType = "SecretStoreBasedAuthCredentials"
  secretStoreResource = {
    secretStoreType = "string"
    uri = "string"
    value = "string"
  }
}

BaseResourceProperties-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für DefaultResourceProperties Folgendes:

{
  objectType = "DefaultResourceProperties"
}

DataStoreParameters-Objekte

Legen Sie die objectType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureOperationalStoreParameters Folgendes:

{
  objectType = "AzureOperationalStoreParameters"
  resourceGroupId = "string"
}

Eigenschaftswerte

Microsoft.DataProtection/backupVaults/backupInstances

Name Description Value
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: backupVaults
properties BackupInstanceResource-Eigenschaften BackupInstance
tags Ressourcenetiketten Wörterbuch der Tagnamen und -werte.
type Der Ressourcentyp "Microsoft.DataProtection/backupVaults/backupInstances@2025-09-01"

AdlsBlobBackupDatasourceParameters

Name Description Value
containersList Liste der Container, die während der Konfiguration der Sicherung von Blobs gesichert werden sollen string[] (erforderlich)
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AdlsBlobBackupDatasourceParameters' (erforderlich)

AuthCredentials

Name Description Value
objectType Legen Sie den Wert auf 'SecretStoreBasedAuthCredentials' für den Typ SecretStoreBasedAuthCredentials fest. 'SecretStoreBasedAuthCredentials' (erforderlich)

AzureOperationalStoreParameters

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'AzureOperationalStoreParameters' (erforderlich)
resourceGroupId Dient zum Abrufen oder Festlegen des Snapshot Resource Group URI. string

BackupDatasourceParameters

Name Description Value
objectType Legen Sie den Wert auf 'AdlsBlobBackupDatasourceParameters' für den Typ AdlsBlobBackupDatasourceParameters fest. Legen Sie den Wert auf 'KubernetesClusterBackupDatasourceParameters' für den Typ KubernetesClusterBackupDatasourceParameters fest. 'AdlsBlobBackupDatasourceParameters'
'KubernetesClusterBackupDatasourceParameters' (erforderlich)

BackupInstance

Name Description Value
datasourceAuthCredentials Anmeldeinformationen, die für die Authentifizierung beim Datenquellenanbieter verwendet werden sollen. AuthCredentials
dataSourceInfo Ruft die Datenquelleninformationen ab oder legt sie fest. Datenquelle (erforderlich)
dataSourceSetInfo Ruft die Datenquellensatzinformationen ab oder legt sie fest. DatasourceSet
friendlyName Ruft den Anzeigenamen der Sicherungsinstanz ab oder legt diesen fest. string
identityDetails Enthält Informationen zu den Identitätsdetails für die BI.
Wenn er null ist, wird der Standardwert als "System zugewiesen" betrachtet.
IdentityDetails
objectType Zeichenfolge (erforderlich)
policyInfo Ruft die Richtlinieninformationen ab oder legt sie fest. PolicyInfo (erforderlich)
resourceGuardOperationRequests ResourceGuardOperationRequests, für die LAC-Überprüfung ausgeführt wird string[]
validationType Gibt den Typ der Überprüfung an. Bei DeepValidation werden alle Überprüfungen aus der /validateForBackup-API erneut ausgeführt. 'DeepValidation'
'ShallowValidation'

BackupInstanceResourceTags

Name Description Value

BaseResourceProperties

Name Description Value
objectType Legen Sie für den Typ DefaultResourceProperties den Wert auf ' DefaultResourceProperties' fest. 'DefaultResourceProperties' (erforderlich)

Datasource

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für die Datenquelle spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DatasourceSet

Name Description Value
datasourceType DatasourceType der Ressource. string
objectType Typ des Datasource-Objekts, der zum Initialisieren des richtigen geerbten Typs verwendet wird string
resourceID Vollständige ARM-ID der Ressource. Bei Azure-Ressourcen ist dies ARM-ID. Bei Nicht-Azure-Ressourcen ist dies die ID, die vom Sicherungsdienst über Fabric/Vault erstellt wird. Zeichenfolge (erforderlich)
resourceLocation Speicherort der Datenquelle. string
resourceName Eindeutiger Bezeichner der Ressource im Kontext des übergeordneten Elements. string
resourceProperties Eigenschaften, die für datenquellenspezifischen Satz spezifisch sind BaseResourceProperties
resourceType Ressourcentyp der Datenquelle. string
resourceUri URI der Ressource. string

DataStoreParameters

Name Description Value
dataStoreType Art des Datenspeichers; Operational/Vault/Archive 'ArchiveStore'
'OperationalStore'
'VaultStore' (erforderlich)
objectType Legen Sie den Typ AzureOperationalStoreParameters auf "AzureOperationalStoreParameters" fest. 'AzureOperationalStoreParameters' (erforderlich)

DefaultResourceProperties

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'DefaultResourceProperties' (erforderlich)

IdentityDetails

Name Description Value
userAssignedIdentityArmUrl ARM-URL für Benutzer zugewiesene Identität. string
useSystemAssignedIdentity Gibt an, ob die BI durch Systemidentität geschützt ist. bool

KubernetesClusterBackupDatasourceParameters

Name Description Value
backupHookReferences Ruft die Sicherungshakenverweise ab oder legt sie fest. Diese Eigenschaft legt den Hook-Verweis fest, der während der Sicherung ausgeführt werden soll. NamespacedNameResource[]
excludedNamespaces Dient zum Abrufen oder Festlegen der Exclude Namespaces -Eigenschaft. Diese Eigenschaft legt fest, dass die Namespaces während der Sicherung ausgeschlossen werden. string[]
excludedResourceTypes Dient zum Abrufen oder Festlegen der Eigenschaft "Ausschließen von Ressourcentypen". Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung ausgeschlossen werden sollen. string[]
includeClusterScopeResources Dient zum Abrufen oder Festlegen der Include-Clusterressourcen-Eigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, enthält Clusterbereichsressourcen während der Sicherung. bool (erforderlich)
includedNamespaces Dient zum Abrufen oder Festlegen der Include-Namespaces-Eigenschaft. Diese Eigenschaft legt die Namespaces fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedResourceTypes Dient zum Abrufen oder Festlegen der Include-Ressourcentypen-Eigenschaft. Diese Eigenschaft legt die Ressourcentypen fest, die während der Sicherung eingeschlossen werden sollen. string[]
includedVolumeTypes Dient zum Abrufen oder Festlegen der Include Volume types -Eigenschaft. Diese Eigenschaft legt die Volumetypen fest, die während der Sicherung eingeschlossen werden sollen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'AzureDisk'
'AzureFileShareSMB'
labelSelectors Dient zum Abrufen oder Festlegen der LabelSelectors -Eigenschaft. Diese Eigenschaft legt die Ressource mit solchen Bezeichnungsmarkierern fest, die während der Sicherung eingeschlossen werden sollen. string[]
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'KubernetesClusterBackupDatasourceParameters' (erforderlich)
snapshotVolumes Dient zum Abrufen oder Festlegen der Volumemomentaufnahmeeigenschaft. Diese Eigenschaft, wenn diese Option aktiviert ist, nimmt während der Sicherung Volumemomentaufnahmen auf. bool (erforderlich)

NamespacedNameResource

Name Description Value
name Name der Ressource string
namespace Namespace, in dem die Ressource vorhanden ist string

PolicyInfo

Name Description Value
policyId Zeichenfolge (erforderlich)
policyParameters Richtlinienparameter für die Sicherungsinstanz PolicyParameters

PolicyParameters

Name Description Value
backupDatasourceParametersList Ruft die Parameter der Sicherungsdatenquelle ab oder legt diese fest. BackupDatasourceParameters[]
dataStoreParametersList Dient zum Abrufen oder Festlegen der DataStore-Parameter DataStoreParameters[]

SecretStoreBasedAuthCredentials

Name Description Value
objectType Typ des spezifischen Objekts – wird für die Deserialisierung verwendet 'SecretStoreBasedAuthCredentials' (erforderlich)
secretStoreResource Ressource für geheimen Speicher SecretStoreResource

SecretStoreResource

Name Description Value
secretStoreType Dient zum Abrufen oder Festlegen des Typs des geheimen Speichers. 'AzureKeyVault'
'Ungültig' (erforderlich)
uri URI zum Abrufen der Ressource string
value Dient zum Abrufen oder Festlegen des Werts, der in der Ressource für den geheimen Speicher gespeichert ist. string

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung einer Backup-Instanz.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "administrator_login_password" {
  type        = string
  description = "The administrator login password for the PostgreSQL server"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "server" {
  type      = "Microsoft.DBforPostgreSQL/servers@2017-12-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      administratorLogin         = "psqladmin"
      administratorLoginPassword = var.administrator_login_password
      createMode                 = "Default"
      infrastructureEncryption   = "Disabled"
      minimalTlsVersion          = "TLS1_2"
      publicNetworkAccess        = "Enabled"
      sslEnforcement             = "Enabled"
      storageProfile = {
        backupRetentionDays = 7
        storageAutogrow     = "Enabled"
        storageMB           = 5120
      }
      version = "9.5"
    }
    sku = {
      capacity = 2
      family   = "Gen5"
      name     = "B_Gen5_2"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backupVault" {
  type      = "Microsoft.DataProtection/backupVaults@2022-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      storageSettings = [
        {
          datastoreType = "VaultStore"
          type          = "LocallyRedundant"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backupPolicy" {
  type      = "Microsoft.DataProtection/backupVaults/backupPolicies@2022-04-01"
  parent_id = azapi_resource.backupVault.id
  name      = var.resource_name
  body = {
    properties = {
      datasourceTypes = [
        "Microsoft.DBforPostgreSQL/servers/databases",
      ]
      objectType = "BackupPolicy"
      policyRules = [
        {
          backupParameters = {
            backupType = "Full"
            objectType = "AzureBackupParams"
          }
          dataStore = {
            dataStoreType = "VaultStore"
            objectType    = "DataStoreInfoBase"
          }
          name       = "BackupIntervals"
          objectType = "AzureBackupRule"
          trigger = {
            objectType = "ScheduleBasedTriggerContext"
            schedule = {
              repeatingTimeIntervals = [
                "R/2021-05-23T02:30:00+00:00/P1W",
              ]
            }
            taggingCriteria = [
              {
                isDefault = true
                tagInfo = {
                  id      = "Default_"
                  tagName = "Default"
                }
                taggingPriority = 99
              },
            ]
          }
        },
        {
          isDefault = true
          lifecycles = [
            {
              deleteAfter = {
                duration   = "P4M"
                objectType = "AbsoluteDeleteOption"
              }
              sourceDataStore = {
                dataStoreType = "VaultStore"
                objectType    = "DataStoreInfoBase"
              }
              targetDataStoreCopySettings = [
              ]
            },
          ]
          name       = "Default"
          objectType = "AzureRetentionRule"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "database" {
  type      = "Microsoft.DBforPostgreSQL/servers/databases@2017-12-01"
  parent_id = azapi_resource.server.id
  name      = var.resource_name
  body = {
    properties = {
      charset   = "UTF8"
      collation = "English_United States.1252"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backupInstance" {
  type      = "Microsoft.DataProtection/backupVaults/backupInstances@2022-04-01"
  parent_id = azapi_resource.backupVault.id
  name      = var.resource_name
  body = {
    properties = {
      dataSourceInfo = {
        datasourceType   = "Microsoft.DBforPostgreSQL/servers/databases"
        objectType       = "Datasource"
        resourceID       = azapi_resource.database.id
        resourceLocation = azapi_resource.database.location
        resourceName     = azapi_resource.database.name
        resourceType     = "Microsoft.DBforPostgreSQL/servers/databases"
        resourceUri      = ""
      }
      dataSourceSetInfo = {
        datasourceType   = "Microsoft.DBforPostgreSQL/servers/databases"
        objectType       = "DatasourceSet"
        resourceID       = azapi_resource.server.id
        resourceLocation = azapi_resource.server.location
        resourceName     = azapi_resource.server.name
        resourceType     = "Microsoft.DBForPostgreSQL/servers"
        resourceUri      = ""
      }
      datasourceAuthCredentials = null
      friendlyName              = var.resource_name
      objectType                = "BackupInstance"
      policyInfo = {
        policyId = azapi_resource.backupPolicy.id
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}