Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. dataprotection
  5. BackupPolicyKubernetesCluster

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.dataprotection.BackupPolicyKubernetesCluster

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Backup Policy to back up Kubernetes Cluster.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleBackupVault:
    type: azure:dataprotection:BackupVault
    name: example
    properties:
      name: example-backup-vault
      resourceGroupName: ${example.name}
      location: ${example.location}
      datastoreType: VaultStore
      redundancy: LocallyRedundant
  exampleBackupPolicyKubernetesCluster:
    type: azure:dataprotection:BackupPolicyKubernetesCluster
    name: example
    properties:
      name: example-backup-policy
      resourceGroupName: ${example.name}
      vaultName: ${exampleBackupVault.name}
      backupRepeatingTimeIntervals:
        - R/2021-05-23T02:30:00+00:00/P1W
      timeZone: India Standard Time
      defaultRetentionDuration: P4M
      retentionRules:
        - name: Daily
          priority: 25
          lifeCycles:
            - duration: P84D
              dataStoreType: OperationalStore
          criteria:
            absoluteCriteria: FirstOfDay
      defaultRetentionRule:
        lifeCycles:
          - duration: P7D
            dataStoreType: OperationalStore
Copy

Create BackupPolicyKubernetesCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BackupPolicyKubernetesCluster(name: string, args: BackupPolicyKubernetesClusterArgs, opts?: CustomResourceOptions);
@overload
def BackupPolicyKubernetesCluster(resource_name: str,
                                  args: BackupPolicyKubernetesClusterArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def BackupPolicyKubernetesCluster(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  backup_repeating_time_intervals: Optional[Sequence[str]] = None,
                                  default_retention_rule: Optional[BackupPolicyKubernetesClusterDefaultRetentionRuleArgs] = None,
                                  resource_group_name: Optional[str] = None,
                                  vault_name: Optional[str] = None,
                                  name: Optional[str] = None,
                                  retention_rules: Optional[Sequence[BackupPolicyKubernetesClusterRetentionRuleArgs]] = None,
                                  time_zone: Optional[str] = None)
func NewBackupPolicyKubernetesCluster(ctx *Context, name string, args BackupPolicyKubernetesClusterArgs, opts ...ResourceOption) (*BackupPolicyKubernetesCluster, error)
public BackupPolicyKubernetesCluster(string name, BackupPolicyKubernetesClusterArgs args, CustomResourceOptions? opts = null)
public BackupPolicyKubernetesCluster(String name, BackupPolicyKubernetesClusterArgs args)
public BackupPolicyKubernetesCluster(String name, BackupPolicyKubernetesClusterArgs args, CustomResourceOptions options)

type: azure:dataprotection:BackupPolicyKubernetesCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupPolicyKubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackupPolicyKubernetesClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackupPolicyKubernetesClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupPolicyKubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupPolicyKubernetesClusterArgs
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 backupPolicyKubernetesClusterResource = new Azure.DataProtection.BackupPolicyKubernetesCluster("backupPolicyKubernetesClusterResource", new()
{
    BackupRepeatingTimeIntervals = new[]
    {
        "string",
    },
    DefaultRetentionRule = new Azure.DataProtection.Inputs.BackupPolicyKubernetesClusterDefaultRetentionRuleArgs
    {
        LifeCycles = new[]
        {
            new Azure.DataProtection.Inputs.BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycleArgs
            {
                DataStoreType = "string",
                Duration = "string",
            },
        },
    },
    ResourceGroupName = "string",
    VaultName = "string",
    Name = "string",
    RetentionRules = new[]
    {
        new Azure.DataProtection.Inputs.BackupPolicyKubernetesClusterRetentionRuleArgs
        {
            Criteria = new Azure.DataProtection.Inputs.BackupPolicyKubernetesClusterRetentionRuleCriteriaArgs
            {
                AbsoluteCriteria = "string",
                DaysOfWeeks = new[]
                {
                    "string",
                },
                MonthsOfYears = new[]
                {
                    "string",
                },
                ScheduledBackupTimes = new[]
                {
                    "string",
                },
                WeeksOfMonths = new[]
                {
                    "string",
                },
            },
            LifeCycles = new[]
            {
                new Azure.DataProtection.Inputs.BackupPolicyKubernetesClusterRetentionRuleLifeCycleArgs
                {
                    DataStoreType = "string",
                    Duration = "string",
                },
            },
            Name = "string",
            Priority = 0,
        },
    },
    TimeZone = "string",
});
Copy
example, err := dataprotection.NewBackupPolicyKubernetesCluster(ctx, "backupPolicyKubernetesClusterResource", &dataprotection.BackupPolicyKubernetesClusterArgs{
	BackupRepeatingTimeIntervals: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefaultRetentionRule: &dataprotection.BackupPolicyKubernetesClusterDefaultRetentionRuleArgs{
		LifeCycles: dataprotection.BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycleArray{
			&dataprotection.BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycleArgs{
				DataStoreType: pulumi.String("string"),
				Duration:      pulumi.String("string"),
			},
		},
	},
	ResourceGroupName: pulumi.String("string"),
	VaultName:         pulumi.String("string"),
	Name:              pulumi.String("string"),
	RetentionRules: dataprotection.BackupPolicyKubernetesClusterRetentionRuleArray{
		&dataprotection.BackupPolicyKubernetesClusterRetentionRuleArgs{
			Criteria: &dataprotection.BackupPolicyKubernetesClusterRetentionRuleCriteriaArgs{
				AbsoluteCriteria: pulumi.String("string"),
				DaysOfWeeks: pulumi.StringArray{
					pulumi.String("string"),
				},
				MonthsOfYears: pulumi.StringArray{
					pulumi.String("string"),
				},
				ScheduledBackupTimes: pulumi.StringArray{
					pulumi.String("string"),
				},
				WeeksOfMonths: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			LifeCycles: dataprotection.BackupPolicyKubernetesClusterRetentionRuleLifeCycleArray{
				&dataprotection.BackupPolicyKubernetesClusterRetentionRuleLifeCycleArgs{
					DataStoreType: pulumi.String("string"),
					Duration:      pulumi.String("string"),
				},
			},
			Name:     pulumi.String("string"),
			Priority: pulumi.Int(0),
		},
	},
	TimeZone: pulumi.String("string"),
})
Copy
var backupPolicyKubernetesClusterResource = new BackupPolicyKubernetesCluster("backupPolicyKubernetesClusterResource", BackupPolicyKubernetesClusterArgs.builder()
    .backupRepeatingTimeIntervals("string")
    .defaultRetentionRule(BackupPolicyKubernetesClusterDefaultRetentionRuleArgs.builder()
        .lifeCycles(BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycleArgs.builder()
            .dataStoreType("string")
            .duration("string")
            .build())
        .build())
    .resourceGroupName("string")
    .vaultName("string")
    .name("string")
    .retentionRules(BackupPolicyKubernetesClusterRetentionRuleArgs.builder()
        .criteria(BackupPolicyKubernetesClusterRetentionRuleCriteriaArgs.builder()
            .absoluteCriteria("string")
            .daysOfWeeks("string")
            .monthsOfYears("string")
            .scheduledBackupTimes("string")
            .weeksOfMonths("string")
            .build())
        .lifeCycles(BackupPolicyKubernetesClusterRetentionRuleLifeCycleArgs.builder()
            .dataStoreType("string")
            .duration("string")
            .build())
        .name("string")
        .priority(0)
        .build())
    .timeZone("string")
    .build());
Copy
backup_policy_kubernetes_cluster_resource = azure.dataprotection.BackupPolicyKubernetesCluster("backupPolicyKubernetesClusterResource",
    backup_repeating_time_intervals=["string"],
    default_retention_rule={
        "life_cycles": [{
            "data_store_type": "string",
            "duration": "string",
        }],
    },
    resource_group_name="string",
    vault_name="string",
    name="string",
    retention_rules=[{
        "criteria": {
            "absolute_criteria": "string",
            "days_of_weeks": ["string"],
            "months_of_years": ["string"],
            "scheduled_backup_times": ["string"],
            "weeks_of_months": ["string"],
        },
        "life_cycles": [{
            "data_store_type": "string",
            "duration": "string",
        }],
        "name": "string",
        "priority": 0,
    }],
    time_zone="string")
Copy
const backupPolicyKubernetesClusterResource = new azure.dataprotection.BackupPolicyKubernetesCluster("backupPolicyKubernetesClusterResource", {
    backupRepeatingTimeIntervals: ["string"],
    defaultRetentionRule: {
        lifeCycles: [{
            dataStoreType: "string",
            duration: "string",
        }],
    },
    resourceGroupName: "string",
    vaultName: "string",
    name: "string",
    retentionRules: [{
        criteria: {
            absoluteCriteria: "string",
            daysOfWeeks: ["string"],
            monthsOfYears: ["string"],
            scheduledBackupTimes: ["string"],
            weeksOfMonths: ["string"],
        },
        lifeCycles: [{
            dataStoreType: "string",
            duration: "string",
        }],
        name: "string",
        priority: 0,
    }],
    timeZone: "string",
});
Copy
type: azure:dataprotection:BackupPolicyKubernetesCluster
properties:
    backupRepeatingTimeIntervals:
        - string
    defaultRetentionRule:
        lifeCycles:
            - dataStoreType: string
              duration: string
    name: string
    resourceGroupName: string
    retentionRules:
        - criteria:
            absoluteCriteria: string
            daysOfWeeks:
                - string
            monthsOfYears:
                - string
            scheduledBackupTimes:
                - string
            weeksOfMonths:
                - string
          lifeCycles:
            - dataStoreType: string
              duration: string
          name: string
          priority: 0
    timeZone: string
    vaultName: string
Copy

BackupPolicyKubernetesCluster 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 BackupPolicyKubernetesCluster resource accepts the following input properties:

BackupRepeatingTimeIntervals
This property is required.
Changes to this property will trigger replacement.
List<string>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
DefaultRetentionRule
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
RetentionRules Changes to this property will trigger replacement. List<BackupPolicyKubernetesClusterRetentionRule>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
TimeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
BackupRepeatingTimeIntervals
This property is required.
Changes to this property will trigger replacement.
[]string
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
DefaultRetentionRule
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRuleArgs
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
RetentionRules Changes to this property will trigger replacement. []BackupPolicyKubernetesClusterRetentionRuleArgs
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
TimeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals
This property is required.
Changes to this property will trigger replacement.
List<String>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. List<BackupPolicyKubernetesClusterRetentionRule>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. String
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals
This property is required.
Changes to this property will trigger replacement.
string[]
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
vaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. BackupPolicyKubernetesClusterRetentionRule[]
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
backup_repeating_time_intervals
This property is required.
Changes to this property will trigger replacement.
Sequence[str]
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
default_retention_rule
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRuleArgs
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
vault_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
retention_rules Changes to this property will trigger replacement. Sequence[BackupPolicyKubernetesClusterRetentionRuleArgs]
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
time_zone Changes to this property will trigger replacement. str
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals
This property is required.
Changes to this property will trigger replacement.
List<String>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule
This property is required.
Changes to this property will trigger replacement.
Property Map
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. List<Property Map>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. String
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackupPolicyKubernetesCluster 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 BackupPolicyKubernetesCluster Resource

Get an existing BackupPolicyKubernetesCluster 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?: BackupPolicyKubernetesClusterState, opts?: CustomResourceOptions): BackupPolicyKubernetesCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_repeating_time_intervals: Optional[Sequence[str]] = None,
        default_retention_rule: Optional[BackupPolicyKubernetesClusterDefaultRetentionRuleArgs] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        retention_rules: Optional[Sequence[BackupPolicyKubernetesClusterRetentionRuleArgs]] = None,
        time_zone: Optional[str] = None,
        vault_name: Optional[str] = None) -> BackupPolicyKubernetesCluster
