Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
- Latest
- 2025-09-01
- 2025-07-01
- 2025-02-01
- 2025-01-01
- 2024-04-01
- 2024-03-01
- 2024-02-01-preview
- 2023-12-01
- 2023-11-01
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-05-01
- 2023-04-01-preview
- 2023-01-01
- 2022-12-01
- 2022-11-01-preview
- 2022-10-01-preview
- 2022-09-01-preview
- 2022-05-01
- 2022-04-01
- 2022-03-31-preview
- 2022-03-01
- 2022-02-01-preview
- 2022-01-01
- 2021-12-01-preview
- 2021-10-01-preview
- 2021-07-01
- 2021-06-01-preview
- 2021-02-01-preview
- 2021-01-01
Definicja zasobu Bicep
Typ zasobu backupVaults/backupInstances można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DataProtection/backupVaults/backupInstances, dodaj następujący kod Bicep do szablonu.
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'
}
}
Obiekty AuthCredentials
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku obiektów SecretStoreBasedAuthCredentials użyj:
{
objectType: 'SecretStoreBasedAuthCredentials'
secretStoreResource: {
secretStoreType: 'string'
uri: 'string'
value: 'string'
}
}
Obiekty DataStoreParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku parametrów AzureOperationalStoreParameters użyj:
{
objectType: 'AzureOperationalStoreParameters'
resourceGroupId: 'string'
}
Obiekty BaseResourceProperties
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku właściwości DefaultResourceProperties użyj:
{
objectType: 'DefaultResourceProperties'
}
Obiekty BackupDatasourceParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku AdlsBlobBackupDatasourceParameters użyj:
{
containersList: [
'string'
]
objectType: 'AdlsBlobBackupDatasourceParameters'
}
W przypadku parametru KubernetesClusterBackupDatasourceParameters użyj:
{
backupHookReferences: [
{
name: 'string'
namespace: 'string'
}
]
excludedNamespaces: [
'string'
]
excludedResourceTypes: [
'string'
]
includeClusterScopeResources: bool
includedNamespaces: [
'string'
]
includedResourceTypes: [
'string'
]
includedVolumeTypes: [
'string'
]
labelSelectors: [
'string'
]
objectType: 'KubernetesClusterBackupDatasourceParameters'
snapshotVolumes: bool
}
Wartości właściwości
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| nadrzędny | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: backupVaults |
| properties | Właściwości klasy BackupInstanceResource | BackupInstance |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
AdlsBlobBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| containersList | Lista kontenerów do utworzenia kopii zapasowej podczas konfigurowania kopii zapasowych obiektów blob | ciąg[] (wymagane) |
| objectType | Typ określonego obiektu — używany do deserializacji | "AdlsBlobBackupDatasourceParameters" (wymagane) |
AuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "SecretStoreBasedAuthCredentials" dla typu SecretStoreBasedAuthCredentials. | "SecretStoreBasedAuthCredentials" (wymagane) |
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "AzureOperationalStoreParameters" (wymagane) |
| resourceGroupId | Pobiera lub ustawia identyfikator URI grupy zasobów migawki. | ciąg |
BackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "AdlsBlobBackupDatasourceParameters" dla typu AdlsBlobBackupDatasourceParameters. Ustaw wartość "KubernetesClusterBackupDatasourceParameters" dla typu KubernetesClusterBackupDatasourceParameters. | 'AdlsBlobBackupDatasourceParameters' "KubernetesClusterBackupDatasourceParameters" (wymagane) |
BackupInstance
| Name | Description | Value |
|---|---|---|
| datasourceAuthCredentials | Poświadczenia używane do uwierzytelniania za pomocą dostawcy źródła danych. | AuthCredentials |
| dataSourceInfo | Pobiera lub ustawia informacje o źródle danych. | Źródło danych (wymagane) |
| dataSourceSetInfo | Pobiera lub ustawia informacje o zestawie źródeł danych. | DatasourceSet |
| friendlyName | Pobiera lub ustawia przyjazną nazwę wystąpienia kopii zapasowej. | ciąg |
| identityDetails | Zawiera informacje o szczegółach tożsamości dla analizy biznesowej. Jeśli ma wartość null, wartość domyślna zostanie uznana za przypisaną przez system. |
IdentityDetails |
| objectType | ciąg (wymagany) | |
| policyInfo | Pobiera lub ustawia informacje o zasadach. | PolicyInfo (wymagane) |
| resourceGuardOperationRequests | ResourceGuardOperationRequests, na którym zostanie wykonane sprawdzanie LAC | string[] |
| validationType | Określa typ weryfikacji. W przypadku funkcji DeepValidation wszystkie walidacje z interfejsu API /validateForBackup zostaną uruchomione ponownie. | 'DeepValidation' 'ShallowValidation' |
BackupInstanceResourceTags
| Name | Description | Value |
|---|
BaseResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "DefaultResourceProperties" dla typu DefaultResourceProperties. | "DefaultResourceProperties" (wymagane) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla źródła danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla zestawu źródeł danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | typ magazynu danych; Operacyjne/Magazyn/Archiwum | 'ArchiveStore' 'OperationalStore' "VaultStore" (wymagane) |
| objectType | Ustaw wartość "AzureOperationalStoreParameters" dla typu AzureOperationalStoreParameters. | "AzureOperationalStoreParameters" (wymagane) |
DefaultResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "DefaultResourceProperties" (wymagane) |
IdentityDetails
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityArmUrl | Adres URL usługi ARM dla tożsamości przypisanej przez użytkownika. | ciąg |
| useSystemAssignedIdentity | Określa, czy usługa BI jest chroniona przez tożsamość systemową. | bool |
KubernetesClusterBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| backupHookReferences | Pobiera lub ustawia odwołania punktów zaczepienia kopii zapasowej. Ta właściwość ustawia odwołanie haka do wykonania podczas tworzenia kopii zapasowej. | NamespacedNameResource[] |
| excludedNamespaces | Pobiera lub ustawia właściwość wykluczania przestrzeni nazw. Ta właściwość ustawia przestrzenie nazw, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| excludedResourceTypes | Pobiera lub ustawia właściwość wyklucz typy zasobów. Ta właściwość ustawia typy zasobów, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| includeClusterScopeResources | Pobiera lub ustawia właściwość dołączania zasobów klastra. Ta właściwość, jeśli jest włączona, będzie zawierać zasoby zakresu klastra podczas tworzenia kopii zapasowej. | bool (wymagane) |
| includedNamespaces | Pobiera lub ustawia właściwość uwzględnij przestrzenie nazw. Ta właściwość ustawia przestrzenie nazw, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedResourceTypes | Pobiera lub ustawia właściwość dołączania typów zasobów. Ta właściwość ustawia typy zasobów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedVolumeTypes | Pobiera lub ustawia właściwość dołączania typów woluminów. Ta właściwość ustawia typy woluminów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | Tablica ciągów zawierająca dowolną z: 'AzureDisk' 'AzureFileShareSMB' |
| labelSelectors | Pobiera lub ustawia właściwość LabelSelectors. Ta właściwość ustawia zasób z takimi selektorami etykiet, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| objectType | Typ określonego obiektu — używany do deserializacji | "KubernetesClusterBackupDatasourceParameters" (wymagane) |
| snapshotVolumes | Pobiera lub ustawia właściwość migawki woluminu. Ta właściwość, jeśli jest włączona, spowoduje utworzenie migawek woluminu podczas tworzenia kopii zapasowej. | bool (wymagane) |
NamespacedNameResource
| Name | Description | Value |
|---|---|---|
| name | Nazwa zasobu | ciąg |
| obszar nazw | Przestrzeń nazw, w której istnieje zasób | ciąg |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | ciąg (wymagany) | |
| policyParameters | Parametry zasad dla wystąpienia kopii zapasowej | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| backupDatasourceParametersList | Pobiera lub ustawia parametry źródła danych kopii zapasowej | BackupDatasourceParameters[] |
| dataStoreParametersList | Pobiera lub ustawia parametry magazynu danych | DataStoreParameters[] |
SecretStoreBasedAuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "SecretStoreBasedAuthCredentials" (wymagane) |
| secretStoreResource | Zasób magazynu wpisów tajnych | SecretStoreResource |
SecretStoreResource
| Name | Description | Value |
|---|---|---|
| secretStoreType | Pobiera lub ustawia typ magazynu wpisów tajnych | 'AzureKeyVault' "Nieprawidłowy" (wymagane) |
| uri | Identyfikator URI umożliwiający uzyskanie dostępu do zasobu | ciąg |
| value | Pobiera lub ustawia wartość przechowywaną w zasobie magazynu wpisów tajnych | ciąg |
Przykłady użycia
Przykłady szybkiego startu platformy Azure
Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.
| Plik Bicep | Description |
|---|---|
| tworzenie dysku & włączanie ochrony za pośrednictwem usługi Backup Vault | Szablon, który tworzy dysk i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
| Tworzenie serwera elastycznego MySQL i włączanie ochrony za pośrednictwem magazynu kopii zapasowych | Szablon, który tworzy serwer elastyczny MySQL i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
| tworzenie serwera PgFlex & włączanie ochrony za pośrednictwem usługi Backup Vault | Szablon, który tworzy serwer elastyczny PostgreSQL i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
| tworzenie konta magazynu & włączanie ochrony za pośrednictwem usługi Backup Vault | Szablon, który tworzy konto magazynu i włącza operacyjną i magazynowaną kopię zapasową za pośrednictwem magazynu kopii zapasowych |
Definicja zasobu szablonu usługi ARM
Typ zasobu backupVaults/backupInstances można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DataProtection/backupVaults/backupInstances, dodaj następujący kod JSON do szablonu.
{
"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"
}
}
Obiekty AuthCredentials
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku obiektów SecretStoreBasedAuthCredentials użyj:
{
"objectType": "SecretStoreBasedAuthCredentials",
"secretStoreResource": {
"secretStoreType": "string",
"uri": "string",
"value": "string"
}
}
Obiekty DataStoreParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku parametrów AzureOperationalStoreParameters użyj:
{
"objectType": "AzureOperationalStoreParameters",
"resourceGroupId": "string"
}
Obiekty BaseResourceProperties
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku właściwości DefaultResourceProperties użyj:
{
"objectType": "DefaultResourceProperties"
}
Obiekty BackupDatasourceParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku AdlsBlobBackupDatasourceParameters użyj:
{
"containersList": [ "string" ],
"objectType": "AdlsBlobBackupDatasourceParameters"
}
W przypadku parametru KubernetesClusterBackupDatasourceParameters użyj:
{
"backupHookReferences": [
{
"name": "string",
"namespace": "string"
}
],
"excludedNamespaces": [ "string" ],
"excludedResourceTypes": [ "string" ],
"includeClusterScopeResources": "bool",
"includedNamespaces": [ "string" ],
"includedResourceTypes": [ "string" ],
"includedVolumeTypes": [ "string" ],
"labelSelectors": [ "string" ],
"objectType": "KubernetesClusterBackupDatasourceParameters",
"snapshotVolumes": "bool"
}
Wartości właściwości
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| apiVersion | Wersja interfejsu API | '2025-09-01' |
| name | Nazwa zasobu | ciąg (wymagany) |
| properties | Właściwości klasy BackupInstanceResource | BackupInstance |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | 'Microsoft.DataProtection/backupVaults/backupInstances' |
AdlsBlobBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| containersList | Lista kontenerów do utworzenia kopii zapasowej podczas konfigurowania kopii zapasowych obiektów blob | ciąg[] (wymagane) |
| objectType | Typ określonego obiektu — używany do deserializacji | "AdlsBlobBackupDatasourceParameters" (wymagane) |
AuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "SecretStoreBasedAuthCredentials" dla typu SecretStoreBasedAuthCredentials. | "SecretStoreBasedAuthCredentials" (wymagane) |
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "AzureOperationalStoreParameters" (wymagane) |
| resourceGroupId | Pobiera lub ustawia identyfikator URI grupy zasobów migawki. | ciąg |
BackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "AdlsBlobBackupDatasourceParameters" dla typu AdlsBlobBackupDatasourceParameters. Ustaw wartość "KubernetesClusterBackupDatasourceParameters" dla typu KubernetesClusterBackupDatasourceParameters. | 'AdlsBlobBackupDatasourceParameters' "KubernetesClusterBackupDatasourceParameters" (wymagane) |
BackupInstance
| Name | Description | Value |
|---|---|---|
| datasourceAuthCredentials | Poświadczenia używane do uwierzytelniania za pomocą dostawcy źródła danych. | AuthCredentials |
| dataSourceInfo | Pobiera lub ustawia informacje o źródle danych. | Źródło danych (wymagane) |
| dataSourceSetInfo | Pobiera lub ustawia informacje o zestawie źródeł danych. | DatasourceSet |
| friendlyName | Pobiera lub ustawia przyjazną nazwę wystąpienia kopii zapasowej. | ciąg |
| identityDetails | Zawiera informacje o szczegółach tożsamości dla analizy biznesowej. Jeśli ma wartość null, wartość domyślna zostanie uznana za przypisaną przez system. |
IdentityDetails |
| objectType | ciąg (wymagany) | |
| policyInfo | Pobiera lub ustawia informacje o zasadach. | PolicyInfo (wymagane) |
| resourceGuardOperationRequests | ResourceGuardOperationRequests, na którym zostanie wykonane sprawdzanie LAC | string[] |
| validationType | Określa typ weryfikacji. W przypadku funkcji DeepValidation wszystkie walidacje z interfejsu API /validateForBackup zostaną uruchomione ponownie. | 'DeepValidation' 'ShallowValidation' |
BackupInstanceResourceTags
| Name | Description | Value |
|---|
BaseResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "DefaultResourceProperties" dla typu DefaultResourceProperties. | "DefaultResourceProperties" (wymagane) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla źródła danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla zestawu źródeł danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | typ magazynu danych; Operacyjne/Magazyn/Archiwum | 'ArchiveStore' 'OperationalStore' "VaultStore" (wymagane) |
| objectType | Ustaw wartość "AzureOperationalStoreParameters" dla typu AzureOperationalStoreParameters. | "AzureOperationalStoreParameters" (wymagane) |
DefaultResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "DefaultResourceProperties" (wymagane) |
IdentityDetails
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityArmUrl | Adres URL usługi ARM dla tożsamości przypisanej przez użytkownika. | ciąg |
| useSystemAssignedIdentity | Określa, czy usługa BI jest chroniona przez tożsamość systemową. | bool |
KubernetesClusterBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| backupHookReferences | Pobiera lub ustawia odwołania punktów zaczepienia kopii zapasowej. Ta właściwość ustawia odwołanie haka do wykonania podczas tworzenia kopii zapasowej. | NamespacedNameResource[] |
| excludedNamespaces | Pobiera lub ustawia właściwość wykluczania przestrzeni nazw. Ta właściwość ustawia przestrzenie nazw, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| excludedResourceTypes | Pobiera lub ustawia właściwość wyklucz typy zasobów. Ta właściwość ustawia typy zasobów, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| includeClusterScopeResources | Pobiera lub ustawia właściwość dołączania zasobów klastra. Ta właściwość, jeśli jest włączona, będzie zawierać zasoby zakresu klastra podczas tworzenia kopii zapasowej. | bool (wymagane) |
| includedNamespaces | Pobiera lub ustawia właściwość uwzględnij przestrzenie nazw. Ta właściwość ustawia przestrzenie nazw, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedResourceTypes | Pobiera lub ustawia właściwość dołączania typów zasobów. Ta właściwość ustawia typy zasobów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedVolumeTypes | Pobiera lub ustawia właściwość dołączania typów woluminów. Ta właściwość ustawia typy woluminów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | Tablica ciągów zawierająca dowolną z: 'AzureDisk' 'AzureFileShareSMB' |
| labelSelectors | Pobiera lub ustawia właściwość LabelSelectors. Ta właściwość ustawia zasób z takimi selektorami etykiet, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| objectType | Typ określonego obiektu — używany do deserializacji | "KubernetesClusterBackupDatasourceParameters" (wymagane) |
| snapshotVolumes | Pobiera lub ustawia właściwość migawki woluminu. Ta właściwość, jeśli jest włączona, spowoduje utworzenie migawek woluminu podczas tworzenia kopii zapasowej. | bool (wymagane) |
NamespacedNameResource
| Name | Description | Value |
|---|---|---|
| name | Nazwa zasobu | ciąg |
| obszar nazw | Przestrzeń nazw, w której istnieje zasób | ciąg |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | ciąg (wymagany) | |
| policyParameters | Parametry zasad dla wystąpienia kopii zapasowej | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| backupDatasourceParametersList | Pobiera lub ustawia parametry źródła danych kopii zapasowej | BackupDatasourceParameters[] |
| dataStoreParametersList | Pobiera lub ustawia parametry magazynu danych | DataStoreParameters[] |
SecretStoreBasedAuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "SecretStoreBasedAuthCredentials" (wymagane) |
| secretStoreResource | Zasób magazynu wpisów tajnych | SecretStoreResource |
SecretStoreResource
| Name | Description | Value |
|---|---|---|
| secretStoreType | Pobiera lub ustawia typ magazynu wpisów tajnych | 'AzureKeyVault' "Nieprawidłowy" (wymagane) |
| uri | Identyfikator URI umożliwiający uzyskanie dostępu do zasobu | ciąg |
| value | Pobiera lub ustawia wartość przechowywaną w zasobie magazynu wpisów tajnych | ciąg |
Przykłady użycia
Szablony szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.
| Template | Description |
|---|---|
|
tworzenie dysku & włączanie ochrony za pośrednictwem usługi Backup Vault |
Szablon, który tworzy dysk i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
|
Tworzenie serwera elastycznego MySQL i włączanie ochrony za pośrednictwem magazynu kopii zapasowych |
Szablon, który tworzy serwer elastyczny MySQL i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
|
tworzenie serwera PgFlex & włączanie ochrony za pośrednictwem usługi Backup Vault |
Szablon, który tworzy serwer elastyczny PostgreSQL i umożliwia ochronę za pośrednictwem magazynu kopii zapasowych |
|
tworzenie konta magazynu & włączanie ochrony za pośrednictwem usługi Backup Vault |
Szablon, który tworzy konto magazynu i włącza operacyjną i magazynowaną kopię zapasową za pośrednictwem magazynu kopii zapasowych |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu backupVaults/backupInstances można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DataProtection/backupVaults/backupInstances, dodaj następujący program Terraform do szablonu.
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"
}
}
}
Obiekty AuthCredentials
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku obiektów SecretStoreBasedAuthCredentials użyj:
{
objectType = "SecretStoreBasedAuthCredentials"
secretStoreResource = {
secretStoreType = "string"
uri = "string"
value = "string"
}
}
Obiekty DataStoreParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku parametrów AzureOperationalStoreParameters użyj:
{
objectType = "AzureOperationalStoreParameters"
resourceGroupId = "string"
}
Obiekty BaseResourceProperties
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku właściwości DefaultResourceProperties użyj:
{
objectType = "DefaultResourceProperties"
}
Obiekty BackupDatasourceParameters
Ustaw właściwość objectType , aby określić typ obiektu.
W przypadku AdlsBlobBackupDatasourceParameters użyj:
{
containersList = [
"string"
]
objectType = "AdlsBlobBackupDatasourceParameters"
}
W przypadku parametru KubernetesClusterBackupDatasourceParameters użyj:
{
backupHookReferences = [
{
name = "string"
namespace = "string"
}
]
excludedNamespaces = [
"string"
]
excludedResourceTypes = [
"string"
]
includeClusterScopeResources = bool
includedNamespaces = [
"string"
]
includedResourceTypes = [
"string"
]
includedVolumeTypes = [
"string"
]
labelSelectors = [
"string"
]
objectType = "KubernetesClusterBackupDatasourceParameters"
snapshotVolumes = bool
}
Wartości właściwości
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: backupVaults |
| properties | Właściwości klasy BackupInstanceResource | BackupInstance |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.DataProtection/backupVaults/backupInstances@2025-09-01" |
AdlsBlobBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| containersList | Lista kontenerów do utworzenia kopii zapasowej podczas konfigurowania kopii zapasowych obiektów blob | ciąg[] (wymagane) |
| objectType | Typ określonego obiektu — używany do deserializacji | "AdlsBlobBackupDatasourceParameters" (wymagane) |
AuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "SecretStoreBasedAuthCredentials" dla typu SecretStoreBasedAuthCredentials. | "SecretStoreBasedAuthCredentials" (wymagane) |
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "AzureOperationalStoreParameters" (wymagane) |
| resourceGroupId | Pobiera lub ustawia identyfikator URI grupy zasobów migawki. | ciąg |
BackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "AdlsBlobBackupDatasourceParameters" dla typu AdlsBlobBackupDatasourceParameters. Ustaw wartość "KubernetesClusterBackupDatasourceParameters" dla typu KubernetesClusterBackupDatasourceParameters. | 'AdlsBlobBackupDatasourceParameters' "KubernetesClusterBackupDatasourceParameters" (wymagane) |
BackupInstance
| Name | Description | Value |
|---|---|---|
| datasourceAuthCredentials | Poświadczenia używane do uwierzytelniania za pomocą dostawcy źródła danych. | AuthCredentials |
| dataSourceInfo | Pobiera lub ustawia informacje o źródle danych. | Źródło danych (wymagane) |
| dataSourceSetInfo | Pobiera lub ustawia informacje o zestawie źródeł danych. | DatasourceSet |
| friendlyName | Pobiera lub ustawia przyjazną nazwę wystąpienia kopii zapasowej. | ciąg |
| identityDetails | Zawiera informacje o szczegółach tożsamości dla analizy biznesowej. Jeśli ma wartość null, wartość domyślna zostanie uznana za przypisaną przez system. |
IdentityDetails |
| objectType | ciąg (wymagany) | |
| policyInfo | Pobiera lub ustawia informacje o zasadach. | PolicyInfo (wymagane) |
| resourceGuardOperationRequests | ResourceGuardOperationRequests, na którym zostanie wykonane sprawdzanie LAC | string[] |
| validationType | Określa typ weryfikacji. W przypadku funkcji DeepValidation wszystkie walidacje z interfejsu API /validateForBackup zostaną uruchomione ponownie. | 'DeepValidation' 'ShallowValidation' |
BackupInstanceResourceTags
| Name | Description | Value |
|---|
BaseResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Ustaw wartość "DefaultResourceProperties" dla typu DefaultResourceProperties. | "DefaultResourceProperties" (wymagane) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla źródła danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType zasobu. | ciąg |
| objectType | Typ obiektu Źródła danych używany do inicjowania prawego dziedziczonego typu | ciąg |
| resourceID | Pełny identyfikator arm zasobu. W przypadku zasobów platformy Azure jest to identyfikator arm. W przypadku zasobów spoza platformy Azure będzie to identyfikator utworzony przez usługę kopii zapasowej za pośrednictwem sieci szkieletowej/magazynu. | ciąg (wymagany) |
| resourceLocation | Lokalizacja źródła danych. | ciąg |
| resourceName | Unikatowy identyfikator zasobu w kontekście elementu nadrzędnego. | ciąg |
| resourceProperties | Właściwości specyficzne dla zestawu źródeł danych | BaseResourceProperties |
| resourceType | Typ zasobu źródła danych. | ciąg |
| resourceUri | Identyfikator URI zasobu. | ciąg |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | typ magazynu danych; Operacyjne/Magazyn/Archiwum | 'ArchiveStore' 'OperationalStore' "VaultStore" (wymagane) |
| objectType | Ustaw wartość "AzureOperationalStoreParameters" dla typu AzureOperationalStoreParameters. | "AzureOperationalStoreParameters" (wymagane) |
DefaultResourceProperties
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "DefaultResourceProperties" (wymagane) |
IdentityDetails
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityArmUrl | Adres URL usługi ARM dla tożsamości przypisanej przez użytkownika. | ciąg |
| useSystemAssignedIdentity | Określa, czy usługa BI jest chroniona przez tożsamość systemową. | bool |
KubernetesClusterBackupDatasourceParameters
| Name | Description | Value |
|---|---|---|
| backupHookReferences | Pobiera lub ustawia odwołania punktów zaczepienia kopii zapasowej. Ta właściwość ustawia odwołanie haka do wykonania podczas tworzenia kopii zapasowej. | NamespacedNameResource[] |
| excludedNamespaces | Pobiera lub ustawia właściwość wykluczania przestrzeni nazw. Ta właściwość ustawia przestrzenie nazw, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| excludedResourceTypes | Pobiera lub ustawia właściwość wyklucz typy zasobów. Ta właściwość ustawia typy zasobów, które mają być wykluczone podczas tworzenia kopii zapasowej. | string[] |
| includeClusterScopeResources | Pobiera lub ustawia właściwość dołączania zasobów klastra. Ta właściwość, jeśli jest włączona, będzie zawierać zasoby zakresu klastra podczas tworzenia kopii zapasowej. | bool (wymagane) |
| includedNamespaces | Pobiera lub ustawia właściwość uwzględnij przestrzenie nazw. Ta właściwość ustawia przestrzenie nazw, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedResourceTypes | Pobiera lub ustawia właściwość dołączania typów zasobów. Ta właściwość ustawia typy zasobów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| includedVolumeTypes | Pobiera lub ustawia właściwość dołączania typów woluminów. Ta właściwość ustawia typy woluminów, które mają być uwzględniane podczas tworzenia kopii zapasowej. | Tablica ciągów zawierająca dowolną z: 'AzureDisk' 'AzureFileShareSMB' |
| labelSelectors | Pobiera lub ustawia właściwość LabelSelectors. Ta właściwość ustawia zasób z takimi selektorami etykiet, które mają być uwzględniane podczas tworzenia kopii zapasowej. | string[] |
| objectType | Typ określonego obiektu — używany do deserializacji | "KubernetesClusterBackupDatasourceParameters" (wymagane) |
| snapshotVolumes | Pobiera lub ustawia właściwość migawki woluminu. Ta właściwość, jeśli jest włączona, spowoduje utworzenie migawek woluminu podczas tworzenia kopii zapasowej. | bool (wymagane) |
NamespacedNameResource
| Name | Description | Value |
|---|---|---|
| name | Nazwa zasobu | ciąg |
| obszar nazw | Przestrzeń nazw, w której istnieje zasób | ciąg |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | ciąg (wymagany) | |
| policyParameters | Parametry zasad dla wystąpienia kopii zapasowej | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| backupDatasourceParametersList | Pobiera lub ustawia parametry źródła danych kopii zapasowej | BackupDatasourceParameters[] |
| dataStoreParametersList | Pobiera lub ustawia parametry magazynu danych | DataStoreParameters[] |
SecretStoreBasedAuthCredentials
| Name | Description | Value |
|---|---|---|
| objectType | Typ określonego obiektu — używany do deserializacji | "SecretStoreBasedAuthCredentials" (wymagane) |
| secretStoreResource | Zasób magazynu wpisów tajnych | SecretStoreResource |
SecretStoreResource
| Name | Description | Value |
|---|---|---|
| secretStoreType | Pobiera lub ustawia typ magazynu wpisów tajnych | 'AzureKeyVault' "Nieprawidłowy" (wymagane) |
| uri | Identyfikator URI umożliwiający uzyskanie dostępu do zasobu | ciąg |
| value | Pobiera lub ustawia wartość przechowywaną w zasobie magazynu wpisów tajnych | ciąg |
Przykłady użycia
Przykłady programu Terraform
Podstawowy przykład wdrożenia instancji kopii zapasowej.
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 = ["*"]
}