1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. dataprotection
  5. BackupVault
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.dataprotection.BackupVault

Manages a Backup Vault.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

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

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = dataprotection.NewBackupVault(ctx, "exampleBackupVault", &dataprotection.BackupVaultArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			DatastoreType:     pulumi.String("VaultStore"),
			Redundancy:        pulumi.String("LocallyRedundant"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_backup_vault = azure.dataprotection.BackupVault("exampleBackupVault",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    datastore_type="VaultStore",
    redundancy="LocallyRedundant")

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleBackupVault = new azure.dataprotection.BackupVault("exampleBackupVault", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    datastoreType: "VaultStore",
    redundancy: "LocallyRedundant",
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleBackupVault:
    type: azure:dataprotection:BackupVault
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      datastoreType: VaultStore
      redundancy: LocallyRedundant

Create BackupVault Resource

new BackupVault(name: string, args: BackupVaultArgs, opts?: CustomResourceOptions);
@overload
def BackupVault(resource_name: 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)
@overload
def BackupVault(resource_name: str,
                args: BackupVaultArgs,
                opts: Optional[ResourceOptions] = 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.
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.

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

The BackupVault resource accepts the following input properties:

DatastoreType string

Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore. Changing this forces a new resource 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.

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 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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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 {[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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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)
Resource lookup is not supported in YAML
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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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. Changing this forces a new resource 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.

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

Type 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 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 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 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 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 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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.