1. Packages
  2. Azure Classic
  3. API Docs
  4. backup
  5. PolicyFileShare

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.backup.PolicyFileShare

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

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

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleVault = new Azure.RecoveryServices.Vault("exampleVault", new Azure.RecoveryServices.VaultArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Standard",
        });
        var policy = new Azure.Backup.PolicyFileShare("policy", new Azure.Backup.PolicyFileShareArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            RecoveryVaultName = azurerm_recovery_services_vault.Vault.Name,
            Timezone = "UTC",
            Backup = new Azure.Backup.Inputs.PolicyFileShareBackupArgs
            {
                Frequency = "Daily",
                Time = "23:00",
            },
            RetentionDaily = new Azure.Backup.Inputs.PolicyFileShareRetentionDailyArgs
            {
                Count = 10,
            },
            RetentionWeekly = new Azure.Backup.Inputs.PolicyFileShareRetentionWeeklyArgs
            {
                Count = 7,
                Weekdays = 
                {
                    "Sunday",
                    "Wednesday",
                    "Friday",
                    "Saturday",
                },
            },
            RetentionMonthly = new Azure.Backup.Inputs.PolicyFileShareRetentionMonthlyArgs
            {
                Count = 7,
                Weekdays = 
                {
                    "Sunday",
                    "Wednesday",
                },
                Weeks = 
                {
                    "First",
                    "Last",
                },
            },
            RetentionYearly = new Azure.Backup.Inputs.PolicyFileShareRetentionYearlyArgs
            {
                Count = 7,
                Weekdays = 
                {
                    "Sunday",
                },
                Weeks = 
                {
                    "Last",
                },
                Months = 
                {
                    "January",
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/backup"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/recoveryservices"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = recoveryservices.NewVault(ctx, "exampleVault", &recoveryservices.VaultArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("Standard"),
		})
		if err != nil {
			return err
		}
		_, err = backup.NewPolicyFileShare(ctx, "policy", &backup.PolicyFileShareArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			RecoveryVaultName: pulumi.Any(azurerm_recovery_services_vault.Vault.Name),
			Timezone:          pulumi.String("UTC"),
			Backup: &backup.PolicyFileShareBackupArgs{
				Frequency: pulumi.String("Daily"),
				Time:      pulumi.String("23:00"),
			},
			RetentionDaily: &backup.PolicyFileShareRetentionDailyArgs{
				Count: pulumi.Int(10),
			},
			RetentionWeekly: &backup.PolicyFileShareRetentionWeeklyArgs{
				Count: pulumi.Int(7),
				Weekdays: pulumi.StringArray{
					pulumi.String("Sunday"),
					pulumi.String("Wednesday"),
					pulumi.String("Friday"),
					pulumi.String("Saturday"),
				},
			},
			RetentionMonthly: &backup.PolicyFileShareRetentionMonthlyArgs{
				Count: pulumi.Int(7),
				Weekdays: pulumi.StringArray{
					pulumi.String("Sunday"),
					pulumi.String("Wednesday"),
				},
				Weeks: pulumi.StringArray{
					pulumi.String("First"),
					pulumi.String("Last"),
				},
			},
			RetentionYearly: &backup.PolicyFileShareRetentionYearlyArgs{
				Count: pulumi.Int(7),
				Weekdays: pulumi.StringArray{
					pulumi.String("Sunday"),
				},
				Weeks: pulumi.StringArray{
					pulumi.String("Last"),
				},
				Months: pulumi.StringArray{
					pulumi.String("January"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVault = new azure.recoveryservices.Vault("exampleVault", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
});
const policy = new azure.backup.PolicyFileShare("policy", {
    resourceGroupName: exampleResourceGroup.name,
    recoveryVaultName: azurerm_recovery_services_vault.vault.name,
    timezone: "UTC",
    backup: {
        frequency: "Daily",
        time: "23:00",
    },
    retentionDaily: {
        count: 10,
    },
    retentionWeekly: {
        count: 7,
        weekdays: [
            "Sunday",
            "Wednesday",
            "Friday",
            "Saturday",
        ],
    },
    retentionMonthly: {
        count: 7,
        weekdays: [
            "Sunday",
            "Wednesday",
        ],
        weeks: [
            "First",
            "Last",
        ],
    },
    retentionYearly: {
        count: 7,
        weekdays: ["Sunday"],
        weeks: ["Last"],
        months: ["January"],
    },
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_vault = azure.recoveryservices.Vault("exampleVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
policy = azure.backup.PolicyFileShare("policy",
    resource_group_name=example_resource_group.name,
    recovery_vault_name=azurerm_recovery_services_vault["vault"]["name"],
    timezone="UTC",
    backup=azure.backup.PolicyFileShareBackupArgs(
        frequency="Daily",
        time="23:00",
    ),
    retention_daily=azure.backup.PolicyFileShareRetentionDailyArgs(
        count=10,
    ),
    retention_weekly=azure.backup.PolicyFileShareRetentionWeeklyArgs(
        count=7,
        weekdays=[
            "Sunday",
            "Wednesday",
            "Friday",
            "Saturday",
        ],
    ),
    retention_monthly=azure.backup.PolicyFileShareRetentionMonthlyArgs(
        count=7,
        weekdays=[
            "Sunday",
            "Wednesday",
        ],
        weeks=[
            "First",
            "Last",
        ],
    ),
    retention_yearly=azure.backup.PolicyFileShareRetentionYearlyArgs(
        count=7,
        weekdays=["Sunday"],
        weeks=["Last"],
        months=["January"],
    ))

    Example coming soon!

    Create PolicyFileShare Resource

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

    Constructor syntax

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

@overload
def PolicyFileShare(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    backup: Optional[PolicyFileShareBackupArgs] = None,
                    recovery_vault_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    retention_daily: Optional[PolicyFileShareRetentionDailyArgs] = None,
                    name: Optional[str] = None,
                    retention_monthly: Optional[PolicyFileShareRetentionMonthlyArgs] = None,
                    retention_weekly: Optional[PolicyFileShareRetentionWeeklyArgs] = None,
                    retention_yearly: Optional[PolicyFileShareRetentionYearlyArgs] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    timezone: Optional[str] = None)
    func NewPolicyFileShare(ctx *Context, name string, args PolicyFileShareArgs, opts ...ResourceOption) (*PolicyFileShare, error)
    public PolicyFileShare(string name, PolicyFileShareArgs args, CustomResourceOptions? opts = null)
    public PolicyFileShare(String name, PolicyFileShareArgs args)
public PolicyFileShare(String name, PolicyFileShareArgs args, CustomResourceOptions options)

    type: azure:backup:PolicyFileShare
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 PolicyFileShareArgs
    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 PolicyFileShareArgs
    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 PolicyFileShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyFileShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyFileShareArgs
    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 policyFileShareResource = new Azure.Backup.PolicyFileShare("policyFileShareResource", new()
{
    Backup = new Azure.Backup.Inputs.PolicyFileShareBackupArgs
    {
        Frequency = "string",
        Time = "string",
    },
    RecoveryVaultName = "string",
    ResourceGroupName = "string",
    RetentionDaily = new Azure.Backup.Inputs.PolicyFileShareRetentionDailyArgs
    {
        Count = 0,
    },
    Name = "string",
    RetentionMonthly = new Azure.Backup.Inputs.PolicyFileShareRetentionMonthlyArgs
    {
        Count = 0,
        Weekdays = new[]
        {
            "string",
        },
        Weeks = new[]
        {
            "string",
        },
    },
    RetentionWeekly = new Azure.Backup.Inputs.PolicyFileShareRetentionWeeklyArgs
    {
        Count = 0,
        Weekdays = new[]
        {
            "string",
        },
    },
    RetentionYearly = new Azure.Backup.Inputs.PolicyFileShareRetentionYearlyArgs
    {
        Count = 0,
        Months = new[]
        {
            "string",
        },
        Weekdays = new[]
        {
            "string",
        },
        Weeks = new[]
        {
            "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timezone = "string",
});

    example, err := backup.NewPolicyFileShare(ctx, "policyFileShareResource", &backup.PolicyFileShareArgs{
	Backup: &backup.PolicyFileShareBackupArgs{
		Frequency: pulumi.String("string"),
		Time:      pulumi.String("string"),
	},
	RecoveryVaultName: pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	RetentionDaily: &backup.PolicyFileShareRetentionDailyArgs{
		Count: pulumi.Int(0),
	},
	Name: pulumi.String("string"),
	RetentionMonthly: &backup.PolicyFileShareRetentionMonthlyArgs{
		Count: pulumi.Int(0),
		Weekdays: pulumi.StringArray{
			pulumi.String("string"),
		},
		Weeks: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	RetentionWeekly: &backup.PolicyFileShareRetentionWeeklyArgs{
		Count: pulumi.Int(0),
		Weekdays: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	RetentionYearly: &backup.PolicyFileShareRetentionYearlyArgs{
		Count: pulumi.Int(0),
		Months: pulumi.StringArray{
			pulumi.String("string"),
		},
		Weekdays: pulumi.StringArray{
			pulumi.String("string"),
		},
		Weeks: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timezone: pulumi.String("string"),
})

    var policyFileShareResource = new PolicyFileShare("policyFileShareResource", PolicyFileShareArgs.builder()
    .backup(PolicyFileShareBackupArgs.builder()
        .frequency("string")
        .time("string")
        .build())
    .recoveryVaultName("string")
    .resourceGroupName("string")
    .retentionDaily(PolicyFileShareRetentionDailyArgs.builder()
        .count(0)
        .build())
    .name("string")
    .retentionMonthly(PolicyFileShareRetentionMonthlyArgs.builder()
        .count(0)
        .weekdays("string")
        .weeks("string")
        .build())
    .retentionWeekly(PolicyFileShareRetentionWeeklyArgs.builder()
        .count(0)
        .weekdays("string")
        .build())
    .retentionYearly(PolicyFileShareRetentionYearlyArgs.builder()
        .count(0)
        .months("string")
        .weekdays("string")
        .weeks("string")
        .build())
    .tags(Map.of("string", "string"))
    .timezone("string")
    .build());

    policy_file_share_resource = azure.backup.PolicyFileShare("policyFileShareResource",
    backup={
        "frequency": "string",
        "time": "string",
    },
    recovery_vault_name="string",
    resource_group_name="string",
    retention_daily={
        "count": 0,
    },
    name="string",
    retention_monthly={
        "count": 0,
        "weekdays": ["string"],
        "weeks": ["string"],
    },
    retention_weekly={
        "count": 0,
        "weekdays": ["string"],
    },
    retention_yearly={
        "count": 0,
        "months": ["string"],
        "weekdays": ["string"],
        "weeks": ["string"],
    },
    tags={
        "string": "string",
    },
    timezone="string")

    const policyFileShareResource = new azure.backup.PolicyFileShare("policyFileShareResource", {
    backup: {
        frequency: "string",
        time: "string",
    },
    recoveryVaultName: "string",
    resourceGroupName: "string",
    retentionDaily: {
        count: 0,
    },
    name: "string",
    retentionMonthly: {
        count: 0,
        weekdays: ["string"],
        weeks: ["string"],
    },
    retentionWeekly: {
        count: 0,
        weekdays: ["string"],
    },
    retentionYearly: {
        count: 0,
        months: ["string"],
        weekdays: ["string"],
        weeks: ["string"],
    },
    tags: {
        string: "string",
    },
    timezone: "string",
});

    type: azure:backup:PolicyFileShare
properties:
    backup:
        frequency: string
        time: string
    name: string
    recoveryVaultName: string
    resourceGroupName: string
    retentionDaily:
        count: 0
    retentionMonthly:
        count: 0
        weekdays:
            - string
        weeks:
            - string
    retentionWeekly:
        count: 0
        weekdays:
            - string
    retentionYearly:
        count: 0
        months:
            - string
        weekdays:
            - string
        weeks:
            - string
    tags:
        string: string
    timezone: string

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

    Backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    RetentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    Name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    RetentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    RetentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    RetentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    Tags Dictionary<string, string>
    Timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    Backup PolicyFileShareBackupArgs
    Configures the Policy backup frequency and times as documented in the backup block below.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    RetentionDaily PolicyFileShareRetentionDailyArgs
    Configures the policy daily retention as documented in the retention_daily block below.
    Name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    RetentionMonthly PolicyFileShareRetentionMonthlyArgs
    Configures the policy monthly retention as documented in the retention_monthly block below.
    RetentionWeekly PolicyFileShareRetentionWeeklyArgs
    Configures the policy weekly retention as documented in the retention_weekly block below.
    RetentionYearly PolicyFileShareRetentionYearlyArgs
    Configures the policy yearly retention as documented in the retention_yearly block below.
    Tags map[string]string
    Timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    name String
    Specifies the name of the policy. Changing this forces a new resource to be created.
    retentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Map<String,String>
    timezone String
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    recoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    retentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags {[key: string]: string}
    timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackupArgs
    Configures the Policy backup frequency and times as documented in the backup block below.
    recovery_vault_name str
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retention_daily PolicyFileShareRetentionDailyArgs
    Configures the policy daily retention as documented in the retention_daily block below.
    name str
    Specifies the name of the policy. Changing this forces a new resource to be created.
    retention_monthly PolicyFileShareRetentionMonthlyArgs
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retention_weekly PolicyFileShareRetentionWeeklyArgs
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retention_yearly PolicyFileShareRetentionYearlyArgs
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Mapping[str, str]
    timezone str
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup Property Map
    Configures the Policy backup frequency and times as documented in the backup block below.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily Property Map
    Configures the policy daily retention as documented in the retention_daily block below.
    name String
    Specifies the name of the policy. Changing this forces a new resource to be created.
    retentionMonthly Property Map
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly Property Map
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly Property Map
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Map<String>
    timezone String
    Specifies the timezone. the possible values are defined here. Defaults to UTC

    Outputs

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

    Get an existing PolicyFileShare 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?: PolicyFileShareState, opts?: CustomResourceOptions): PolicyFileShare
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup: Optional[PolicyFileShareBackupArgs] = None,
        name: Optional[str] = None,
        recovery_vault_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        retention_daily: Optional[PolicyFileShareRetentionDailyArgs] = None,
        retention_monthly: Optional[PolicyFileShareRetentionMonthlyArgs] = None,
        retention_weekly: Optional[PolicyFileShareRetentionWeeklyArgs] = None,
        retention_yearly: Optional[PolicyFileShareRetentionYearlyArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        timezone: Optional[str] = None) -> PolicyFileShare
    func GetPolicyFileShare(ctx *Context, name string, id IDInput, state *PolicyFileShareState, opts ...ResourceOption) (*PolicyFileShare, error)
    public static PolicyFileShare Get(string name, Input<string> id, PolicyFileShareState? state, CustomResourceOptions? opts = null)
    public static PolicyFileShare get(String name, Output<String> id, PolicyFileShareState state, CustomResourceOptions options)
    resources:  _:    type: azure:backup:PolicyFileShare    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.
    The following state arguments are supported:
    Backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    Name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    RetentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    RetentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    RetentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    RetentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    Tags Dictionary<string, string>
    Timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    Backup PolicyFileShareBackupArgs
    Configures the Policy backup frequency and times as documented in the backup block below.
    Name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    RetentionDaily PolicyFileShareRetentionDailyArgs
    Configures the policy daily retention as documented in the retention_daily block below.
    RetentionMonthly PolicyFileShareRetentionMonthlyArgs
    Configures the policy monthly retention as documented in the retention_monthly block below.
    RetentionWeekly PolicyFileShareRetentionWeeklyArgs
    Configures the policy weekly retention as documented in the retention_weekly block below.
    RetentionYearly PolicyFileShareRetentionYearlyArgs
    Configures the policy yearly retention as documented in the retention_yearly block below.
    Tags map[string]string
    Timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    name String
    Specifies the name of the policy. Changing this forces a new resource to be created.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    retentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Map<String,String>
    timezone String
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackup
    Configures the Policy backup frequency and times as documented in the backup block below.
    name string
    Specifies the name of the policy. Changing this forces a new resource to be created.
    recoveryVaultName string
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily PolicyFileShareRetentionDaily
    Configures the policy daily retention as documented in the retention_daily block below.
    retentionMonthly PolicyFileShareRetentionMonthly
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly PolicyFileShareRetentionWeekly
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly PolicyFileShareRetentionYearly
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags {[key: string]: string}
    timezone string
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup PolicyFileShareBackupArgs
    Configures the Policy backup frequency and times as documented in the backup block below.
    name str
    Specifies the name of the policy. Changing this forces a new resource to be created.
    recovery_vault_name str
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retention_daily PolicyFileShareRetentionDailyArgs
    Configures the policy daily retention as documented in the retention_daily block below.
    retention_monthly PolicyFileShareRetentionMonthlyArgs
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retention_weekly PolicyFileShareRetentionWeeklyArgs
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retention_yearly PolicyFileShareRetentionYearlyArgs
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Mapping[str, str]
    timezone str
    Specifies the timezone. the possible values are defined here. Defaults to UTC
    backup Property Map
    Configures the Policy backup frequency and times as documented in the backup block below.
    name String
    Specifies the name of the policy. Changing this forces a new resource to be created.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
    retentionDaily Property Map
    Configures the policy daily retention as documented in the retention_daily block below.
    retentionMonthly Property Map
    Configures the policy monthly retention as documented in the retention_monthly block below.
    retentionWeekly Property Map
    Configures the policy weekly retention as documented in the retention_weekly block below.
    retentionYearly Property Map
    Configures the policy yearly retention as documented in the retention_yearly block below.
    tags Map<String>
    timezone String
    Specifies the timezone. the possible values are defined here. Defaults to UTC

    Supporting Types

    PolicyFileShareBackup, PolicyFileShareBackupArgs

    Frequency string
    Sets the backup frequency. Currently, only Daily is supported
    Time string
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)
    Frequency string
    Sets the backup frequency. Currently, only Daily is supported
    Time string
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)
    frequency String
    Sets the backup frequency. Currently, only Daily is supported
    time String
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)
    frequency string
    Sets the backup frequency. Currently, only Daily is supported
    time string
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)
    frequency str
    Sets the backup frequency. Currently, only Daily is supported
    time str
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)
    frequency String
    Sets the backup frequency. Currently, only Daily is supported
    time String
    The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.)

    PolicyFileShareRetentionDaily, PolicyFileShareRetentionDailyArgs

    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    count Integer
    The number of yearly backups to keep. Must be between 1 and 10
    count number
    The number of yearly backups to keep. Must be between 1 and 10
    count int
    The number of yearly backups to keep. Must be between 1 and 10
    count Number
    The number of yearly backups to keep. Must be between 1 and 10

    PolicyFileShareRetentionMonthly, PolicyFileShareRetentionMonthlyArgs

    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Weekdays List<string>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    Weeks List<string>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Weekdays []string
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    Weeks []string
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count Integer
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks List<String>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count number
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays string[]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks string[]
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count int
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays Sequence[str]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks Sequence[str]
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count Number
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks List<String>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

    PolicyFileShareRetentionWeekly, PolicyFileShareRetentionWeeklyArgs

    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Weekdays List<string>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Weekdays []string
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    count Integer
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    count number
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays string[]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    count int
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays Sequence[str]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    count Number
    The number of yearly backups to keep. Must be between 1 and 10
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

    PolicyFileShareRetentionYearly, PolicyFileShareRetentionYearlyArgs

    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Months List<string>
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    Weekdays List<string>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    Weeks List<string>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    Count int
    The number of yearly backups to keep. Must be between 1 and 10
    Months []string
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    Weekdays []string
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    Weeks []string
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count Integer
    The number of yearly backups to keep. Must be between 1 and 10
    months List<String>
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks List<String>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count number
    The number of yearly backups to keep. Must be between 1 and 10
    months string[]
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    weekdays string[]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks string[]
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count int
    The number of yearly backups to keep. Must be between 1 and 10
    months Sequence[str]
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    weekdays Sequence[str]
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks Sequence[str]
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.
    count Number
    The number of yearly backups to keep. Must be between 1 and 10
    months List<String>
    The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.
    weekdays List<String>
    The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.
    weeks List<String>
    The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

    Import

    Azure File Share Backup Policies can be imported using the resource id, e.g.

     $ pulumi import azure:backup/policyFileShare:PolicyFileShare policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/example-recovery-vault/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 azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.