We recommend using Azure Native.
azure.backup.PolicyVMWorkload
Explore with Pulumi AI
Manages an Azure VM Workload Backup Policy within 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: "example-bpvmw",
location: "West Europe",
});
const exampleVault = new azure.recoveryservices.Vault("example", {
name: "example-rsv",
location: example.location,
resourceGroupName: example.name,
sku: "Standard",
softDeleteEnabled: false,
});
const examplePolicyVMWorkload = new azure.backup.PolicyVMWorkload("example", {
name: "example-bpvmw",
resourceGroupName: example.name,
recoveryVaultName: exampleVault.name,
workloadType: "SQLDataBase",
settings: {
timeZone: "UTC",
compressionEnabled: false,
},
protectionPolicies: [
{
policyType: "Full",
backup: {
frequency: "Daily",
time: "15:00",
},
retentionDaily: {
count: 8,
},
},
{
policyType: "Log",
backup: {
frequencyInMinutes: 15,
},
simpleRetention: {
count: 8,
},
},
],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-bpvmw",
location="West Europe")
example_vault = azure.recoveryservices.Vault("example",
name="example-rsv",
location=example.location,
resource_group_name=example.name,
sku="Standard",
soft_delete_enabled=False)
example_policy_vm_workload = azure.backup.PolicyVMWorkload("example",
name="example-bpvmw",
resource_group_name=example.name,
recovery_vault_name=example_vault.name,
workload_type="SQLDataBase",
settings={
"time_zone": "UTC",
"compression_enabled": False,
},
protection_policies=[
{
"policy_type": "Full",
"backup": {
"frequency": "Daily",
"time": "15:00",
},
"retention_daily": {
"count": 8,
},
},
{
"policy_type": "Log",
"backup": {
"frequency_in_minutes": 15,
},
"simple_retention": {
"count": 8,
},
},
])
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/backup"
"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("example-bpvmw"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVault, err := recoveryservices.NewVault(ctx, "example", &recoveryservices.VaultArgs{
Name: pulumi.String("example-rsv"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: pulumi.String("Standard"),
SoftDeleteEnabled: pulumi.Bool(false),
})
if err != nil {
return err
}
_, err = backup.NewPolicyVMWorkload(ctx, "example", &backup.PolicyVMWorkloadArgs{
Name: pulumi.String("example-bpvmw"),
ResourceGroupName: example.Name,
RecoveryVaultName: exampleVault.Name,
WorkloadType: pulumi.String("SQLDataBase"),
Settings: &backup.PolicyVMWorkloadSettingsArgs{
TimeZone: pulumi.String("UTC"),
CompressionEnabled: pulumi.Bool(false),
},
ProtectionPolicies: backup.PolicyVMWorkloadProtectionPolicyArray{
&backup.PolicyVMWorkloadProtectionPolicyArgs{
PolicyType: pulumi.String("Full"),
Backup: &backup.PolicyVMWorkloadProtectionPolicyBackupArgs{
Frequency: pulumi.String("Daily"),
Time: pulumi.String("15:00"),
},
RetentionDaily: &backup.PolicyVMWorkloadProtectionPolicyRetentionDailyArgs{
Count: pulumi.Int(8),
},
},
&backup.PolicyVMWorkloadProtectionPolicyArgs{
PolicyType: pulumi.String("Log"),
Backup: &backup.PolicyVMWorkloadProtectionPolicyBackupArgs{
FrequencyInMinutes: pulumi.Int(15),
},
SimpleRetention: &backup.PolicyVMWorkloadProtectionPolicySimpleRetentionArgs{
Count: pulumi.Int(8),
},
},
},
})
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 = "example-bpvmw",
Location = "West Europe",
});
var exampleVault = new Azure.RecoveryServices.Vault("example", new()
{
Name = "example-rsv",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = "Standard",
SoftDeleteEnabled = false,
});
var examplePolicyVMWorkload = new Azure.Backup.PolicyVMWorkload("example", new()
{
Name = "example-bpvmw",
ResourceGroupName = example.Name,
RecoveryVaultName = exampleVault.Name,
WorkloadType = "SQLDataBase",
Settings = new Azure.Backup.Inputs.PolicyVMWorkloadSettingsArgs
{
TimeZone = "UTC",
CompressionEnabled = false,
},
ProtectionPolicies = new[]
{
new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyArgs
{
PolicyType = "Full",
Backup = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyBackupArgs
{
Frequency = "Daily",
Time = "15:00",
},
RetentionDaily = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyRetentionDailyArgs
{
Count = 8,
},
},
new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyArgs
{
PolicyType = "Log",
Backup = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyBackupArgs
{
FrequencyInMinutes = 15,
},
SimpleRetention = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicySimpleRetentionArgs
{
Count = 8,
},
},
},
});
});
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 com.pulumi.azure.backup.PolicyVMWorkload;
import com.pulumi.azure.backup.PolicyVMWorkloadArgs;
import com.pulumi.azure.backup.inputs.PolicyVMWorkloadSettingsArgs;
import com.pulumi.azure.backup.inputs.PolicyVMWorkloadProtectionPolicyArgs;
import com.pulumi.azure.backup.inputs.PolicyVMWorkloadProtectionPolicyBackupArgs;
import com.pulumi.azure.backup.inputs.PolicyVMWorkloadProtectionPolicyRetentionDailyArgs;
import com.pulumi.azure.backup.inputs.PolicyVMWorkloadProtectionPolicySimpleRetentionArgs;
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("example-bpvmw")
.location("West Europe")
.build());
var exampleVault = new Vault("exampleVault", VaultArgs.builder()
.name("example-rsv")
.location(example.location())
.resourceGroupName(example.name())
.sku("Standard")
.softDeleteEnabled(false)
.build());
var examplePolicyVMWorkload = new PolicyVMWorkload("examplePolicyVMWorkload", PolicyVMWorkloadArgs.builder()
.name("example-bpvmw")
.resourceGroupName(example.name())
.recoveryVaultName(exampleVault.name())
.workloadType("SQLDataBase")
.settings(PolicyVMWorkloadSettingsArgs.builder()
.timeZone("UTC")
.compressionEnabled(false)
.build())
.protectionPolicies(
PolicyVMWorkloadProtectionPolicyArgs.builder()
.policyType("Full")
.backup(PolicyVMWorkloadProtectionPolicyBackupArgs.builder()
.frequency("Daily")
.time("15:00")
.build())
.retentionDaily(PolicyVMWorkloadProtectionPolicyRetentionDailyArgs.builder()
.count(8)
.build())
.build(),
PolicyVMWorkloadProtectionPolicyArgs.builder()
.policyType("Log")
.backup(PolicyVMWorkloadProtectionPolicyBackupArgs.builder()
.frequencyInMinutes(15)
.build())
.simpleRetention(PolicyVMWorkloadProtectionPolicySimpleRetentionArgs.builder()
.count(8)
.build())
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-bpvmw
location: West Europe
exampleVault:
type: azure:recoveryservices:Vault
name: example
properties:
name: example-rsv
location: ${example.location}
resourceGroupName: ${example.name}
sku: Standard
softDeleteEnabled: false
examplePolicyVMWorkload:
type: azure:backup:PolicyVMWorkload
name: example
properties:
name: example-bpvmw
resourceGroupName: ${example.name}
recoveryVaultName: ${exampleVault.name}
workloadType: SQLDataBase
settings:
timeZone: UTC
compressionEnabled: false
protectionPolicies:
- policyType: Full
backup:
frequency: Daily
time: 15:00
retentionDaily:
count: 8
- policyType: Log
backup:
frequencyInMinutes: 15
simpleRetention:
count: 8
Create PolicyVMWorkload Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyVMWorkload(name: string, args: PolicyVMWorkloadArgs, opts?: CustomResourceOptions);@overload
def PolicyVMWorkload(resource_name: str,
args: PolicyVMWorkloadArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyVMWorkload(resource_name: str,
opts: Optional[ResourceOptions] = None,
protection_policies: Optional[Sequence[PolicyVMWorkloadProtectionPolicyArgs]] = None,
recovery_vault_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
settings: Optional[PolicyVMWorkloadSettingsArgs] = None,
workload_type: Optional[str] = None,
name: Optional[str] = None)func NewPolicyVMWorkload(ctx *Context, name string, args PolicyVMWorkloadArgs, opts ...ResourceOption) (*PolicyVMWorkload, error)public PolicyVMWorkload(string name, PolicyVMWorkloadArgs args, CustomResourceOptions? opts = null)
public PolicyVMWorkload(String name, PolicyVMWorkloadArgs args)
public PolicyVMWorkload(String name, PolicyVMWorkloadArgs args, CustomResourceOptions options)
type: azure:backup:PolicyVMWorkload
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 PolicyVMWorkloadArgs
- 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 PolicyVMWorkloadArgs
- 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 PolicyVMWorkloadArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyVMWorkloadArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyVMWorkloadArgs
- 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 policyVMWorkloadResource = new Azure.Backup.PolicyVMWorkload("policyVMWorkloadResource", new()
{
ProtectionPolicies = new[]
{
new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyArgs
{
Backup = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyBackupArgs
{
Frequency = "string",
FrequencyInMinutes = 0,
Time = "string",
Weekdays = new[]
{
"string",
},
},
PolicyType = "string",
RetentionDaily = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyRetentionDailyArgs
{
Count = 0,
},
RetentionMonthly = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyRetentionMonthlyArgs
{
Count = 0,
FormatType = "string",
Monthdays = new[]
{
0,
},
Weekdays = new[]
{
"string",
},
Weeks = new[]
{
"string",
},
},
RetentionWeekly = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyRetentionWeeklyArgs
{
Count = 0,
Weekdays = new[]
{
"string",
},
},
RetentionYearly = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicyRetentionYearlyArgs
{
Count = 0,
FormatType = "string",
Months = new[]
{
"string",
},
Monthdays = new[]
{
0,
},
Weekdays = new[]
{
"string",
},
Weeks = new[]
{
"string",
},
},
SimpleRetention = new Azure.Backup.Inputs.PolicyVMWorkloadProtectionPolicySimpleRetentionArgs
{
Count = 0,
},
},
},
RecoveryVaultName = "string",
ResourceGroupName = "string",
Settings = new Azure.Backup.Inputs.PolicyVMWorkloadSettingsArgs
{
TimeZone = "string",
CompressionEnabled = false,
},
WorkloadType = "string",
Name = "string",
});
example, err := backup.NewPolicyVMWorkload(ctx, "policyVMWorkloadResource", &backup.PolicyVMWorkloadArgs{
ProtectionPolicies: backup.PolicyVMWorkloadProtectionPolicyArray{
&backup.PolicyVMWorkloadProtectionPolicyArgs{
Backup: &backup.PolicyVMWorkloadProtectionPolicyBackupArgs{
Frequency: pulumi.String("string"),
FrequencyInMinutes: pulumi.Int(0),
Time: pulumi.String("string"),
Weekdays: pulumi.StringArray{
pulumi.String("string"),
},
},
PolicyType: pulumi.String("string"),
RetentionDaily: &backup.PolicyVMWorkloadProtectionPolicyRetentionDailyArgs{
Count: pulumi.Int(0),
},
RetentionMonthly: &backup.PolicyVMWorkloadProtectionPolicyRetentionMonthlyArgs{
Count: pulumi.Int(0),
FormatType: pulumi.String("string"),
Monthdays: pulumi.IntArray{
pulumi.Int(0),
},
Weekdays: pulumi.StringArray{
pulumi.String("string"),
},
Weeks: pulumi.StringArray{
pulumi.String("string"),
},
},
RetentionWeekly: &backup.PolicyVMWorkloadProtectionPolicyRetentionWeeklyArgs{
Count: pulumi.Int(0),
Weekdays: pulumi.StringArray{
pulumi.String("string"),
},
},
RetentionYearly: &backup.PolicyVMWorkloadProtectionPolicyRetentionYearlyArgs{
Count: pulumi.Int(0),
FormatType: pulumi.String("string"),
Months: pulumi.StringArray{
pulumi.String("string"),
},
Monthdays: pulumi.IntArray{
pulumi.Int(0),
},
Weekdays: pulumi.StringArray{
pulumi.String("string"),
},
Weeks: pulumi.StringArray{
pulumi.String("string"),
},
},
SimpleRetention: &backup.PolicyVMWorkloadProtectionPolicySimpleRetentionArgs{
Count: pulumi.Int(0),
},
},
},
RecoveryVaultName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Settings: &backup.PolicyVMWorkloadSettingsArgs{
TimeZone: pulumi.String("string"),
CompressionEnabled: pulumi.Bool(false),
},
WorkloadType: pulumi.String("string"),
Name: pulumi.String("string"),
})
var policyVMWorkloadResource = new PolicyVMWorkload("policyVMWorkloadResource", PolicyVMWorkloadArgs.builder()
.protectionPolicies(PolicyVMWorkloadProtectionPolicyArgs.builder()
.backup(PolicyVMWorkloadProtectionPolicyBackupArgs.builder()
.frequency("string")
.frequencyInMinutes(0)
.time("string")
.weekdays("string")
.build())
.policyType("string")
.retentionDaily(PolicyVMWorkloadProtectionPolicyRetentionDailyArgs.builder()
.count(0)
.build())
.retentionMonthly(PolicyVMWorkloadProtectionPolicyRetentionMonthlyArgs.builder()
.count(0)
.formatType("string")
.monthdays(0)
.weekdays("string")
.weeks("string")
.build())
.retentionWeekly(PolicyVMWorkloadProtectionPolicyRetentionWeeklyArgs.builder()
.count(0)
.weekdays("string")
.build())
.retentionYearly(PolicyVMWorkloadProtectionPolicyRetentionYearlyArgs.builder()
.count(0)
.formatType("string")
.months("string")
.monthdays(0)
.weekdays("string")
.weeks("string")
.build())
.simpleRetention(PolicyVMWorkloadProtectionPolicySimpleRetentionArgs.builder()
.count(0)
.build())
.build())
.recoveryVaultName("string")
.resourceGroupName("string")
.settings(PolicyVMWorkloadSettingsArgs.builder()
.timeZone("string")
.compressionEnabled(false)
.build())
.workloadType("string")
.name("string")
.build());
policy_vm_workload_resource = azure.backup.PolicyVMWorkload("policyVMWorkloadResource",
protection_policies=[{
"backup": {
"frequency": "string",
"frequency_in_minutes": 0,
"time": "string",
"weekdays": ["string"],
},
"policy_type": "string",
"retention_daily": {
"count": 0,
},
"retention_monthly": {
"count": 0,
"format_type": "string",
"monthdays": [0],
"weekdays": ["string"],
"weeks": ["string"],
},
"retention_weekly": {
"count": 0,
"weekdays": ["string"],
},
"retention_yearly": {
"count": 0,
"format_type": "string",
"months": ["string"],
"monthdays": [0],
"weekdays": ["string"],
"weeks": ["string"],
},
"simple_retention": {
"count": 0,
},
}],
recovery_vault_name="string",
resource_group_name="string",
settings={
"time_zone": "string",
"compression_enabled": False,
},
workload_type="string",
name="string")
const policyVMWorkloadResource = new azure.backup.PolicyVMWorkload("policyVMWorkloadResource", {
protectionPolicies: [{
backup: {
frequency: "string",
frequencyInMinutes: 0,
time: "string",
weekdays: ["string"],
},
policyType: "string",
retentionDaily: {
count: 0,
},
retentionMonthly: {
count: 0,
formatType: "string",
monthdays: [0],
weekdays: ["string"],
weeks: ["string"],
},
retentionWeekly: {
count: 0,
weekdays: ["string"],
},
retentionYearly: {
count: 0,
formatType: "string",
months: ["string"],
monthdays: [0],
weekdays: ["string"],
weeks: ["string"],
},
simpleRetention: {
count: 0,
},
}],
recoveryVaultName: "string",
resourceGroupName: "string",
settings: {
timeZone: "string",
compressionEnabled: false,
},
workloadType: "string",
name: "string",
});
type: azure:backup:PolicyVMWorkload
properties:
name: string
protectionPolicies:
- backup:
frequency: string
frequencyInMinutes: 0
time: string
weekdays:
- string
policyType: string
retentionDaily:
count: 0
retentionMonthly:
count: 0
formatType: string
monthdays:
- 0
weekdays:
- string
weeks:
- string
retentionWeekly:
count: 0
weekdays:
- string
retentionYearly:
count: 0
formatType: string
monthdays:
- 0
months:
- string
weekdays:
- string
weeks:
- string
simpleRetention:
count: 0
recoveryVaultName: string
resourceGroupName: string
settings:
compressionEnabled: false
timeZone: string
workloadType: string
PolicyVMWorkload 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 PolicyVMWorkload resource accepts the following input properties:
- Protection
Policies List<PolicyVMWorkload Protection Policy> - One or more
protection_policyblocks as defined below. - Recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - Workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - Name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Protection
Policies []PolicyVMWorkload Protection Policy Args - One or more
protection_policyblocks as defined below. - Recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Settings
Policy
VMWorkload Settings Args - A
settingsblock as defined below. - Workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - Name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies List<PolicyVMWorkload Protection Policy> - One or more
protection_policyblocks as defined below. - recovery
Vault StringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - workload
Type String - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - name String
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies PolicyVMWorkload Protection Policy[] - One or more
protection_policyblocks as defined below. - recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection_
policies Sequence[PolicyVMWorkload Protection Policy Args] - One or more
protection_policyblocks as defined below. - recovery_
vault_ strname - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings Args - A
settingsblock as defined below. - workload_
type str - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - name str
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies List<Property Map> - One or more
protection_policyblocks as defined below. - recovery
Vault StringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings Property Map
- A
settingsblock as defined below. - workload
Type String - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created. - name String
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicyVMWorkload 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 PolicyVMWorkload Resource
Get an existing PolicyVMWorkload 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?: PolicyVMWorkloadState, opts?: CustomResourceOptions): PolicyVMWorkload@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
protection_policies: Optional[Sequence[PolicyVMWorkloadProtectionPolicyArgs]] = None,
recovery_vault_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
settings: Optional[PolicyVMWorkloadSettingsArgs] = None,
workload_type: Optional[str] = None) -> PolicyVMWorkloadfunc GetPolicyVMWorkload(ctx *Context, name string, id IDInput, state *PolicyVMWorkloadState, opts ...ResourceOption) (*PolicyVMWorkload, error)public static PolicyVMWorkload Get(string name, Input<string> id, PolicyVMWorkloadState? state, CustomResourceOptions? opts = null)public static PolicyVMWorkload get(String name, Output<String> id, PolicyVMWorkloadState state, CustomResourceOptions options)resources: _: type: azure:backup:PolicyVMWorkload 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.
- Name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Protection
Policies List<PolicyVMWorkload Protection Policy> - One or more
protection_policyblocks as defined below. - Recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - Workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
- Name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Protection
Policies []PolicyVMWorkload Protection Policy Args - One or more
protection_policyblocks as defined below. - Recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- Settings
Policy
VMWorkload Settings Args - A
settingsblock as defined below. - Workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
- name String
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies List<PolicyVMWorkload Protection Policy> - One or more
protection_policyblocks as defined below. - recovery
Vault StringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - workload
Type String - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
- name string
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies PolicyVMWorkload Protection Policy[] - One or more
protection_policyblocks as defined below. - recovery
Vault stringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings - A
settingsblock as defined below. - workload
Type string - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
- name str
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection_
policies Sequence[PolicyVMWorkload Protection Policy Args] - One or more
protection_policyblocks as defined below. - recovery_
vault_ strname - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings
Policy
VMWorkload Settings Args - A
settingsblock as defined below. - workload_
type str - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
- name String
- The name of the VM Workload Backup Policy. Changing this forces a new resource to be created.
- protection
Policies List<Property Map> - One or more
protection_policyblocks as defined below. - recovery
Vault StringName - The name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the VM Workload Backup Policy. Changing this forces a new resource to be created.
- settings Property Map
- A
settingsblock as defined below. - workload
Type String - The VM Workload type for the Backup Policy. Possible values are
SQLDataBaseandSAPHanaDatabase. Changing this forces a new resource to be created.
Supporting Types
PolicyVMWorkloadProtectionPolicy, PolicyVMWorkloadProtectionPolicyArgs
- Backup
Policy
VMWorkload Protection Policy Backup - A
backupblock as defined below. - Policy
Type string - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - Retention
Daily PolicyVMWorkload Protection Policy Retention Daily - A
retention_dailyblock as defined below. - Retention
Monthly PolicyVMWorkload Protection Policy Retention Monthly - A
retention_monthlyblock as defined below. - Retention
Weekly PolicyVMWorkload Protection Policy Retention Weekly - A
retention_weeklyblock as defined below. - Retention
Yearly PolicyVMWorkload Protection Policy Retention Yearly - A
retention_yearlyblock as defined below. - Simple
Retention PolicyVMWorkload Protection Policy Simple Retention - A
simple_retentionblock as defined below.
- Backup
Policy
VMWorkload Protection Policy Backup - A
backupblock as defined below. - Policy
Type string - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - Retention
Daily PolicyVMWorkload Protection Policy Retention Daily - A
retention_dailyblock as defined below. - Retention
Monthly PolicyVMWorkload Protection Policy Retention Monthly - A
retention_monthlyblock as defined below. - Retention
Weekly PolicyVMWorkload Protection Policy Retention Weekly - A
retention_weeklyblock as defined below. - Retention
Yearly PolicyVMWorkload Protection Policy Retention Yearly - A
retention_yearlyblock as defined below. - Simple
Retention PolicyVMWorkload Protection Policy Simple Retention - A
simple_retentionblock as defined below.
- backup
Policy
VMWorkload Protection Policy Backup - A
backupblock as defined below. - policy
Type String - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - retention
Daily PolicyVMWorkload Protection Policy Retention Daily - A
retention_dailyblock as defined below. - retention
Monthly PolicyVMWorkload Protection Policy Retention Monthly - A
retention_monthlyblock as defined below. - retention
Weekly PolicyVMWorkload Protection Policy Retention Weekly - A
retention_weeklyblock as defined below. - retention
Yearly PolicyVMWorkload Protection Policy Retention Yearly - A
retention_yearlyblock as defined below. - simple
Retention PolicyVMWorkload Protection Policy Simple Retention - A
simple_retentionblock as defined below.
- backup
Policy
VMWorkload Protection Policy Backup - A
backupblock as defined below. - policy
Type string - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - retention
Daily PolicyVMWorkload Protection Policy Retention Daily - A
retention_dailyblock as defined below. - retention
Monthly PolicyVMWorkload Protection Policy Retention Monthly - A
retention_monthlyblock as defined below. - retention
Weekly PolicyVMWorkload Protection Policy Retention Weekly - A
retention_weeklyblock as defined below. - retention
Yearly PolicyVMWorkload Protection Policy Retention Yearly - A
retention_yearlyblock as defined below. - simple
Retention PolicyVMWorkload Protection Policy Simple Retention - A
simple_retentionblock as defined below.
- backup
Policy
VMWorkload Protection Policy Backup - A
backupblock as defined below. - policy_
type str - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - retention_
daily PolicyVMWorkload Protection Policy Retention Daily - A
retention_dailyblock as defined below. - retention_
monthly PolicyVMWorkload Protection Policy Retention Monthly - A
retention_monthlyblock as defined below. - retention_
weekly PolicyVMWorkload Protection Policy Retention Weekly - A
retention_weeklyblock as defined below. - retention_
yearly PolicyVMWorkload Protection Policy Retention Yearly - A
retention_yearlyblock as defined below. - simple_
retention PolicyVMWorkload Protection Policy Simple Retention - A
simple_retentionblock as defined below.
- backup Property Map
- A
backupblock as defined below. - policy
Type String - The type of the VM Workload Backup Policy. Possible values are
Differential,Full,IncrementalandLog. - retention
Daily Property Map - A
retention_dailyblock as defined below. - retention
Monthly Property Map - A
retention_monthlyblock as defined below. - retention
Weekly Property Map - A
retention_weeklyblock as defined below. - retention
Yearly Property Map - A
retention_yearlyblock as defined below. - simple
Retention Property Map - A
simple_retentionblock as defined below.
PolicyVMWorkloadProtectionPolicyBackup, PolicyVMWorkloadProtectionPolicyBackupArgs
- Frequency string
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - Frequency
In intMinutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - Time string
- The time of day to perform the backup in 24hour format.
- Weekdays List<string>
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
- Frequency string
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - Frequency
In intMinutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - Time string
- The time of day to perform the backup in 24hour format.
- Weekdays []string
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
- frequency String
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - frequency
In IntegerMinutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - time String
- The time of day to perform the backup in 24hour format.
- weekdays List<String>
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
- frequency string
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - frequency
In numberMinutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - time string
- The time of day to perform the backup in 24hour format.
- weekdays string[]
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
- frequency str
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - frequency_
in_ intminutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - time str
- The time of day to perform the backup in 24hour format.
- weekdays Sequence[str]
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
- frequency String
- The backup frequency for the VM Workload Backup Policy. Possible values are
DailyandWeekly. - frequency
In NumberMinutes - The backup frequency in minutes for the VM Workload Backup Policy. Possible values are
15,30,60,120,240,480,720and1440. - time String
- The time of day to perform the backup in 24hour format.
- weekdays List<String>
- The days of the week to perform backups on. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. This is used whenfrequencyisWeekly.
PolicyVMWorkloadProtectionPolicyRetentionDaily, PolicyVMWorkloadProtectionPolicyRetentionDailyArgs
- Count int
- The number of daily backups to keep. Possible values are between
7and9999.
- Count int
- The number of daily backups to keep. Possible values are between
7and9999.
- count Integer
- The number of daily backups to keep. Possible values are between
7and9999.
- count number
- The number of daily backups to keep. Possible values are between
7and9999.
- count int
- The number of daily backups to keep. Possible values are between
7and9999.
- count Number
- The number of daily backups to keep. Possible values are between
7and9999.
PolicyVMWorkloadProtectionPolicyRetentionMonthly, PolicyVMWorkloadProtectionPolicyRetentionMonthlyArgs
- Count int
- The number of monthly backups to keep. Must be between
1and1188. - Format
Type string - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - Monthdays List<int>
- The monthday backups to retain. Possible values are between
0and28. - Weekdays List<string>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - Weeks List<string>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
- Count int
- The number of monthly backups to keep. Must be between
1and1188. - Format
Type string - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - Monthdays []int
- The monthday backups to retain. Possible values are between
0and28. - Weekdays []string
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - Weeks []string
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
- count Integer
- The number of monthly backups to keep. Must be between
1and1188. - format
Type String - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - monthdays List<Integer>
- The monthday backups to retain. Possible values are between
0and28. - weekdays List<String>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks List<String>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
- count number
- The number of monthly backups to keep. Must be between
1and1188. - format
Type string - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - monthdays number[]
- The monthday backups to retain. Possible values are between
0and28. - weekdays string[]
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks string[]
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
- count int
- The number of monthly backups to keep. Must be between
1and1188. - format_
type str - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - monthdays Sequence[int]
- The monthday backups to retain. Possible values are between
0and28. - weekdays Sequence[str]
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks Sequence[str]
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
- count Number
- The number of monthly backups to keep. Must be between
1and1188. - format
Type String - The retention schedule format type for monthly retention policy. Possible values are
DailyandWeekly. - monthdays List<Number>
- The monthday backups to retain. Possible values are between
0and28. - weekdays List<String>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks List<String>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,FourthandLast.
PolicyVMWorkloadProtectionPolicyRetentionWeekly, PolicyVMWorkloadProtectionPolicyRetentionWeeklyArgs
PolicyVMWorkloadProtectionPolicyRetentionYearly, PolicyVMWorkloadProtectionPolicyRetentionYearlyArgs
- Count int
- The number of yearly backups to keep. Possible values are between
1and99 - Format
Type string - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - Months List<string>
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - Monthdays List<int>
- The monthday backups to retain. Possible values are between
0and28. - Weekdays List<string>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - Weeks List<string>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
- Count int
- The number of yearly backups to keep. Possible values are between
1and99 - Format
Type string - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - Months []string
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - Monthdays []int
- The monthday backups to retain. Possible values are between
0and28. - Weekdays []string
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - Weeks []string
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
- count Integer
- The number of yearly backups to keep. Possible values are between
1and99 - format
Type String - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - months List<String>
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - monthdays List<Integer>
- The monthday backups to retain. Possible values are between
0and28. - weekdays List<String>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks List<String>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
- count number
- The number of yearly backups to keep. Possible values are between
1and99 - format
Type string - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - months string[]
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - monthdays number[]
- The monthday backups to retain. Possible values are between
0and28. - weekdays string[]
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks string[]
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
- count int
- The number of yearly backups to keep. Possible values are between
1and99 - format_
type str - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - months Sequence[str]
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - monthdays Sequence[int]
- The monthday backups to retain. Possible values are between
0and28. - weekdays Sequence[str]
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks Sequence[str]
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
- count Number
- The number of yearly backups to keep. Possible values are between
1and99 - format
Type String - The retention schedule format type for yearly retention policy. Possible values are
DailyandWeekly. - months List<String>
- The months of the year to retain backups of. Possible values are
January,February,March,April,May,June,July,August,September,October,NovemberandDecember. - monthdays List<Number>
- The monthday backups to retain. Possible values are between
0and28. - weekdays List<String>
- The weekday backups to retain. Possible values are
Sunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. - weeks List<String>
- The weeks of the month to retain backups of. Possible values are
First,Second,Third,Fourth,Last.
PolicyVMWorkloadProtectionPolicySimpleRetention, PolicyVMWorkloadProtectionPolicySimpleRetentionArgs
- Count int
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
- Count int
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
- count Integer
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
- count number
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
- count int
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
- count Number
- The count that is used to count retention duration with duration type
Days. Possible values are between7and35.
PolicyVMWorkloadSettings, PolicyVMWorkloadSettingsArgs
- Time
Zone string - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- Compression
Enabled bool - The compression setting for the VM Workload Backup Policy. Defaults to
false.
- Time
Zone string - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- Compression
Enabled bool - The compression setting for the VM Workload Backup Policy. Defaults to
false.
- time
Zone String - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- compression
Enabled Boolean - The compression setting for the VM Workload Backup Policy. Defaults to
false.
- time
Zone string - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- compression
Enabled boolean - The compression setting for the VM Workload Backup Policy. Defaults to
false.
- time_
zone str - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- compression_
enabled bool - The compression setting for the VM Workload Backup Policy. Defaults to
false.
- time
Zone String - The timezone for the VM Workload Backup Policy. The possible values are defined here.
- compression
Enabled Boolean - The compression setting for the VM Workload Backup Policy. Defaults to
false.
Import
Azure VM Workload Backup Policies can be imported using the resource id, e.g.
$ pulumi import azure:backup/policyVMWorkload:PolicyVMWorkload policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/vault1/backupPolicies/policy1
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
azurermTerraform Provider.