import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an Azure File Share Backup Policy within a Recovery Services vault. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "tfex-recovery_vault", * location: "West Europe", * }); * const exampleVault = new azure.recoveryservices.Vault("example", { * name: "tfex-recovery-vault", * location: example.location, * resourceGroupName: example.name, * sku: "Standard", * }); * const policy = new azure.backup.PolicyFileShare("policy", { * name: "tfex-recovery-vault-policy", * resourceGroupName: example.name, * recoveryVaultName: exampleVault.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 * * Azure File Share Backup Policies can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:backup/policyFileShare:PolicyFileShare policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/example-recovery-vault/backupPolicies/policy1 * ``` */ export declare class PolicyFileShare extends pulumi.CustomResource { /** * Get an existing PolicyFileShare resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: PolicyFileShareState, opts?: pulumi.CustomResourceOptions): PolicyFileShare; /** * Returns true if the given object is an instance of PolicyFileShare. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is PolicyFileShare; /** * Configures the Policy backup frequency and times as documented in the `backup` block below. */ readonly backup: pulumi.Output; /** * The backup tier to use. Possible values are `vault-standard` and `snapshot`. Defaults to `snapshot`. * * > **Note:** When `backupTier` is set to `vault-standard`, the `snapshotRetentionInDays` value must be less than the `retentionDaily` count. */ readonly backupTier: pulumi.Output; /** * Specifies the name of the policy. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created. */ readonly recoveryVaultName: pulumi.Output; /** * The name of the resource group in which to create the policy. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * Configures the policy daily retention as documented in the `retentionDaily` block below. */ readonly retentionDaily: pulumi.Output; /** * Configures the policy monthly retention as documented in the `retentionMonthly` block below. */ readonly retentionMonthly: pulumi.Output; /** * Configures the policy weekly retention as documented in the `retentionWeekly` block below. */ readonly retentionWeekly: pulumi.Output; /** * Configures the policy yearly retention as documented in the `retentionYearly` block below. */ readonly retentionYearly: pulumi.Output; /** * The number of days to retain the snapshots. Defaults to `0`. */ readonly snapshotRetentionInDays: pulumi.Output; /** * Specifies the timezone. [the possible values are defined here](https://jackstromberg.com/2017/01/list-of-time-zones-consumed-by-azure/). Defaults to `UTC` * * > **Note:** The maximum number of snapshots that Azure Files can retain is 200. If your combined snapshot count exceeds 200 based on your retention policies, it will result in an error. See [this](https://docs.microsoft.com/azure/backup/backup-azure-files-faq#what-is-the-maximum-retention-i-can-configure-for-backups) article for more information. */ readonly timezone: pulumi.Output; /** * Create a PolicyFileShare resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: PolicyFileShareArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PolicyFileShare resources. */ export interface PolicyFileShareState { /** * Configures the Policy backup frequency and times as documented in the `backup` block below. */ backup?: pulumi.Input; /** * The backup tier to use. Possible values are `vault-standard` and `snapshot`. Defaults to `snapshot`. * * > **Note:** When `backupTier` is set to `vault-standard`, the `snapshotRetentionInDays` value must be less than the `retentionDaily` count. */ backupTier?: pulumi.Input; /** * Specifies the name of the policy. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created. */ recoveryVaultName?: pulumi.Input; /** * The name of the resource group in which to create the policy. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * Configures the policy daily retention as documented in the `retentionDaily` block below. */ retentionDaily?: pulumi.Input; /** * Configures the policy monthly retention as documented in the `retentionMonthly` block below. */ retentionMonthly?: pulumi.Input; /** * Configures the policy weekly retention as documented in the `retentionWeekly` block below. */ retentionWeekly?: pulumi.Input; /** * Configures the policy yearly retention as documented in the `retentionYearly` block below. */ retentionYearly?: pulumi.Input; /** * The number of days to retain the snapshots. Defaults to `0`. */ snapshotRetentionInDays?: pulumi.Input; /** * Specifies the timezone. [the possible values are defined here](https://jackstromberg.com/2017/01/list-of-time-zones-consumed-by-azure/). Defaults to `UTC` * * > **Note:** The maximum number of snapshots that Azure Files can retain is 200. If your combined snapshot count exceeds 200 based on your retention policies, it will result in an error. See [this](https://docs.microsoft.com/azure/backup/backup-azure-files-faq#what-is-the-maximum-retention-i-can-configure-for-backups) article for more information. */ timezone?: pulumi.Input; } /** * The set of arguments for constructing a PolicyFileShare resource. */ export interface PolicyFileShareArgs { /** * Configures the Policy backup frequency and times as documented in the `backup` block below. */ backup: pulumi.Input; /** * The backup tier to use. Possible values are `vault-standard` and `snapshot`. Defaults to `snapshot`. * * > **Note:** When `backupTier` is set to `vault-standard`, the `snapshotRetentionInDays` value must be less than the `retentionDaily` count. */ backupTier?: pulumi.Input; /** * Specifies the name of the policy. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created. */ recoveryVaultName: pulumi.Input; /** * The name of the resource group in which to create the policy. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * Configures the policy daily retention as documented in the `retentionDaily` block below. */ retentionDaily: pulumi.Input; /** * Configures the policy monthly retention as documented in the `retentionMonthly` block below. */ retentionMonthly?: pulumi.Input; /** * Configures the policy weekly retention as documented in the `retentionWeekly` block below. */ retentionWeekly?: pulumi.Input; /** * Configures the policy yearly retention as documented in the `retentionYearly` block below. */ retentionYearly?: pulumi.Input; /** * The number of days to retain the snapshots. Defaults to `0`. */ snapshotRetentionInDays?: pulumi.Input; /** * Specifies the timezone. [the possible values are defined here](https://jackstromberg.com/2017/01/list-of-time-zones-consumed-by-azure/). Defaults to `UTC` * * > **Note:** The maximum number of snapshots that Azure Files can retain is 200. If your combined snapshot count exceeds 200 based on your retention policies, it will result in an error. See [this](https://docs.microsoft.com/azure/backup/backup-azure-files-faq#what-is-the-maximum-retention-i-can-configure-for-backups) article for more information. */ timezone?: pulumi.Input; }