Module recoveryservices
This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.
Resources
Functions
Others
Resources
Resource Vault
class Vault extends CustomResourceManages an Recovery Services Vault.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const rg = new azure.core.ResourceGroup("rg", {location: "West US"});
const vault = new azure.recoveryservices.Vault("vault", {
location: rg.location,
resourceGroupName: rg.name,
sku: "Standard",
softDeleteEnabled: true,
});constructor
new Vault(name: string, args: VaultArgs, opts?: pulumi.CustomResourceOptions)Create a Vault resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VaultState, opts?: pulumi.CustomResourceOptions): VaultGet an existing Vault resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is VaultReturns true if the given object is an instance of Vault. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property location
public location: pulumi.Output<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
public name: pulumi.Output<string>;Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.
property resourceGroupName
public resourceGroupName: pulumi.Output<string>;The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
property sku
public sku: pulumi.Output<string>;Sets the vault’s SKU. Possible values include: Standard, RS0.
property softDeleteEnabled
public softDeleteEnabled: pulumi.Output<boolean | undefined>;Is soft delete enable for this Vault? Defaults to true.
property tags
public tags: pulumi.Output<{[key: string]: string} | undefined>;A mapping of tags to assign to the resource.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Functions
Function getVault
getVault(args: GetVaultArgs, opts?: pulumi.InvokeOptions): Promise<GetVaultResult>Use this data source to access information about an existing Recovery Services Vault.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const vault = pulumi.output(azure.recoveryservices.getVault({
name: "tfex-recovery_vault",
resourceGroupName: "tfex-resource_group",
}, { async: true }));Others
interface GetVaultArgs
interface GetVaultArgsA collection of arguments for invoking getVault.
property name
name: string;Specifies the name of the Recovery Services Vault.
property resourceGroupName
resourceGroupName: string;The name of the resource group in which the Recovery Services Vault resides.
interface GetVaultResult
interface GetVaultResultA collection of values returned by getVault.
property id
id: string;The provider-assigned unique ID for this managed resource.
property location
location: string;The Azure location where the resource resides.
property name
name: string;property resourceGroupName
resourceGroupName: string;property sku
sku: string;The vault’s current SKU.
property tags
tags: {[key: string]: string};A mapping of tags assigned to the resource.
interface VaultArgs
interface VaultArgsThe set of arguments for constructing a Vault resource.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName: pulumi.Input<string>;The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
property sku
sku: pulumi.Input<string>;Sets the vault’s SKU. Possible values include: Standard, RS0.
property softDeleteEnabled
softDeleteEnabled?: pulumi.Input<boolean>;Is soft delete enable for this Vault? Defaults to true.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.
interface VaultState
interface VaultStateInput properties used for looking up and filtering Vault resources.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName?: pulumi.Input<string>;The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.
property sku
sku?: pulumi.Input<string>;Sets the vault’s SKU. Possible values include: Standard, RS0.
property softDeleteEnabled
softDeleteEnabled?: pulumi.Input<boolean>;Is soft delete enable for this Vault? Defaults to true.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.