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.

backup¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.backup.AwaitableGetPolicyVMResult(id=None, name=None, recovery_vault_name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.backup.ContainerStorageAccount(resource_name, opts=None, recovery_vault_name=None, resource_group_name=None, storage_account_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages registration of a storage account with Azure Backup. Storage accounts must be registered with an Azure Recovery Vault in order to backup file shares within the storage account. Registering a storage account with a vault creates what is known as a protection container within Azure Recovery Services. Once the container is created, Azure file shares within the storage account can be backed up using the backup.ProtectedFileShare resource.

NOTE: Azure Backup for Azure File Shares is currently in public preview. During the preview, the service is subject to additional limitations and unsupported backup scenarios. Read More

import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="West US")
vault = azure.recoveryservices.Vault("vault",
    location=rg.location,
    resource_group_name=rg.name,
    sku="Standard")
sa = azure.storage.Account("sa",
    location=rg.location,
    resource_group_name=rg.name,
    account_tier="Standard",
    account_replication_type="LRS")
container = azure.backup.ContainerStorageAccount("container",
    resource_group_name=rg.name,
    recovery_vault_name=vault.name,
    storage_account_id=sa.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
recovery_vault_name (pulumi.Input[str]) – The name of the vault where the storage account will be registered.
resource_group_name (pulumi.Input[str]) – Name of the resource group where the vault is located.
storage_account_id (pulumi.Input[str]) – Azure Resource ID of the storage account to be registered

recovery_vault_name: pulumi.Output[str] = None¶: The name of the vault where the storage account will be registered.

resource_group_name: pulumi.Output[str] = None¶: Name of the resource group where the vault is located.

storage_account_id: pulumi.Output[str] = None¶: Azure Resource ID of the storage account to be registered

static get(resource_name, id, opts=None, recovery_vault_name=None, resource_group_name=None, storage_account_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
recovery_vault_name (pulumi.Input[str]) – The name of the vault where the storage account will be registered.
resource_group_name (pulumi.Input[str]) – Name of the resource group where the vault is located.
storage_account_id (pulumi.Input[str]) – Azure Resource ID of the storage account to be registered

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.backup.GetPolicyVMResult(id=None, name=None, recovery_vault_name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getPolicyVM.

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

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

class pulumi_azure.backup.PolicyFileShare(resource_name, opts=None, backup=None, name=None, recovery_vault_name=None, resource_group_name=None, retention_daily=None, timezone=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure File Share Backup Policy within a Recovery Services vault.

NOTE: Azure Backup for Azure File Shares is currently in public preview. During the preview, the service is subject to additional limitations and unsupported backup scenarios. Read More

import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="West US")
vault = azure.recoveryservices.Vault("vault",
    location=rg.location,
    resource_group_name=rg.name,
    sku="Standard")
policy = azure.backup.PolicyFileShare("policy",
    resource_group_name=rg.name,
    recovery_vault_name=vault.name,
    timezone="UTC",
    backup={
        "frequency": "Daily",
        "time": "23:00",
    },
    retention_daily={
        "count": 10,
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backup (pulumi.Input[dict]) – Configures the Policy backup frequency and times as documented in the backup block below.
name (pulumi.Input[str]) – Specifies the name of the 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 policy. 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.
timezone (pulumi.Input[str]) – Specifies the timezone. Defaults to UTC

The backup object supports the following:

frequency (pulumi.Input[str]) - Sets the backup frequency. Currently, only Daily is supported
time (pulumi.Input[str])

The retention_daily object supports the following:

count (pulumi.Input[float]) - The number of daily backups to keep. Must be between 1 and 180 (inclusive)

backup: pulumi.Output[dict] = None¶

Configures the Policy backup frequency and times as documented in the backup block below.

frequency (str) - Sets the backup frequency. Currently, only Daily is supported
time (str)

name: pulumi.Output[str] = None¶: Specifies the name of the policy. Changing this forces a new resource to be created.

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

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the policy. Changing this forces a new resource to be created.

retention_daily: pulumi.Output[dict] = None¶

Configures the policy daily retention as documented in the retention_daily block below.

count (float) - The number of daily backups to keep. Must be between 1 and 180 (inclusive)

timezone: pulumi.Output[str] = None¶: Specifies the timezone. Defaults to UTC

static get(resource_name, id, opts=None, backup=None, name=None, recovery_vault_name=None, resource_group_name=None, retention_daily=None, timezone=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backup (pulumi.Input[dict]) – Configures the Policy backup frequency and times as documented in the backup block below.
name (pulumi.Input[str]) – Specifies the name of the 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 policy. 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.
timezone (pulumi.Input[str]) – Specifies the timezone. Defaults to UTC

The backup object supports the following:

frequency (pulumi.Input[str]) - Sets the backup frequency. Currently, only Daily is supported
time (pulumi.Input[str])

The retention_daily object supports the following:

count (pulumi.Input[float]) - The number of daily backups to keep. Must be between 1 and 180 (inclusive)

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.backup.PolicyVM(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, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Backup VM Backup Policy.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_vault = azure.recoveryservices.Vault("exampleVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
example_policy_vm = azure.backup.PolicyVM("examplePolicyVM",
    resource_group_name=example_resource_group.name,
    recovery_vault_name=example_vault.name,
    timezone="UTC",
    backup={
        "frequency": "Daily",
        "time": "23:00",
    },
    retention_daily={
        "count": 10,
    },
    retention_weekly={
        "count": 42,
        "weekdays": [
            "Sunday",
            "Wednesday",
            "Friday",
            "Saturday",
        ],
    },
    retention_monthly={
        "count": 7,
        "weekdays": [
            "Sunday",
            "Wednesday",
        ],
        "weeks": [
            "First",
            "Last",
        ],
    },
    retention_yearly={
        "count": 77,
        "weekdays": ["Sunday"],
        "weeks": ["Last"],
        "months": ["January"],
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backup (pulumi.Input[dict]) – Configures the Policy backup frequency, times & days as documented in the backup block below.
name (pulumi.Input[str]) – Specifies the name of the Backup 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 policy. 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

The backup object supports the following:

frequency (pulumi.Input[str]) - Sets the backup frequency. Must be either Daily orWeekly.
time (pulumi.Input[str]) - The time of day to perform the backup in 24hour format.
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

The retention_daily object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999

The retention_monthly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (pulumi.Input[list]) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

The retention_weekly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

The retention_yearly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
months (pulumi.Input[list]) - The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (pulumi.Input[list]) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

backup: pulumi.Output[dict] = None¶

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

frequency (str) - Sets the backup frequency. Must be either Daily orWeekly.
time (str) - The time of day to perform the backup in 24hour format.
weekdays (list) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

name: pulumi.Output[str] = None¶: Specifies the name of the Backup Policy. Changing this forces a new resource to be created.

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

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the policy. Changing this forces a new resource to be created.

retention_daily: pulumi.Output[dict] = None¶

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

count (float) - The number of yearly backups to keep. Must be between 1 and 9999

retention_monthly: pulumi.Output[dict] = None¶

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

count (float) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (list) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (list) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

retention_weekly: pulumi.Output[dict] = None¶

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

count (float) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (list) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

retention_yearly: pulumi.Output[dict] = None¶

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

count (float) - The number of yearly backups to keep. Must be between 1 and 9999
months (list) - The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
weekdays (list) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (list) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

timezone: pulumi.Output[str] = None¶: Specifies the timezone. Defaults to UTC

static get(resource_name, id, 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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backup (pulumi.Input[dict]) – Configures the Policy backup frequency, times & days as documented in the backup block below.
name (pulumi.Input[str]) – Specifies the name of the Backup 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 policy. 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

The backup object supports the following:

frequency (pulumi.Input[str]) - Sets the backup frequency. Must be either Daily orWeekly.
time (pulumi.Input[str]) - The time of day to perform the backup in 24hour format.
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

The retention_daily object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999

The retention_monthly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (pulumi.Input[list]) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

The retention_weekly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

The retention_yearly object supports the following:

count (pulumi.Input[float]) - The number of yearly backups to keep. Must be between 1 and 9999
months (pulumi.Input[list]) - The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
weekdays (pulumi.Input[list]) - The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
weeks (pulumi.Input[list]) - The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

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.backup.ProtectedFileShare(resource_name, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_file_share_name=None, source_storage_account_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Backup Protected File Share to enable backups for file shares within an Azure Storage Account

NOTE: Azure Backup for Azure File Shares is currently in public preview. During the preview, the service is subject to additional limitations and unsupported backup scenarios. Read More
NOTE Azure Backup for Azure File Shares does not support Soft Delete at this time. Deleting this resource will also delete all associated backup data. Please exercise caution. Consider using ``protect` <https://www.pulumi.com/docs/intro/concepts/programming-model/#protect>`_ to guard against accidental deletion.

import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="West US")
vault = azure.recoveryservices.Vault("vault",
    location=rg.location,
    resource_group_name=rg.name,
    sku="Standard")
sa = azure.storage.Account("sa",
    location=rg.location,
    resource_group_name=rg.name,
    account_tier="Standard",
    account_replication_type="LRS")
example_share = azure.storage.Share("exampleShare", storage_account_name=sa.name)
protection_container = azure.backup.ContainerStorageAccount("protection-container",
    resource_group_name=rg.name,
    recovery_vault_name=vault.name,
    storage_account_id=sa.id)
example_policy_file_share = azure.backup.PolicyFileShare("examplePolicyFileShare",
    resource_group_name=rg.name,
    recovery_vault_name=vault.name,
    backup={
        "frequency": "Daily",
        "time": "23:00",
    },
    retention_daily={
        "count": 10,
    })
share1 = azure.backup.ProtectedFileShare("share1",
    resource_group_name=rg.name,
    recovery_vault_name=vault.name,
    source_storage_account_id=protection_container.storage_account_id,
    source_file_share_name=example_share.name,
    backup_policy_id=example_policy_file_share.id)

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. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
source_file_share_name (pulumi.Input[str]) – Specifies the name of the file share to backup. Changing this forces a new resource to be created.
source_storage_account_id (pulumi.Input[str]) – Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

backup_policy_id: pulumi.Output[str] = None¶: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.

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

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Azure Backup Protected File Share. Changing this forces a new resource to be created.

source_file_share_name: pulumi.Output[str] = None¶: Specifies the name of the file share to backup. Changing this forces a new resource to be created.

source_storage_account_id: pulumi.Output[str] = None¶: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_file_share_name=None, source_storage_account_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backup_policy_id (pulumi.Input[str]) – Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
source_file_share_name (pulumi.Input[str]) – Specifies the name of the file share to backup. Changing this forces a new resource to be created.
source_storage_account_id (pulumi.Input[str]) – Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

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.backup.ProtectedVM(resource_name, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_vm_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages Azure Backup for an Azure VM

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_vault = azure.recoveryservices.Vault("exampleVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
example_policy_vm = azure.backup.PolicyVM("examplePolicyVM",
    resource_group_name=example_resource_group.name,
    recovery_vault_name=example_vault.name,
    backup={
        "frequency": "Daily",
        "time": "23:00",
    })
vm1 = azure.backup.ProtectedVM("vm1",
    resource_group_name=example_resource_group.name,
    recovery_vault_name=example_vault.name,
    source_vm_id=azurerm_virtual_machine["example"]["id"],
    backup_policy_id=example_policy_vm.id)

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.
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: pulumi.Output[str] = None¶: Specifies the id of the backup policy to use.

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

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: Specifies the ID of the VM to backup. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_vm_id=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backup_policy_id (pulumi.Input[str]) – Specifies the id of the backup policy to use.
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.

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.backup.get_policy_vm(name=None, recovery_vault_name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing VM Backup Policy.

import pulumi
import pulumi_azure as azure

policy = azure.backup.get_policy_vm(name="policy",
    recovery_vault_name="recovery_vault",
    resource_group_name="resource_group")

Parameters

name (str) – Specifies the name of the VM Backup Policy.
recovery_vault_name (str) – Specifies the name of the Recovery Services Vault.
resource_group_name (str) – The name of the resource group in which the VM Backup Policy resides.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

backup¶

On This Page