func GetBackupPolicyKubernetesCluster(ctx *Context, name string, id IDInput, state *BackupPolicyKubernetesClusterState, opts ...ResourceOption) (*BackupPolicyKubernetesCluster, error)
public static BackupPolicyKubernetesCluster Get(string name, Input<string> id, BackupPolicyKubernetesClusterState? state, CustomResourceOptions? opts = null)
public static BackupPolicyKubernetesCluster get(String name, Output<String> id, BackupPolicyKubernetesClusterState state, CustomResourceOptions options)
resources:  _:    type: azure:dataprotection:BackupPolicyKubernetesCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
BackupRepeatingTimeIntervals Changes to this property will trigger replacement. List<string>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
DefaultRetentionRule Changes to this property will trigger replacement. BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
RetentionRules Changes to this property will trigger replacement. List<BackupPolicyKubernetesClusterRetentionRule>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
TimeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
VaultName Changes to this property will trigger replacement. string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
BackupRepeatingTimeIntervals Changes to this property will trigger replacement. []string
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
DefaultRetentionRule Changes to this property will trigger replacement. BackupPolicyKubernetesClusterDefaultRetentionRuleArgs
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
RetentionRules Changes to this property will trigger replacement. []BackupPolicyKubernetesClusterRetentionRuleArgs
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
TimeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
VaultName Changes to this property will trigger replacement. string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals Changes to this property will trigger replacement. List<String>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule Changes to this property will trigger replacement. BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. List<BackupPolicyKubernetesClusterRetentionRule>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. String
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
vaultName Changes to this property will trigger replacement. String
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals Changes to this property will trigger replacement. string[]
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule Changes to this property will trigger replacement. BackupPolicyKubernetesClusterDefaultRetentionRule
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. BackupPolicyKubernetesClusterRetentionRule[]
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. string
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
vaultName Changes to this property will trigger replacement. string
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
backup_repeating_time_intervals Changes to this property will trigger replacement. Sequence[str]
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
default_retention_rule Changes to this property will trigger replacement. BackupPolicyKubernetesClusterDefaultRetentionRuleArgs
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
retention_rules Changes to this property will trigger replacement. Sequence[BackupPolicyKubernetesClusterRetentionRuleArgs]
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
time_zone Changes to this property will trigger replacement. str
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
vault_name Changes to this property will trigger replacement. str
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
backupRepeatingTimeIntervals Changes to this property will trigger replacement. List<String>
Specifies a list of repeating time interval. It supports weekly back. It should follow ISO 8601 repeating time interval. Changing this forces a new resource to be created.
defaultRetentionRule Changes to this property will trigger replacement. Property Map
A default_retention_rule block as defined below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for the Backup Policy Kubernetes Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
retentionRules Changes to this property will trigger replacement. List<Property Map>
One or more retention_rule blocks as defined below. Changing this forces a new resource to be created.
timeZone Changes to this property will trigger replacement. String
Specifies the Time Zone which should be used by the backup schedule. Changing this forces a new resource to be created.
vaultName Changes to this property will trigger replacement. String
The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.

