Documentation

Architecture & Concepts ▹

Architecture & Concepts ▾

Programming Model

Projects

Stacks

Configuration and Secrets

Organizing Stacks and Projects

How Pulumi Works

State and Backends

Command Line ▹

Command Line ▾

Cancel

Config

Destroy

Logout

Logs

New

Plugin

Preview

Refresh

Stack

State

Update

Teams & Collaboration ▹

Teams & Collaboration ▾

Organizations

Teams

Roles and Access Controls

GitHub App

Pulumi Webhooks

Creating a 'Deploy with Pulumi' Button

Continuous Delivery ▹

Continuous Delivery ▾

AWS Code Services

Azure DevOps

CircleCI

GitHub Actions

GitLab CI

Google Cloud Build

Travis CI

Supported Clouds

Supported Languages ▹

Supported Languages ▾

Node.js

Python

Compared to Others ▹

Compared to Others ▾

Terraform

Cloud Templates

Cloud SDKs

Serverless

Kubernetes YAML

Chef, Puppet, etc.

Custom Solutions

API Reference ▹

API Reference ▾

Node.js

pulumi

aws

awsx

azure

azure-serverless

cloud

cloud-aws

cloud-azure

cloudflare

docker

eks

f5bigip

gcp

kubernetes

openstack

packet

random

vsphere

Python

pulumi

pulumi_aws

pulumi_azure

pulumi_cloudflare

pulumi_f5bigip

pulumi_gcp

pulumi_kubernetes

pulumi_openstack

pulumi_random

pulumi_vsphere

FAQ

Changelog

Troubleshooting & Support

Edit This Page

recoveryservices¶

class pulumi_azure.recoveryservices.GetVMProtectionPolicyResult(tags=None, id=None)¶

A collection of values returned by getVMProtectionPolicy.

tags = None¶: A mapping of tags assigned to the resource.

id = None¶: id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.recoveryservices.GetVaultResult(location=None, sku=None, tags=None, id=None)¶

A collection of values returned by getVault.

location = None¶: The Azure location where the resource resides.

sku = None¶: The vault’s current SKU.

tags = None¶: A mapping of tags assigned to the resource.

id = None¶: id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.recoveryservices.ProtectedVM(resource_name, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_vm_id=None, tags=None, __name__=None, __opts__=None)¶

Manages an Recovery Protected VM.

Parameters:

Parameters:	resource_name (str) – The name of the resource. opts (pulumi.ResourceOptions) – Options for the resource. backup_policy_id (pulumi.Input[str]) – Specifies the id of the backup policy to use. Changing this forces a new resource to be created. recovery_vault_name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created. resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created. source_vm_id (pulumi.Input[str]) – Specifies the ID of the VM to backup. Changing this forces a new resource to be created. tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backup_policy_id (pulumi.Input[str]) – Specifies the id of the backup policy to use. Changing this forces a new resource to be created.
recovery_vault_name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.
source_vm_id (pulumi.Input[str]) – Specifies the ID of the VM to backup. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

backup_policy_id = None¶: Specifies the id of the backup policy to use. Changing this forces a new resource to be created.

recovery_vault_name = None¶: Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.

resource_group_name = None¶: The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.

source_vm_id = None¶: Specifies the ID of the VM to backup. Changing this forces a new resource to be created.

tags = None¶: A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

class pulumi_azure.recoveryservices.ProtectionPolicyVM(resource_name, opts=None, backup=None, name=None, recovery_vault_name=None, resource_group_name=None, retention_daily=None, retention_monthly=None, retention_weekly=None, retention_yearly=None, tags=None, timezone=None, __name__=None, __opts__=None)¶

Manages an Recovery Services VM Protection Policy.

Parameters:

Parameters:	resource_name (str) – The name of the resource. opts (pulumi.ResourceOptions) – Options for the resource. backup (pulumi.Input[dict]) – Configures the Policy backup frequecent, times & days as documented in the `backup` block below. name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created. recovery_vault_name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created. resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created. retention_daily (pulumi.Input[dict]) – Configures the policy daily retention as documented in the `retention_daily` block below. Required when backup frequency is `Daily`. retention_monthly (pulumi.Input[dict]) – Configures the policy monthly retention as documented in the `retention_monthly` block below. retention_weekly (pulumi.Input[dict]) – Configures the policy weekly retention as documented in the `retention_weekly` block below. Required when backup frequency is `Weekly`. retention_yearly (pulumi.Input[dict]) – Configures the policy yearly retention as documented in the `retention_yearly` block below. tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. timezone (pulumi.Input[str]) – Specifies the timezone. Defaults to `UTC`

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backup (pulumi.Input[dict]) – Configures the Policy backup frequecent, times & days as documented in the backup block below.
name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created.
recovery_vault_name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.
retention_daily (pulumi.Input[dict]) – Configures the policy daily retention as documented in the retention_daily block below. Required when backup frequency is Daily.
retention_monthly (pulumi.Input[dict]) – Configures the policy monthly retention as documented in the retention_monthly block below.
retention_weekly (pulumi.Input[dict]) – Configures the policy weekly retention as documented in the retention_weekly block below. Required when backup frequency is Weekly.
retention_yearly (pulumi.Input[dict]) – Configures the policy yearly retention as documented in the retention_yearly block below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
timezone (pulumi.Input[str]) – Specifies the timezone. Defaults to UTC

backup = None¶: Configures the Policy backup frequecent, times & days as documented in the backup block below.

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

recovery_vault_name = None¶: Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.

resource_group_name = None¶: The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.

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

retention_monthly = None¶: Configures the policy monthly retention as documented in the retention_monthly block below.

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

retention_yearly = None¶: Configures the policy yearly retention as documented in the retention_yearly block below.

tags = None¶: A mapping of tags to assign to the resource.

timezone = None¶: Specifies the timezone. Defaults to UTC

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

class pulumi_azure.recoveryservices.Vault(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __name__=None, __opts__=None)¶

Manage an Recovery Services Vault.

Parameters:

Parameters:	resource_name (str) – The name of the resource. opts (pulumi.ResourceOptions) – Options for the resource. location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created. resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – Sets the vault’s SKU. Possible values include: `Standard`, `RS0`. tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – Sets the vault’s SKU. Possible values include: Standard, RS0.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

location = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None¶: Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.

resource_group_name = None¶: The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.

sku = None¶: Sets the vault’s SKU. Possible values include: Standard, RS0.

tags = None¶: A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:	prop (str) – A property name.
Returns:	A potentially transformed property name.
Return type:	str

pulumi_azure.recoveryservices.get_vault(name=None, resource_group_name=None, opts=None)¶: Use this data source to access information about an existing Recovery Services Vault.

pulumi_azure.recoveryservices.get_vm_protection_policy(name=None, recovery_vault_name=None, resource_group_name=None, opts=None)¶: Use this data source to access information about an existing Recovery Services VM Protection Policy.