PolicyFileShare

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

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

Create a PolicyFileShare Resource

new PolicyFileShare(name: string, args: PolicyFileShareArgs, opts?: CustomResourceOptions);

def PolicyFileShare(resource_name, opts=None, backup=None, name=None, recovery_vault_name=None, resource_group_name=None, retention_daily=None, timezone=None, __props__=None);

func NewPolicyFileShare(ctx *Context, name string, args PolicyFileShareArgs, opts ...ResourceOption) (*PolicyFileShare, error)

public PolicyFileShare(string name, PolicyFileShareArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

PolicyFileShare Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PolicyFileShare resource accepts the following input properties:

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.
Timezone string: Specifies the timezone. 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.
Timezone string: Specifies the timezone. 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.
timezone string: Specifies the timezone. Defaults to UTC

backup Dict[PolicyFileShareBackup]: 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 Dict[PolicyFileShareRetentionDaily]: 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.
timezone str: Specifies the timezone. 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

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

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)

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.

The following state arguments are supported:

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.
Timezone string: Specifies the timezone. 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.
Timezone string: Specifies the timezone. 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.
timezone string: Specifies the timezone. Defaults to UTC

backup Dict[PolicyFileShareBackup]: 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 Dict[PolicyFileShareRetentionDaily]: Configures the policy daily retention as documented in the retention_daily block below.
timezone str: Specifies the timezone. Defaults to UTC

Supporting Types

PolicyFileShareBackup

See the input and output API doc for this type.

Frequency string: Sets the backup frequency. Currently, only Daily is supported
Time string

Frequency string: Sets the backup frequency. Currently, only Daily is supported
Time string

frequency string: Sets the backup frequency. Currently, only Daily is supported
time string

frequency str: Sets the backup frequency. Currently, only Daily is supported
time str

PolicyFileShareRetentionDaily

See the input and output API doc for this type.

Count int: The number of daily backups to keep. Must be between 1 and 180 (inclusive)

Count int: The number of daily backups to keep. Must be between 1 and 180 (inclusive)

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

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

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud