Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. dataprotection
  6. BackupVault

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.dataprotection.BackupVault

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Backup Vault.

    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 example = new Azure.DataProtection.BackupVault("example", new Azure.DataProtection.BackupVaultArgs
        {
            ResourceGroupName = rg.Name,
            Location = rg.Location,
            DatastoreType = "VaultStore",
            Redundancy = "LocallyRedundant",
        });
    }

}

    package main

import (
	"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
		}
		_, err = dataprotection.NewBackupVault(ctx, "example", &dataprotection.BackupVaultArgs{
			ResourceGroupName: rg.Name,
			Location:          rg.Location,
			DatastoreType:     pulumi.String("VaultStore"),
			Redundancy:        pulumi.String("LocallyRedundant"),
		})
		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 example = new azure.dataprotection.BackupVault("example", {
    resourceGroupName: rg.name,
    location: rg.location,
    datastoreType: "VaultStore",
    redundancy: "LocallyRedundant",
});

    import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="West Europe")
example = azure.dataprotection.BackupVault("example",
    resource_group_name=rg.name,
    location=rg.location,
    datastore_type="VaultStore",
    redundancy="LocallyRedundant")

    Example coming soon!

    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,
                identity: Optional[BackupVaultIdentityArgs] = None,
                location: Optional[str] = None,
                name: 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 string
    The unique name of the resource.
    args BackupVaultArgs
    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 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 string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    Identity = new Azure.DataProtection.Inputs.BackupVaultIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := dataprotection.NewBackupVault(ctx, "backupVaultResource", &dataprotection.BackupVaultArgs{
	DatastoreType:     pulumi.String("string"),
	Redundancy:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Identity: &dataprotection.BackupVaultIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var backupVaultResource = new BackupVault("backupVaultResource", BackupVaultArgs.builder()
    .datastoreType("string")
    .redundancy("string")
    .resourceGroupName("string")
    .identity(BackupVaultIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    backup_vault_resource = azure.dataprotection.BackupVault("backupVaultResource",
    datastore_type="string",
    redundancy="string",
    resource_group_name="string",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const backupVaultResource = new azure.dataprotection.BackupVault("backupVaultResource", {
    datastoreType: "string",
    redundancy: "string",
    resourceGroupName: "string",
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:dataprotection:BackupVault
properties:
    datastoreType: string
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    redundancy: string
    resourceGroupName: string
    tags:
        string: string

    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 string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    Redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    ResourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Identity BackupVaultIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Backup Vault.
    DatastoreType string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    Redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    ResourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Identity BackupVaultIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType String
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    redundancy String
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName String
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    identity BackupVaultIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name String
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    identity BackupVaultIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Backup Vault.
    datastore_type str
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    redundancy str
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resource_group_name str
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    identity BackupVaultIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name str
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType String
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    redundancy String
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName String
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name String
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    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,
        datastore_type: Optional[str] = None,
        identity: Optional[BackupVaultIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        redundancy: Optional[str] = None,
        resource_group_name: 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
    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.
    The following state arguments are supported:
    DatastoreType string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    Identity BackupVaultIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    Redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    ResourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Backup Vault.
    DatastoreType string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    Identity BackupVaultIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    Redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    ResourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType String
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    identity BackupVaultIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name String
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    redundancy String
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName String
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType string
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    identity BackupVaultIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name string
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    redundancy string
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName string
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Backup Vault.
    datastore_type str
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    identity BackupVaultIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name str
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    redundancy str
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resource_group_name str
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Backup Vault.
    datastoreType String
    Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.
    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    name String
    Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.
    redundancy String
    Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.
    resourceGroupName String
    The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Backup Vault.

    Supporting Types

    BackupVaultIdentity, BackupVaultIdentityArgs

    Type string
    Specifies the identity type of the Backup Vault. 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 string
    Specifies the identity type of the Backup Vault. 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 String
    Specifies the identity type of the Backup Vault. 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 string
    Specifies the identity type of the Backup Vault. 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 str
    Specifies the identity type of the Backup Vault. 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 String
    Specifies the identity type of the Backup Vault. 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

    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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial