Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. dataprotection
  5. BackupVault

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.dataprotection.BackupVault

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Backup Vault.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleBackupVault = new azure.dataprotection.BackupVault("example", {
    name: "example-backup-vault",
    resourceGroupName: example.name,
    location: example.location,
    datastoreType: "VaultStore",
    redundancy: "LocallyRedundant",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_backup_vault = azure.dataprotection.BackupVault("example",
    name="example-backup-vault",
    resource_group_name=example.name,
    location=example.location,
    datastore_type="VaultStore",
    redundancy="LocallyRedundant")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/dataprotection"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = dataprotection.NewBackupVault(ctx, "example", &dataprotection.BackupVaultArgs{
			Name:              pulumi.String("example-backup-vault"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			DatastoreType:     pulumi.String("VaultStore"),
			Redundancy:        pulumi.String("LocallyRedundant"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleBackupVault = new Azure.DataProtection.BackupVault("example", new()
    {
        Name = "example-backup-vault",
        ResourceGroupName = example.Name,
        Location = example.Location,
        DatastoreType = "VaultStore",
        Redundancy = "LocallyRedundant",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.dataprotection.BackupVault;
import com.pulumi.azure.dataprotection.BackupVaultArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleBackupVault = new BackupVault("exampleBackupVault", BackupVaultArgs.builder()
            .name("example-backup-vault")
            .resourceGroupName(example.name())
            .location(example.location())
            .datastoreType("VaultStore")
            .redundancy("LocallyRedundant")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleBackupVault:
    type: azure:dataprotection:BackupVault
    name: example
    properties:
      name: example-backup-vault
      resourceGroupName: ${example.name}
      location: ${example.location}
      datastoreType: VaultStore
      redundancy: LocallyRedundant
Copy

Create BackupVault Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BackupVault(name: string, args: BackupVaultArgs, opts?: CustomResourceOptions);
@overload
def BackupVault(resource_name: str,
                args: BackupVaultArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def BackupVault(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                datastore_type: Optional[str] = None,
                redundancy: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                cross_region_restore_enabled: Optional[bool] = None,
                identity: Optional[BackupVaultIdentityArgs] = None,
                immutability: Optional[str] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                retention_duration_in_days: Optional[float] = None,
                soft_delete: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
func NewBackupVault(ctx *Context, name string, args BackupVaultArgs, opts ...ResourceOption) (*BackupVault, error)
public BackupVault(string name, BackupVaultArgs args, CustomResourceOptions? opts = null)
public BackupVault(String name, BackupVaultArgs args)
public BackupVault(String name, BackupVaultArgs args, CustomResourceOptions options)

type: azure:dataprotection:BackupVault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupVaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackupVaultArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackupVaultArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupVaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupVaultArgs
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 backupVaultResource = new Azure.DataProtection.BackupVault("backupVaultResource", new()
{
    DatastoreType = "string",
    Redundancy = "string",
    ResourceGroupName = "string",
    CrossRegionRestoreEnabled = false,
    Identity = new Azure.DataProtection.Inputs.BackupVaultIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    Immutability = "string",
    Location = "string",
    Name = "string",
    RetentionDurationInDays = 0,
    SoftDelete = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := dataprotection.NewBackupVault(ctx, "backupVaultResource", &dataprotection.BackupVaultArgs{
	DatastoreType:             pulumi.String("string"),
	Redundancy:                pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	CrossRegionRestoreEnabled: pulumi.Bool(false),
	Identity: &dataprotection.BackupVaultIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Immutability:            pulumi.String("string"),
	Location:                pulumi.String("string"),
	Name:                    pulumi.String("string"),
	RetentionDurationInDays: pulumi.Float64(0),
	SoftDelete:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var backupVaultResource = new BackupVault("backupVaultResource", BackupVaultArgs.builder()
    .datastoreType("string")
    .redundancy("string")
    .resourceGroupName("string")
    .crossRegionRestoreEnabled(false)
    .identity(BackupVaultIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .immutability("string")
    .location("string")
    .name("string")
    .retentionDurationInDays(0)
    .softDelete("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
backup_vault_resource = azure.dataprotection.BackupVault("backupVaultResource",
    datastore_type="string",
    redundancy="string",
    resource_group_name="string",
    cross_region_restore_enabled=False,
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    immutability="string",
    location="string",
    name="string",
    retention_duration_in_days=0,
    soft_delete="string",
    tags={
        "string": "string",
    })
Copy
const backupVaultResource = new azure.dataprotection.BackupVault("backupVaultResource", {
    datastoreType: "string",
    redundancy: "string",
    resourceGroupName: "string",
    crossRegionRestoreEnabled: false,
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    immutability: "string",
    location: "string",
    name: "string",
    retentionDurationInDays: 0,
    softDelete: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:dataprotection:BackupVault
properties:
    crossRegionRestoreEnabled: false
    datastoreType: string
    identity:
        principalId: string
        tenantId: string
        type: string
    immutability: string
    location: string
    name: string
    redundancy: string
    resourceGroupName: string
    retentionDurationInDays: 0
    softDelete: string
    tags:
        string: string
Copy

BackupVault 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 BackupVault resource accepts the following input properties:

DatastoreType
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

Redundancy
This property is required.
Changes to this property will trigger replacement.
string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
CrossRegionRestoreEnabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

Identity BackupVaultIdentity
An identity block as defined below.
Immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
RetentionDurationInDays double

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

SoftDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Backup Vault.
DatastoreType
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

Redundancy
This property is required.
Changes to this property will trigger replacement.
string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
CrossRegionRestoreEnabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

Identity BackupVaultIdentityArgs
An identity block as defined below.
Immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
RetentionDurationInDays float64

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

SoftDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

Tags map[string]string
A mapping of tags which should be assigned to the Backup Vault.
datastoreType
This property is required.
Changes to this property will trigger replacement.
String

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

redundancy
This property is required.
Changes to this property will trigger replacement.
String
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
crossRegionRestoreEnabled Boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

identity BackupVaultIdentity
An identity block as defined below.
immutability String
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
retentionDurationInDays Double

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete String

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Map<String,String>
A mapping of tags which should be assigned to the Backup Vault.
datastoreType
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

redundancy
This property is required.
Changes to this property will trigger replacement.
string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
crossRegionRestoreEnabled boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

identity BackupVaultIdentity
An identity block as defined below.
immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
retentionDurationInDays number

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags {[key: string]: string}
A mapping of tags which should be assigned to the Backup Vault.
datastore_type
This property is required.
Changes to this property will trigger replacement.
str

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

redundancy
This property is required.
Changes to this property will trigger replacement.
str
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
cross_region_restore_enabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

identity BackupVaultIdentityArgs
An identity block as defined below.
immutability str
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
retention_duration_in_days float

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

soft_delete str

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Mapping[str, str]
A mapping of tags which should be assigned to the Backup Vault.
datastoreType
This property is required.
Changes to this property will trigger replacement.
String

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

redundancy
This property is required.
Changes to this property will trigger replacement.
String
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
crossRegionRestoreEnabled Boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

identity Property Map
An identity block as defined below.
immutability String
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
retentionDurationInDays Number

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete String

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Map<String>
A mapping of tags which should be assigned to the Backup Vault.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackupVault 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 BackupVault Resource

Get an existing BackupVault 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?: BackupVaultState, opts?: CustomResourceOptions): BackupVault
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cross_region_restore_enabled: Optional[bool] = None,
        datastore_type: Optional[str] = None,
        identity: Optional[BackupVaultIdentityArgs] = None,
        immutability: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        redundancy: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        retention_duration_in_days: Optional[float] = None,
        soft_delete: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> BackupVault
func GetBackupVault(ctx *Context, name string, id IDInput, state *BackupVaultState, opts ...ResourceOption) (*BackupVault, error)
public static BackupVault Get(string name, Input<string> id, BackupVaultState? state, CustomResourceOptions? opts = null)
public static BackupVault get(String name, Output<String> id, BackupVaultState state, CustomResourceOptions options)
resources:  _:    type: azure:dataprotection:BackupVault    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
CrossRegionRestoreEnabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

DatastoreType Changes to this property will trigger replacement. string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

Identity BackupVaultIdentity
An identity block as defined below.
Immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
Redundancy Changes to this property will trigger replacement. string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
RetentionDurationInDays double

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

SoftDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Backup Vault.
CrossRegionRestoreEnabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

DatastoreType Changes to this property will trigger replacement. string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

Identity BackupVaultIdentityArgs
An identity block as defined below.
Immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
Redundancy Changes to this property will trigger replacement. string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
RetentionDurationInDays float64

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

SoftDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

Tags map[string]string
A mapping of tags which should be assigned to the Backup Vault.
crossRegionRestoreEnabled Boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

datastoreType Changes to this property will trigger replacement. String

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

identity BackupVaultIdentity
An identity block as defined below.
immutability String
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
redundancy Changes to this property will trigger replacement. String
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
retentionDurationInDays Double

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete String

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Map<String,String>
A mapping of tags which should be assigned to the Backup Vault.
crossRegionRestoreEnabled boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

datastoreType Changes to this property will trigger replacement. string

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

identity BackupVaultIdentity
An identity block as defined below.
immutability string
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
redundancy Changes to this property will trigger replacement. string
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
retentionDurationInDays number

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete string

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags {[key: string]: string}
A mapping of tags which should be assigned to the Backup Vault.
cross_region_restore_enabled bool

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

datastore_type Changes to this property will trigger replacement. str

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

identity BackupVaultIdentityArgs
An identity block as defined below.
immutability str
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
redundancy Changes to this property will trigger replacement. str
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
retention_duration_in_days float

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

soft_delete str

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Mapping[str, str]
A mapping of tags which should be assigned to the Backup Vault.
crossRegionRestoreEnabled Boolean

Whether to enable cross-region restore for the Backup Vault.

Note: The cross_region_restore_enabled can only be specified when redundancy is specified for GeoRedundant. Once cross_region_restore_enabled is enabled, it cannot be disabled.

datastoreType Changes to this property will trigger replacement. String

Specifies the type of the data store. Possible values are ArchiveStore, OperationalStore, SnapshotStore and VaultStore. Changing this forces a new resource to be created.

Note: The SnapshotStore will be removed in version 4.0 as it has been replaced by OperationalStore.

identity Property Map
An identity block as defined below.
immutability String
The state of immutability for this Backup Vault. Possible values are Disabled, Locked, and Unlocked. Defaults to Disabled. Changing this from Locked to anything else forces a new Backup Vault to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
redundancy Changes to this property will trigger replacement. String
Specifies the backup storage redundancy. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Changing this forces a new Backup Vault to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
retentionDurationInDays Number

The soft delete retention duration for this Backup Vault. Possible values are between 14 and 180. Defaults to 14.

Note: The retention_duration_in_days is the number of days for which deleted data is retained before being permanently deleted. Retention period till 14 days are free of cost, however, retention beyond 14 days may incur additional charges. The retention_duration_in_days is required when the soft_delete is set to On.

softDelete String

The state of soft delete for this Backup Vault. Possible values are AlwaysOn, Off, and On. Defaults to On.

Note: Once the soft_delete is set to AlwaysOn, the setting cannot be changed.

tags Map<String>
A mapping of tags which should be assigned to the Backup Vault.

Supporting Types

BackupVaultIdentity
, BackupVaultIdentityArgs

Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
PrincipalId string
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
TenantId string
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.
Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
PrincipalId string
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
TenantId string
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
principalId String
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
tenantId String
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.
type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
principalId string
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
tenantId string
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.
type This property is required. str
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
principal_id str
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
tenant_id str
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on this Backup Vault. The only possible value is SystemAssigned.
principalId String
The Principal ID for the Service Principal associated with the Identity of this Backup Vault.
tenantId String
The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.

Import

Backup Vaults can be imported using the resource id, e.g.

$ pulumi import azure:dataprotection/backupVault:BackupVault example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataProtection/backupVaults/vault1
Copy

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 azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure