Module recoveryservices

@pulumi/azure > recoveryservices

Index

recoveryservices/getVault.ts recoveryservices/protectedVM.ts recoveryservices/protectionPolicyVM.ts recoveryservices/vault.ts

class ProtectedVM

Manages an Recovery Protected VM.

constructor

new ProtectedVM(name: string, args: ProtectedVMArgs, opts?: pulumi.CustomResourceOptions)

Create a ProtectedVM resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProtectedVMState): ProtectedVM

Get an existing ProtectedVM resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backupPolicyId

public backupPolicyId: pulumi.Output<string>;

Specifies the id of the backup policy to use. Changing this forces a new resource to be created.

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 recoveryVaultName

public recoveryVaultName: pulumi.Output<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property sourceVmId

public sourceVmId: pulumi.Output<string>;

Specifies the ID of the VM to backup. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{ ... }>;

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.

class ProtectionPolicyVM

Manages an Recovery Services VM Protection Policy.

constructor

new ProtectionPolicyVM(name: string, args: ProtectionPolicyVMArgs, opts?: pulumi.CustomResourceOptions)

Create a ProtectionPolicyVM resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProtectionPolicyVMState): ProtectionPolicyVM

Get an existing ProtectionPolicyVM resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backup

public backup: pulumi.Output<{ ... }>;

Configures the Policy backup frequecent, times & days as documented in the backup block below.

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 name

public name: pulumi.Output<string>;

Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created.

property recoveryVaultName

public recoveryVaultName: pulumi.Output<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property retentionDaily

public retentionDaily: pulumi.Output<{ ... } | undefined>;

Configures the policy daily retention as documented in the retention_daily block below. Required when backup frequency is Daily.

property retentionMonthly

public retentionMonthly: pulumi.Output<{ ... } | undefined>;

Configures the policy monthly retention as documented in the retention_monthly block below.

property retentionWeekly

public retentionWeekly: pulumi.Output<{ ... } | undefined>;

Configures the policy weekly retention as documented in the retention_weekly block below. Required when backup frequency is Weekly.

property retentionYearly

public retentionYearly: pulumi.Output<{ ... } | undefined>;

Configures the policy yearly retention as documented in the retention_yearly block below.

property tags

public tags: pulumi.Output<{ ... }>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Vault

Manage an Recovery Services Vault.

constructor

new Vault(name: string, args: VaultArgs, opts?: pulumi.CustomResourceOptions)

Create a Vault resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VaultState): Vault

Get 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 | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 tags

public tags: pulumi.Output<{ ... }>;

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.

function getVault

getVault(args: GetVaultArgs, opts?: pulumi.InvokeOptions): Promise<GetVaultResult>

Use this data source to access information about an existing Recovery Services Vault.

interface GetVaultArgs

A 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

A collection of values returned by getVault.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure location where the resource resides.

property sku

sku: string;

The vault’s current SKU.

property tags

tags: { ... };

A mapping of tags assigned to the resource.

interface ProtectedVMArgs

The set of arguments for constructing a ProtectedVM resource.

property backupPolicyId

backupPolicyId: pulumi.Input<string>;

Specifies the id of the backup policy to use. Changing this forces a new resource to be created.

property recoveryVaultName

recoveryVaultName: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property sourceVmId

sourceVmId: pulumi.Input<string>;

Specifies the ID of the VM to backup. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ProtectedVMState

Input properties used for looking up and filtering ProtectedVM resources.

property backupPolicyId

backupPolicyId?: pulumi.Input<string>;

Specifies the id of the backup policy to use. Changing this forces a new resource to be created.

property recoveryVaultName

recoveryVaultName?: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property sourceVmId

sourceVmId?: pulumi.Input<string>;

Specifies the ID of the VM to backup. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ProtectionPolicyVMArgs

The set of arguments for constructing a ProtectionPolicyVM resource.

property backup

backup: pulumi.Input<{ ... }>;

Configures the Policy backup frequecent, times & days as documented in the backup block below.

property name

name?: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created.

property recoveryVaultName

recoveryVaultName: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property retentionDaily

retentionDaily?: pulumi.Input<{ ... }>;

Configures the policy daily retention as documented in the retention_daily block below. Required when backup frequency is Daily.

property retentionMonthly

retentionMonthly?: pulumi.Input<{ ... }>;

Configures the policy monthly retention as documented in the retention_monthly block below.

property retentionWeekly

retentionWeekly?: pulumi.Input<{ ... }>;

Configures the policy weekly retention as documented in the retention_weekly block below. Required when backup frequency is Weekly.

property retentionYearly

retentionYearly?: pulumi.Input<{ ... }>;

Configures the policy yearly retention as documented in the retention_yearly block below.

property tags

tags?: pulumi.Input<{ ... }>;

interface ProtectionPolicyVMState

Input properties used for looking up and filtering ProtectionPolicyVM resources.

property backup

backup?: pulumi.Input<{ ... }>;

Configures the Policy backup frequecent, times & days as documented in the backup block below.

property name

name?: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created.

property recoveryVaultName

recoveryVaultName?: pulumi.Input<string>;

Specifies the name of the Recovery Services Vault to use. 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 Protected VM. Changing this forces a new resource to be created.

property retentionDaily

retentionDaily?: pulumi.Input<{ ... }>;

Configures the policy daily retention as documented in the retention_daily block below. Required when backup frequency is Daily.

property retentionMonthly

retentionMonthly?: pulumi.Input<{ ... }>;

Configures the policy monthly retention as documented in the retention_monthly block below.

property retentionWeekly

retentionWeekly?: pulumi.Input<{ ... }>;

Configures the policy weekly retention as documented in the retention_weekly block below. Required when backup frequency is Weekly.

property retentionYearly

retentionYearly?: pulumi.Input<{ ... }>;

Configures the policy yearly retention as documented in the retention_yearly block below.

property tags

tags?: pulumi.Input<{ ... }>;

interface VaultArgs

The 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 tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface VaultState

Input 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 tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.