Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
- Latest
- 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
Bicep resource definition
The backupVaults/backupInstances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataProtection/backupVaults/backupInstances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataProtection/backupVaults/backupInstances@2021-02-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
dataSourceInfo: {
datasourceType: 'string'
objectType: 'string'
resourceID: 'string'
resourceLocation: 'string'
resourceName: 'string'
resourceType: 'string'
resourceUri: 'string'
}
dataSourceSetInfo: {
datasourceType: 'string'
objectType: 'string'
resourceID: 'string'
resourceLocation: 'string'
resourceName: 'string'
resourceType: 'string'
resourceUri: 'string'
}
friendlyName: 'string'
objectType: 'string'
policyInfo: {
policyId: 'string'
policyParameters: {
dataStoreParametersList: [
{
dataStoreType: 'string'
objectType: 'string'
// For remaining properties, see DataStoreParameters objects
}
]
}
}
}
}
DataStoreParameters objects
Set the objectType property to specify the type of object.
For AzureOperationalStoreParameters, use:
{
objectType: 'AzureOperationalStoreParameters'
resourceGroupId: 'string'
}
Property Values
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | 'AzureOperationalStoreParameters' (required) |
| resourceGroupId | Gets or sets the Snapshot Resource Group Uri. | string |
BackupInstance
| Name | Description | Value |
|---|---|---|
| dataSourceInfo | Gets or sets the data source information. | Datasource (required) |
| dataSourceSetInfo | Gets or sets the data source set information. | DatasourceSet |
| friendlyName | Gets or sets the Backup Instance friendly name. | string |
| objectType | string (required) | |
| policyInfo | Gets or sets the policy information. | PolicyInfo (required) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | 'ArchiveStore' 'OperationalStore' 'VaultStore' (required) |
| objectType | Set to 'AzureOperationalStoreParameters' for type AzureOperationalStoreParameters. | 'AzureOperationalStoreParameters' (required) |
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: backupVaults |
| properties | BackupInstanceResource properties | BackupInstance |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | string (required) | |
| policyParameters | Policy parameters for the backup instance | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| dataStoreParametersList | Gets or sets the DataStore Parameters | DataStoreParameters[] |
Kullanım Örnekleri
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create Disk & enable protection via Backup Vault | Template that creates a disk and enables protection via Backup Vault |
| Create MySqlFlex server & enable protection via Backup Vault | Template that creates a MySQL Flexible Server and enables protection via Backup Vault |
| Create PgFlex server & enable protection via Backup Vault | Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault |
| Create Storage Account & enable protection via Backup Vault | Template that creates storage account and enable operational and vaulted backup via Backup Vault |
ARM template resource definition
The backupVaults/backupInstances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataProtection/backupVaults/backupInstances resource, add the following JSON to your template.
{
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"apiVersion": "2021-02-01-preview",
"name": "string",
"properties": {
"dataSourceInfo": {
"datasourceType": "string",
"objectType": "string",
"resourceID": "string",
"resourceLocation": "string",
"resourceName": "string",
"resourceType": "string",
"resourceUri": "string"
},
"dataSourceSetInfo": {
"datasourceType": "string",
"objectType": "string",
"resourceID": "string",
"resourceLocation": "string",
"resourceName": "string",
"resourceType": "string",
"resourceUri": "string"
},
"friendlyName": "string",
"objectType": "string",
"policyInfo": {
"policyId": "string",
"policyParameters": {
"dataStoreParametersList": [ {
"dataStoreType": "string",
"objectType": "string"
// For remaining properties, see DataStoreParameters objects
} ]
}
}
}
}
DataStoreParameters objects
Set the objectType property to specify the type of object.
For AzureOperationalStoreParameters, use:
{
"objectType": "AzureOperationalStoreParameters",
"resourceGroupId": "string"
}
Property Values
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | 'AzureOperationalStoreParameters' (required) |
| resourceGroupId | Gets or sets the Snapshot Resource Group Uri. | string |
BackupInstance
| Name | Description | Value |
|---|---|---|
| dataSourceInfo | Gets or sets the data source information. | Datasource (required) |
| dataSourceSetInfo | Gets or sets the data source set information. | DatasourceSet |
| friendlyName | Gets or sets the Backup Instance friendly name. | string |
| objectType | string (required) | |
| policyInfo | Gets or sets the policy information. | PolicyInfo (required) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | 'ArchiveStore' 'OperationalStore' 'VaultStore' (required) |
| objectType | Set to 'AzureOperationalStoreParameters' for type AzureOperationalStoreParameters. | 'AzureOperationalStoreParameters' (required) |
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-02-01-preview' |
| name | The resource name | string (required) |
| properties | BackupInstanceResource properties | BackupInstance |
| type | The resource type | 'Microsoft.DataProtection/backupVaults/backupInstances' |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | string (required) | |
| policyParameters | Policy parameters for the backup instance | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| dataStoreParametersList | Gets or sets the DataStore Parameters | DataStoreParameters[] |
Kullanım Örnekleri
Azure Hızlı Başlangıç Şablonları
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create Disk & enable protection via Backup Vault
|
Template that creates a disk and enables protection via Backup Vault |
|
Create MySqlFlex server & enable protection via Backup Vault
|
Template that creates a MySQL Flexible Server and enables protection via Backup Vault |
|
Create PgFlex server & enable protection via Backup Vault
|
Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault |
|
Create Storage Account & enable protection via Backup Vault
|
Template that creates storage account and enable operational and vaulted backup via Backup Vault |
Terraform (AzAPI provider) resource definition
The backupVaults/backupInstances resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataProtection/backupVaults/backupInstances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataProtection/backupVaults/backupInstances@2021-02-01-preview"
name = "string"
body = {
properties = {
dataSourceInfo = {
datasourceType = "string"
objectType = "string"
resourceID = "string"
resourceLocation = "string"
resourceName = "string"
resourceType = "string"
resourceUri = "string"
}
dataSourceSetInfo = {
datasourceType = "string"
objectType = "string"
resourceID = "string"
resourceLocation = "string"
resourceName = "string"
resourceType = "string"
resourceUri = "string"
}
friendlyName = "string"
objectType = "string"
policyInfo = {
policyId = "string"
policyParameters = {
dataStoreParametersList = [
{
dataStoreType = "string"
objectType = "string"
// For remaining properties, see DataStoreParameters objects
}
]
}
}
}
}
}
DataStoreParameters objects
Set the objectType property to specify the type of object.
For AzureOperationalStoreParameters, use:
{
objectType = "AzureOperationalStoreParameters"
resourceGroupId = "string"
}
Property Values
AzureOperationalStoreParameters
| Name | Description | Value |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | 'AzureOperationalStoreParameters' (required) |
| resourceGroupId | Gets or sets the Snapshot Resource Group Uri. | string |
BackupInstance
| Name | Description | Value |
|---|---|---|
| dataSourceInfo | Gets or sets the data source information. | Datasource (required) |
| dataSourceSetInfo | Gets or sets the data source set information. | DatasourceSet |
| friendlyName | Gets or sets the Backup Instance friendly name. | string |
| objectType | string (required) | |
| policyInfo | Gets or sets the policy information. | PolicyInfo (required) |
Datasource
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DatasourceSet
| Name | Description | Value |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string |
| objectType | Type of Datasource object, used to initialize the right inherited type | string |
| resourceID | Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. | string (required) |
| resourceLocation | Location of datasource. | string |
| resourceName | Unique identifier of the resource in the context of parent. | string |
| resourceType | Resource Type of Datasource. | string |
| resourceUri | Uri of the resource. | string |
DataStoreParameters
| Name | Description | Value |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | 'ArchiveStore' 'OperationalStore' 'VaultStore' (required) |
| objectType | Set to 'AzureOperationalStoreParameters' for type AzureOperationalStoreParameters. | 'AzureOperationalStoreParameters' (required) |
Microsoft.DataProtection/backupVaults/backupInstances
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: backupVaults |
| properties | BackupInstanceResource properties | BackupInstance |
| type | The resource type | "Microsoft.DataProtection/backupVaults/backupInstances@2021-02-01-preview" |
PolicyInfo
| Name | Description | Value |
|---|---|---|
| policyId | string (required) | |
| policyParameters | Policy parameters for the backup instance | PolicyParameters |
PolicyParameters
| Name | Description | Value |
|---|---|---|
| dataStoreParametersList | Gets or sets the DataStore Parameters | DataStoreParameters[] |