Supporting Types

BackupPolicyKubernetesClusterDefaultRetentionRule
, BackupPolicyKubernetesClusterDefaultRetentionRuleArgs

LifeCycles
This property is required.
Changes to this property will trigger replacement.
List<BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle>
A life_cycle block as defined below. Changing this forces a new resource to be created.
LifeCycles
This property is required.
Changes to this property will trigger replacement.
[]BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle
A life_cycle block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
List<BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle>
A life_cycle block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle[]
A life_cycle block as defined below. Changing this forces a new resource to be created.
life_cycles
This property is required.
Changes to this property will trigger replacement.
Sequence[BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle]
A life_cycle block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
A life_cycle block as defined below. Changing this forces a new resource to be created.

BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycle
, BackupPolicyKubernetesClusterDefaultRetentionRuleLifeCycleArgs

DataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
Duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
DataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
Duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
String
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
String
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
data_store_type
This property is required.
Changes to this property will trigger replacement.
str
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
str
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
String
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
String
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.

BackupPolicyKubernetesClusterRetentionRule
, BackupPolicyKubernetesClusterRetentionRuleArgs

Criteria
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleCriteria
A criteria block as defined below. Changing this forces a new resource to be created.
LifeCycles
This property is required.
Changes to this property will trigger replacement.
List<BackupPolicyKubernetesClusterRetentionRuleLifeCycle>
A life_cycle block as defined below. Changing this forces a new resource to be created.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name which should be used for this retention rule. Changing this forces a new resource to be created.
Priority
This property is required.
Changes to this property will trigger replacement.
int
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.
Criteria
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleCriteria
A criteria block as defined below. Changing this forces a new resource to be created.
LifeCycles
This property is required.
Changes to this property will trigger replacement.
[]BackupPolicyKubernetesClusterRetentionRuleLifeCycle
A life_cycle block as defined below. Changing this forces a new resource to be created.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name which should be used for this retention rule. Changing this forces a new resource to be created.
Priority
This property is required.
Changes to this property will trigger replacement.
int
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.
criteria
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleCriteria
A criteria block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
List<BackupPolicyKubernetesClusterRetentionRuleLifeCycle>
A life_cycle block as defined below. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
String
The name which should be used for this retention rule. Changing this forces a new resource to be created.
priority
This property is required.
Changes to this property will trigger replacement.
Integer
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.
criteria
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleCriteria
A criteria block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleLifeCycle[]
A life_cycle block as defined below. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
string
The name which should be used for this retention rule. Changing this forces a new resource to be created.
priority
This property is required.
Changes to this property will trigger replacement.
number
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.
criteria
This property is required.
Changes to this property will trigger replacement.
BackupPolicyKubernetesClusterRetentionRuleCriteria
A criteria block as defined below. Changing this forces a new resource to be created.
life_cycles
This property is required.
Changes to this property will trigger replacement.
Sequence[BackupPolicyKubernetesClusterRetentionRuleLifeCycle]
A life_cycle block as defined below. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
str
The name which should be used for this retention rule. Changing this forces a new resource to be created.
priority
This property is required.
Changes to this property will trigger replacement.
int
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.
criteria
This property is required.
Changes to this property will trigger replacement.
Property Map
A criteria block as defined below. Changing this forces a new resource to be created.
lifeCycles
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
A life_cycle block as defined below. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
String
The name which should be used for this retention rule. Changing this forces a new resource to be created.
priority
This property is required.
Changes to this property will trigger replacement.
Number
Specifies the priority of the rule. The priority number must be unique for each rule. The lower the priority number, the higher the priority of the rule. Changing this forces a new resource to be created.

