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

We recommend using Azure Native.

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

azure.recoveryservices.Vault

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

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

    Manages a Recovery Services Vault.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "tfex-recovery_vault",
    location: "West Europe",
});
const vault = new azure.recoveryservices.Vault("vault", {
    name: "example-recovery-vault",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Standard",
    softDeleteEnabled: true,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="tfex-recovery_vault",
    location="West Europe")
vault = azure.recoveryservices.Vault("vault",
    name="example-recovery-vault",
    location=example.location,
    resource_group_name=example.name,
    sku="Standard",
    soft_delete_enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/recoveryservices"
	"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("tfex-recovery_vault"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = recoveryservices.NewVault(ctx, "vault", &recoveryservices.VaultArgs{
			Name:              pulumi.String("example-recovery-vault"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Standard"),
			SoftDeleteEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 = "tfex-recovery_vault",
        Location = "West Europe",
    });

    var vault = new Azure.RecoveryServices.Vault("vault", new()
    {
        Name = "example-recovery-vault",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Standard",
        SoftDeleteEnabled = true,
    });

});

    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.recoveryservices.Vault;
import com.pulumi.azure.recoveryservices.VaultArgs;
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("tfex-recovery_vault")
            .location("West Europe")
            .build());

        var vault = new Vault("vault", VaultArgs.builder()
            .name("example-recovery-vault")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Standard")
            .softDeleteEnabled(true)
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: tfex-recovery_vault
      location: West Europe
  vault:
    type: azure:recoveryservices:Vault
    properties:
      name: example-recovery-vault
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Standard
      softDeleteEnabled: true

    Create Vault Resource

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

    Constructor syntax

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

@overload
def Vault(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          resource_group_name: Optional[str] = None,
          sku: Optional[str] = None,
          identity: Optional[VaultIdentityArgs] = None,
          classic_vmware_replication_enabled: Optional[bool] = None,
          immutability: Optional[str] = None,
          location: Optional[str] = None,
          monitoring: Optional[VaultMonitoringArgs] = None,
          name: Optional[str] = None,
          public_network_access_enabled: Optional[bool] = None,
          encryption: Optional[VaultEncryptionArgs] = None,
          cross_region_restore_enabled: Optional[bool] = None,
          soft_delete_enabled: Optional[bool] = None,
          storage_mode_type: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewVault(ctx *Context, name string, args VaultArgs, opts ...ResourceOption) (*Vault, error)
    public Vault(string name, VaultArgs args, CustomResourceOptions? opts = null)
    public Vault(String name, VaultArgs args)
public Vault(String name, VaultArgs args, CustomResourceOptions options)

    type: azure:recoveryservices:Vault
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 VaultArgs
    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 VaultArgs
    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 VaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VaultArgs
    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 vaultResource = new Azure.RecoveryServices.Vault("vaultResource", new()
{
    ResourceGroupName = "string",
    Sku = "string",
    Identity = new Azure.RecoveryServices.Inputs.VaultIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    ClassicVmwareReplicationEnabled = false,
    Immutability = "string",
    Location = "string",
    Monitoring = new Azure.RecoveryServices.Inputs.VaultMonitoringArgs
    {
        AlertsForAllJobFailuresEnabled = false,
        AlertsForCriticalOperationFailuresEnabled = false,
    },
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Encryption = new Azure.RecoveryServices.Inputs.VaultEncryptionArgs
    {
        InfrastructureEncryptionEnabled = false,
        KeyId = "string",
        UseSystemAssignedIdentity = false,
        UserAssignedIdentityId = "string",
    },
    CrossRegionRestoreEnabled = false,
    SoftDeleteEnabled = false,
    StorageModeType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := recoveryservices.NewVault(ctx, "vaultResource", &recoveryservices.VaultArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku:               pulumi.String("string"),
	Identity: &recoveryservices.VaultIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	ClassicVmwareReplicationEnabled: pulumi.Bool(false),
	Immutability:                    pulumi.String("string"),
	Location:                        pulumi.String("string"),
	Monitoring: &recoveryservices.VaultMonitoringArgs{
		AlertsForAllJobFailuresEnabled:            pulumi.Bool(false),
		AlertsForCriticalOperationFailuresEnabled: pulumi.Bool(false),
	},
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Encryption: &recoveryservices.VaultEncryptionArgs{
		InfrastructureEncryptionEnabled: pulumi.Bool(false),
		KeyId:                           pulumi.String("string"),
		UseSystemAssignedIdentity:       pulumi.Bool(false),
		UserAssignedIdentityId:          pulumi.String("string"),
	},
	CrossRegionRestoreEnabled: pulumi.Bool(false),
	SoftDeleteEnabled:         pulumi.Bool(false),
	StorageModeType:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var vaultResource = new Vault("vaultResource", VaultArgs.builder()
    .resourceGroupName("string")
    .sku("string")
    .identity(VaultIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .classicVmwareReplicationEnabled(false)
    .immutability("string")
    .location("string")
    .monitoring(VaultMonitoringArgs.builder()
        .alertsForAllJobFailuresEnabled(false)
        .alertsForCriticalOperationFailuresEnabled(false)
        .build())
    .name("string")
    .publicNetworkAccessEnabled(false)
    .encryption(VaultEncryptionArgs.builder()
        .infrastructureEncryptionEnabled(false)
        .keyId("string")
        .useSystemAssignedIdentity(false)
        .userAssignedIdentityId("string")
        .build())
    .crossRegionRestoreEnabled(false)
    .softDeleteEnabled(false)
    .storageModeType("string")
    .tags(Map.of("string", "string"))
    .build());

    vault_resource = azure.recoveryservices.Vault("vaultResource",
    resource_group_name="string",
    sku="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    classic_vmware_replication_enabled=False,
    immutability="string",
    location="string",
    monitoring={
        "alerts_for_all_job_failures_enabled": False,
        "alerts_for_critical_operation_failures_enabled": False,
    },
    name="string",
    public_network_access_enabled=False,
    encryption={
        "infrastructure_encryption_enabled": False,
        "key_id": "string",
        "use_system_assigned_identity": False,
        "user_assigned_identity_id": "string",
    },
    cross_region_restore_enabled=False,
    soft_delete_enabled=False,
    storage_mode_type="string",
    tags={
        "string": "string",
    })

    const vaultResource = new azure.recoveryservices.Vault("vaultResource", {
    resourceGroupName: "string",
    sku: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    classicVmwareReplicationEnabled: false,
    immutability: "string",
    location: "string",
    monitoring: {
        alertsForAllJobFailuresEnabled: false,
        alertsForCriticalOperationFailuresEnabled: false,
    },
    name: "string",
    publicNetworkAccessEnabled: false,
    encryption: {
        infrastructureEncryptionEnabled: false,
        keyId: "string",
        useSystemAssignedIdentity: false,
        userAssignedIdentityId: "string",
    },
    crossRegionRestoreEnabled: false,
    softDeleteEnabled: false,
    storageModeType: "string",
    tags: {
        string: "string",
    },
});

    type: azure:recoveryservices:Vault
properties:
    classicVmwareReplicationEnabled: false
    crossRegionRestoreEnabled: false
    encryption:
        infrastructureEncryptionEnabled: false
        keyId: string
        useSystemAssignedIdentity: false
        userAssignedIdentityId: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    immutability: string
    location: string
    monitoring:
        alertsForAllJobFailuresEnabled: false
        alertsForCriticalOperationFailuresEnabled: false
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    sku: string
    softDeleteEnabled: false
    storageModeType: string
    tags:
        string: string

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

    ResourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    Sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    ClassicVmwareReplicationEnabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    CrossRegionRestoreEnabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    Encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    Identity VaultIdentity
    An identity block as defined below.
    Immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Monitoring VaultMonitoring
    A monitoring block as defined below.
    Name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    SoftDeleteEnabled bool
    Is soft delete enable for this Vault? Defaults to true.
    StorageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    Sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    ClassicVmwareReplicationEnabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    CrossRegionRestoreEnabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    Encryption VaultEncryptionArgs

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    Identity VaultIdentityArgs
    An identity block as defined below.
    Immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Monitoring VaultMonitoringArgs
    A monitoring block as defined below.
    Name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    SoftDeleteEnabled bool
    Is soft delete enable for this Vault? Defaults to true.
    StorageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku String
    Sets the vault's SKU. Possible values include: Standard, RS0.
    classicVmwareReplicationEnabled Boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled Boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentity
    An identity block as defined below.
    immutability String

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoring
    A monitoring block as defined below.
    name String
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    softDeleteEnabled Boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType String
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    classicVmwareReplicationEnabled boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentity
    An identity block as defined below.
    immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoring
    A monitoring block as defined below.
    name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    softDeleteEnabled boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku str
    Sets the vault's SKU. Possible values include: Standard, RS0.
    classic_vmware_replication_enabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    cross_region_restore_enabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryptionArgs

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentityArgs
    An identity block as defined below.
    immutability str

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoringArgs
    A monitoring block as defined below.
    name str
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    soft_delete_enabled bool
    Is soft delete enable for this Vault? Defaults to true.
    storage_mode_type str
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku String
    Sets the vault's SKU. Possible values include: Standard, RS0.
    classicVmwareReplicationEnabled Boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled Boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption Property Map

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity Property Map
    An identity block as defined below.
    immutability String

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring Property Map
    A monitoring block as defined below.
    name String
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    softDeleteEnabled Boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType String
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Get an existing Vault 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?: VaultState, opts?: CustomResourceOptions): Vault
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        classic_vmware_replication_enabled: Optional[bool] = None,
        cross_region_restore_enabled: Optional[bool] = None,
        encryption: Optional[VaultEncryptionArgs] = None,
        identity: Optional[VaultIdentityArgs] = None,
        immutability: Optional[str] = None,
        location: Optional[str] = None,
        monitoring: Optional[VaultMonitoringArgs] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        sku: Optional[str] = None,
        soft_delete_enabled: Optional[bool] = None,
        storage_mode_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Vault
    func GetVault(ctx *Context, name string, id IDInput, state *VaultState, opts ...ResourceOption) (*Vault, error)
    public static Vault Get(string name, Input<string> id, VaultState? state, CustomResourceOptions? opts = null)
    public static Vault get(String name, Output<String> id, VaultState state, CustomResourceOptions options)
    resources:  _:    type: azure:recoveryservices:Vault    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:
    ClassicVmwareReplicationEnabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    CrossRegionRestoreEnabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    Encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    Identity VaultIdentity
    An identity block as defined below.
    Immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Monitoring VaultMonitoring
    A monitoring block as defined below.
    Name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    ResourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    Sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    SoftDeleteEnabled bool
    Is soft delete enable for this Vault? Defaults to true.
    StorageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ClassicVmwareReplicationEnabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    CrossRegionRestoreEnabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    Encryption VaultEncryptionArgs

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    Identity VaultIdentityArgs
    An identity block as defined below.
    Immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Monitoring VaultMonitoringArgs
    A monitoring block as defined below.
    Name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    ResourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    Sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    SoftDeleteEnabled bool
    Is soft delete enable for this Vault? Defaults to true.
    StorageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    classicVmwareReplicationEnabled Boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled Boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentity
    An identity block as defined below.
    immutability String

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoring
    A monitoring block as defined below.
    name String
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    resourceGroupName String
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku String
    Sets the vault's SKU. Possible values include: Standard, RS0.
    softDeleteEnabled Boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType String
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    classicVmwareReplicationEnabled boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryption

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentity
    An identity block as defined below.
    immutability string

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoring
    A monitoring block as defined below.
    name string
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    resourceGroupName string
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku string
    Sets the vault's SKU. Possible values include: Standard, RS0.
    softDeleteEnabled boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType string
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    classic_vmware_replication_enabled bool
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    cross_region_restore_enabled bool

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption VaultEncryptionArgs

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity VaultIdentityArgs
    An identity block as defined below.
    immutability str

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring VaultMonitoringArgs
    A monitoring block as defined below.
    name str
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Is it enabled to access the vault from public networks. Defaults to true.
    resource_group_name str
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku str
    Sets the vault's SKU. Possible values include: Standard, RS0.
    soft_delete_enabled bool
    Is soft delete enable for this Vault? Defaults to true.
    storage_mode_type str
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    classicVmwareReplicationEnabled Boolean
    Whether to enable the Classic experience for VMware replication. If set to false VMware machines will be protected using the new stateless ASR replication appliance. Changing this forces a new resource to be created.
    crossRegionRestoreEnabled Boolean

    Is cross region restore enabled for this Vault? Only can be true, when storage_mode_type is GeoRedundant. Defaults to false.

    Note: Once cross_region_restore_enabled is set to true, changing it back to false forces a new Recovery Service Vault to be created.

    encryption Property Map

    An encryption block as defined below. Required with identity.

    !> Note: Once Encryption with your own key has been Enabled it's not possible to Disable it.

    identity Property Map
    An identity block as defined below.
    immutability String

    Immutability Settings of vault, possible values include: Locked, Unlocked and Disabled.

    Note: Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    monitoring Property Map
    A monitoring block as defined below.
    name String
    Specifies the name of the Recovery Services Vault. Recovery Service Vault name must be 2 - 50 characters long, start with a letter, contain only letters, numbers and hyphens. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is it enabled to access the vault from public networks. Defaults to true.
    resourceGroupName String
    The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
    sku String
    Sets the vault's SKU. Possible values include: Standard, RS0.
    softDeleteEnabled Boolean
    Is soft delete enable for this Vault? Defaults to true.
    storageModeType String
    The storage type of the Recovery Services Vault. Possible values are GeoRedundant, LocallyRedundant and ZoneRedundant. Defaults to GeoRedundant.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Supporting Types

    VaultEncryption, VaultEncryptionArgs

    InfrastructureEncryptionEnabled bool
    Enabling/Disabling the Double Encryption state.
    KeyId string
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    UseSystemAssignedIdentity bool

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    UserAssignedIdentityId string
    Specifies the user assigned identity ID to be used.
    InfrastructureEncryptionEnabled bool
    Enabling/Disabling the Double Encryption state.
    KeyId string
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    UseSystemAssignedIdentity bool

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    UserAssignedIdentityId string
    Specifies the user assigned identity ID to be used.
    infrastructureEncryptionEnabled Boolean
    Enabling/Disabling the Double Encryption state.
    keyId String
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    useSystemAssignedIdentity Boolean

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    userAssignedIdentityId String
    Specifies the user assigned identity ID to be used.
    infrastructureEncryptionEnabled boolean
    Enabling/Disabling the Double Encryption state.
    keyId string
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    useSystemAssignedIdentity boolean

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    userAssignedIdentityId string
    Specifies the user assigned identity ID to be used.
    infrastructure_encryption_enabled bool
    Enabling/Disabling the Double Encryption state.
    key_id str
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    use_system_assigned_identity bool

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    user_assigned_identity_id str
    Specifies the user assigned identity ID to be used.
    infrastructureEncryptionEnabled Boolean
    Enabling/Disabling the Double Encryption state.
    keyId String
    The Key Vault key id used to encrypt this vault. Key managed by Vault Managed Hardware Security Module is also supported.
    useSystemAssignedIdentity Boolean

    Indicate that system assigned identity should be used or not. Defaults to true. Must be set to false when user_assigned_identity_id is set.

    !> Note: use_system_assigned_identity only be able to set to false for new vaults. Any vaults containing existing items registered or attempted to be registered to it are not supported. Details can be found in the document

    !> Note: Once infrastructure_encryption_enabled has been set it's not possible to change it.

    userAssignedIdentityId String
    Specifies the user assigned identity ID to be used.

    VaultIdentity, VaultIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds []string

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds string[]

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identity_ids Sequence[str]

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Recovery Services Vault. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this App Configuration.

    NOTE: identity_ids is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    VaultMonitoring, VaultMonitoringArgs

    AlertsForAllJobFailuresEnabled bool
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    AlertsForCriticalOperationFailuresEnabled bool
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.
    AlertsForAllJobFailuresEnabled bool
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    AlertsForCriticalOperationFailuresEnabled bool
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.
    alertsForAllJobFailuresEnabled Boolean
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    alertsForCriticalOperationFailuresEnabled Boolean
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.
    alertsForAllJobFailuresEnabled boolean
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    alertsForCriticalOperationFailuresEnabled boolean
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.
    alerts_for_all_job_failures_enabled bool
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    alerts_for_critical_operation_failures_enabled bool
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.
    alertsForAllJobFailuresEnabled Boolean
    Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults to true.
    alertsForCriticalOperationFailuresEnabled Boolean
    Enabling/Disabling alerts from the older (classic alerts) solution. Defaults to true. More details could be found here.

    Import

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

    $ pulumi import azure:recoveryservices/vault:Vault vault1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/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.

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