We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages a Backup Instance to back up Disk.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var rg = new Azure.Core.ResourceGroup("rg", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleManagedDisk = new Azure.Compute.ManagedDisk("exampleManagedDisk", new Azure.Compute.ManagedDiskArgs
{
Location = rg.Location,
ResourceGroupName = rg.Name,
StorageAccountType = "Standard_LRS",
CreateOption = "Empty",
DiskSizeGb = 1,
});
var exampleBackupVault = new Azure.DataProtection.BackupVault("exampleBackupVault", new Azure.DataProtection.BackupVaultArgs
{
ResourceGroupName = rg.Name,
Location = rg.Location,
DatastoreType = "VaultStore",
Redundancy = "LocallyRedundant",
Identity = new Azure.DataProtection.Inputs.BackupVaultIdentityArgs
{
Type = "SystemAssigned",
},
});
var example1 = new Azure.Authorization.Assignment("example1", new Azure.Authorization.AssignmentArgs
{
Scope = rg.Id,
RoleDefinitionName = "Disk Snapshot Contributor",
PrincipalId = exampleBackupVault.Identity.Apply(identity => identity?.PrincipalId),
});
var example2 = new Azure.Authorization.Assignment("example2", new Azure.Authorization.AssignmentArgs
{
Scope = exampleManagedDisk.Id,
RoleDefinitionName = "Disk Backup Reader",
PrincipalId = exampleBackupVault.Identity.Apply(identity => identity?.PrincipalId),
});
var exampleBackupPolicyDisk = new Azure.DataProtection.BackupPolicyDisk("exampleBackupPolicyDisk", new Azure.DataProtection.BackupPolicyDiskArgs
{
VaultId = exampleBackupVault.Id,
BackupRepeatingTimeIntervals =
{
"R/2021-05-19T06:33:16+00:00/PT4H",
},
DefaultRetentionDuration = "P7D",
});
var exampleBackupInstanceDisk = new Azure.DataProtection.BackupInstanceDisk("exampleBackupInstanceDisk", new Azure.DataProtection.BackupInstanceDiskArgs
{
Location = exampleBackupVault.Location,
VaultId = exampleBackupVault.Id,
DiskId = exampleManagedDisk.Id,
SnapshotResourceGroupName = rg.Name,
BackupPolicyId = exampleBackupPolicyDisk.Id,
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/authorization"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/dataprotection"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
rg, err := core.NewResourceGroup(ctx, "rg", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleManagedDisk, err := compute.NewManagedDisk(ctx, "exampleManagedDisk", &compute.ManagedDiskArgs{
Location: rg.Location,
ResourceGroupName: rg.Name,
StorageAccountType: pulumi.String("Standard_LRS"),
CreateOption: pulumi.String("Empty"),
DiskSizeGb: pulumi.Int(1),
})
if err != nil {
return err
}
exampleBackupVault, err := dataprotection.NewBackupVault(ctx, "exampleBackupVault", &dataprotection.BackupVaultArgs{
ResourceGroupName: rg.Name,
Location: rg.Location,
DatastoreType: pulumi.String("VaultStore"),
Redundancy: pulumi.String("LocallyRedundant"),
Identity: &dataprotection.BackupVaultIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
})
if err != nil {
return err
}
_, err = authorization.NewAssignment(ctx, "example1", &authorization.AssignmentArgs{
Scope: rg.ID(),
RoleDefinitionName: pulumi.String("Disk Snapshot Contributor"),
PrincipalId: exampleBackupVault.Identity.ApplyT(func(identity dataprotection.BackupVaultIdentity) (string, error) {
return identity.PrincipalId, nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
_, err = authorization.NewAssignment(ctx, "example2", &authorization.AssignmentArgs{
Scope: exampleManagedDisk.ID(),
RoleDefinitionName: pulumi.String("Disk Backup Reader"),
PrincipalId: exampleBackupVault.Identity.ApplyT(func(identity dataprotection.BackupVaultIdentity) (string, error) {
return identity.PrincipalId, nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
exampleBackupPolicyDisk, err := dataprotection.NewBackupPolicyDisk(ctx, "exampleBackupPolicyDisk", &dataprotection.BackupPolicyDiskArgs{
VaultId: exampleBackupVault.ID(),
BackupRepeatingTimeIntervals: pulumi.StringArray{
pulumi.String("R/2021-05-19T06:33:16+00:00/PT4H"),
},
DefaultRetentionDuration: pulumi.String("P7D"),
})
if err != nil {
return err
}
_, err = dataprotection.NewBackupInstanceDisk(ctx, "exampleBackupInstanceDisk", &dataprotection.BackupInstanceDiskArgs{
Location: exampleBackupVault.Location,
VaultId: exampleBackupVault.ID(),
DiskId: exampleManagedDisk.ID(),
SnapshotResourceGroupName: rg.Name,
BackupPolicyId: exampleBackupPolicyDisk.ID(),
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const rg = new azure.core.ResourceGroup("rg", {location: "West Europe"});
const exampleManagedDisk = new azure.compute.ManagedDisk("exampleManagedDisk", {
location: rg.location,
resourceGroupName: rg.name,
storageAccountType: "Standard_LRS",
createOption: "Empty",
diskSizeGb: "1",
});
const exampleBackupVault = new azure.dataprotection.BackupVault("exampleBackupVault", {
resourceGroupName: rg.name,
location: rg.location,
datastoreType: "VaultStore",
redundancy: "LocallyRedundant",
identity: {
type: "SystemAssigned",
},
});
const example1 = new azure.authorization.Assignment("example1", {
scope: rg.id,
roleDefinitionName: "Disk Snapshot Contributor",
principalId: exampleBackupVault.identity.apply(identity => identity?.principalId),
});
const example2 = new azure.authorization.Assignment("example2", {
scope: exampleManagedDisk.id,
roleDefinitionName: "Disk Backup Reader",
principalId: exampleBackupVault.identity.apply(identity => identity?.principalId),
});
const exampleBackupPolicyDisk = new azure.dataprotection.BackupPolicyDisk("exampleBackupPolicyDisk", {
vaultId: exampleBackupVault.id,
backupRepeatingTimeIntervals: ["R/2021-05-19T06:33:16+00:00/PT4H"],
defaultRetentionDuration: "P7D",
});
const exampleBackupInstanceDisk = new azure.dataprotection.BackupInstanceDisk("exampleBackupInstanceDisk", {
location: exampleBackupVault.location,
vaultId: exampleBackupVault.id,
diskId: exampleManagedDisk.id,
snapshotResourceGroupName: rg.name,
backupPolicyId: exampleBackupPolicyDisk.id,
});
import pulumi
import pulumi_azure as azure
rg = azure.core.ResourceGroup("rg", location="West Europe")
example_managed_disk = azure.compute.ManagedDisk("exampleManagedDisk",
location=rg.location,
resource_group_name=rg.name,
storage_account_type="Standard_LRS",
create_option="Empty",
disk_size_gb=1)
example_backup_vault = azure.dataprotection.BackupVault("exampleBackupVault",
resource_group_name=rg.name,
location=rg.location,
datastore_type="VaultStore",
redundancy="LocallyRedundant",
identity=azure.dataprotection.BackupVaultIdentityArgs(
type="SystemAssigned",
))
example1 = azure.authorization.Assignment("example1",
scope=rg.id,
role_definition_name="Disk Snapshot Contributor",
principal_id=example_backup_vault.identity.principal_id)
example2 = azure.authorization.Assignment("example2",
scope=example_managed_disk.id,
role_definition_name="Disk Backup Reader",
principal_id=example_backup_vault.identity.principal_id)
example_backup_policy_disk = azure.dataprotection.BackupPolicyDisk("exampleBackupPolicyDisk",
vault_id=example_backup_vault.id,
backup_repeating_time_intervals=["R/2021-05-19T06:33:16+00:00/PT4H"],
default_retention_duration="P7D")
example_backup_instance_disk = azure.dataprotection.BackupInstanceDisk("exampleBackupInstanceDisk",
location=example_backup_vault.location,
vault_id=example_backup_vault.id,
disk_id=example_managed_disk.id,
snapshot_resource_group_name=rg.name,
backup_policy_id=example_backup_policy_disk.id)
Example coming soon!
Create BackupInstanceDisk Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BackupInstanceDisk(name: string, args: BackupInstanceDiskArgs, opts?: CustomResourceOptions);@overload
def BackupInstanceDisk(resource_name: str,
args: BackupInstanceDiskArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BackupInstanceDisk(resource_name: str,
opts: Optional[ResourceOptions] = None,
backup_policy_id: Optional[str] = None,
disk_id: Optional[str] = None,
snapshot_resource_group_name: Optional[str] = None,
vault_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None)func NewBackupInstanceDisk(ctx *Context, name string, args BackupInstanceDiskArgs, opts ...ResourceOption) (*BackupInstanceDisk, error)public BackupInstanceDisk(string name, BackupInstanceDiskArgs args, CustomResourceOptions? opts = null)
public BackupInstanceDisk(String name, BackupInstanceDiskArgs args)
public BackupInstanceDisk(String name, BackupInstanceDiskArgs args, CustomResourceOptions options)
type: azure:dataprotection:BackupInstanceDisk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BackupInstanceDiskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BackupInstanceDiskArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BackupInstanceDiskArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackupInstanceDiskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackupInstanceDiskArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var backupInstanceDiskResource = new Azure.DataProtection.BackupInstanceDisk("backupInstanceDiskResource", new()
{
BackupPolicyId = "string",
DiskId = "string",
SnapshotResourceGroupName = "string",
VaultId = "string",
Location = "string",
Name = "string",
});
example, err := dataprotection.NewBackupInstanceDisk(ctx, "backupInstanceDiskResource", &dataprotection.BackupInstanceDiskArgs{
BackupPolicyId: pulumi.String("string"),
DiskId: pulumi.String("string"),
SnapshotResourceGroupName: pulumi.String("string"),
VaultId: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
})
var backupInstanceDiskResource = new BackupInstanceDisk("backupInstanceDiskResource", BackupInstanceDiskArgs.builder()
.backupPolicyId("string")
.diskId("string")
.snapshotResourceGroupName("string")
.vaultId("string")
.location("string")
.name("string")
.build());
backup_instance_disk_resource = azure.dataprotection.BackupInstanceDisk("backupInstanceDiskResource",
backup_policy_id="string",
disk_id="string",
snapshot_resource_group_name="string",
vault_id="string",
location="string",
name="string")
const backupInstanceDiskResource = new azure.dataprotection.BackupInstanceDisk("backupInstanceDiskResource", {
backupPolicyId: "string",
diskId: "string",
snapshotResourceGroupName: "string",
vaultId: "string",
location: "string",
name: "string",
});
type: azure:dataprotection:BackupInstanceDisk
properties:
backupPolicyId: string
diskId: string
location: string
name: string
snapshotResourceGroupName: string
vaultId: string
BackupInstanceDisk Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BackupInstanceDisk resource accepts the following input properties:
- Backup
Policy stringId - The ID of the Backup Policy.
- Disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- Snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- Vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- Backup
Policy stringId - The ID of the Backup Policy.
- Disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- Snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- Vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy StringId - The ID of the Backup Policy.
- disk
Id String - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource StringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id String - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- location String
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name String
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy stringId - The ID of the Backup Policy.
- disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- backup_
policy_ strid - The ID of the Backup Policy.
- disk_
id str - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot_
resource_ strgroup_ name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault_
id str - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- location str
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name str
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy StringId - The ID of the Backup Policy.
- disk
Id String - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource StringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id String - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- location String
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name String
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackupInstanceDisk resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing BackupInstanceDisk Resource
Get an existing BackupInstanceDisk resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BackupInstanceDiskState, opts?: CustomResourceOptions): BackupInstanceDisk@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backup_policy_id: Optional[str] = None,
disk_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
snapshot_resource_group_name: Optional[str] = None,
vault_id: Optional[str] = None) -> BackupInstanceDiskfunc GetBackupInstanceDisk(ctx *Context, name string, id IDInput, state *BackupInstanceDiskState, opts ...ResourceOption) (*BackupInstanceDisk, error)public static BackupInstanceDisk Get(string name, Input<string> id, BackupInstanceDiskState? state, CustomResourceOptions? opts = null)public static BackupInstanceDisk get(String name, Output<String> id, BackupInstanceDiskState state, CustomResourceOptions options)resources: _: type: azure:dataprotection:BackupInstanceDisk get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Backup
Policy stringId - The ID of the Backup Policy.
- Disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- Location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- Snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- Vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Backup
Policy stringId - The ID of the Backup Policy.
- Disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- Location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- Name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- Snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- Vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy StringId - The ID of the Backup Policy.
- disk
Id String - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- location String
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name String
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource StringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id String - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy stringId - The ID of the Backup Policy.
- disk
Id string - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- location string
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name string
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource stringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id string - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- backup_
policy_ strid - The ID of the Backup Policy.
- disk_
id str - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- location str
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name str
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot_
resource_ strgroup_ name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault_
id str - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- backup
Policy StringId - The ID of the Backup Policy.
- disk
Id String - The ID of the source Disk. Changing this forces a new Backup Instance Disk to be created.
- location String
- The Azure Region where the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
- name String
- The name which should be used for this Backup Instance Disk. Changing this forces a new Backup Instance Disk to be created.
- snapshot
Resource StringGroup Name - The name of the Resource Group where snapshots are stored. Changing this forces a new Backup Instance Disk to be created.
- vault
Id String - The ID of the Backup Vault within which the Backup Instance Disk should exist. Changing this forces a new Backup Instance Disk to be created.
Import
Backup Instance Disks can be imported using the resource id, e.g.
$ pulumi import azure:dataprotection/backupInstanceDisk:BackupInstanceDisk example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataProtection/backupVaults/vault1/backupInstances/backupInstance1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