BackupPolicyKubernetesClusterRetentionRuleCriteria
, BackupPolicyKubernetesClusterRetentionRuleCriteriaArgs

AbsoluteCriteria Changes to this property will trigger replacement. string
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
DaysOfWeeks Changes to this property will trigger replacement. List<string>
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
MonthsOfYears Changes to this property will trigger replacement. List<string>
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
ScheduledBackupTimes Changes to this property will trigger replacement. List<string>
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
WeeksOfMonths Changes to this property will trigger replacement. List<string>
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.
AbsoluteCriteria Changes to this property will trigger replacement. string
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
DaysOfWeeks Changes to this property will trigger replacement. []string
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
MonthsOfYears Changes to this property will trigger replacement. []string
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
ScheduledBackupTimes Changes to this property will trigger replacement. []string
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
WeeksOfMonths Changes to this property will trigger replacement. []string
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.
absoluteCriteria Changes to this property will trigger replacement. String
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
daysOfWeeks Changes to this property will trigger replacement. List<String>
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
monthsOfYears Changes to this property will trigger replacement. List<String>
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
scheduledBackupTimes Changes to this property will trigger replacement. List<String>
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
weeksOfMonths Changes to this property will trigger replacement. List<String>
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.
absoluteCriteria Changes to this property will trigger replacement. string
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
daysOfWeeks Changes to this property will trigger replacement. string[]
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
monthsOfYears Changes to this property will trigger replacement. string[]
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
scheduledBackupTimes Changes to this property will trigger replacement. string[]
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
weeksOfMonths Changes to this property will trigger replacement. string[]
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.
absolute_criteria Changes to this property will trigger replacement. str
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
days_of_weeks Changes to this property will trigger replacement. Sequence[str]
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
months_of_years Changes to this property will trigger replacement. Sequence[str]
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
scheduled_backup_times Changes to this property will trigger replacement. Sequence[str]
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
weeks_of_months Changes to this property will trigger replacement. Sequence[str]
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.
absoluteCriteria Changes to this property will trigger replacement. String
Possible values are AllBackup, FirstOfDay, FirstOfWeek, FirstOfMonth and FirstOfYear. These values mean the first successful backup of the day/week/month/year. Changing this forces a new resource to be created.
daysOfWeeks Changes to this property will trigger replacement. List<String>
Possible values are Monday, Tuesday, Thursday, Friday, Saturday and Sunday. Changing this forces a new resource to be created.
monthsOfYears Changes to this property will trigger replacement. List<String>
Possible values are January, February, March, April, May, June, July, August, September, October, November and December. Changing this forces a new resource to be created.
scheduledBackupTimes Changes to this property will trigger replacement. List<String>
Specifies a list of backup times for backup in the RFC3339 format. Changing this forces a new resource to be created.
weeksOfMonths Changes to this property will trigger replacement. List<String>
Possible values are First, Second, Third, Fourth and Last. Changing this forces a new resource to be created.

BackupPolicyKubernetesClusterRetentionRuleLifeCycle
, BackupPolicyKubernetesClusterRetentionRuleLifeCycleArgs

DataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
Duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
DataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
Duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
String
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
String
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
string
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
string
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
data_store_type
This property is required.
Changes to this property will trigger replacement.
str
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
str
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.
dataStoreType
This property is required.
Changes to this property will trigger replacement.
String
The type of data store. The only possible value is OperationalStore. Changing this forces a new resource to be created.
duration
This property is required.
Changes to this property will trigger replacement.
String
The retention duration up to which the backups are to be retained in the data stores. It should follow ISO 8601 duration format. Changing this forces a new resource to be created.

Import

Backup Policy Kubernetes Cluster’s can be imported using the resource id, e.g.

$ pulumi import azure:dataprotection/backupPolicyKubernetesCluster:BackupPolicyKubernetesCluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataProtection/backupVaults/vault1/backupPolicies/backupPolicy1
Copy

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 azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure