ProtectedFileShare

Manages an Azure Backup Protected File Share to enable backups for file shares within an Azure Storage Account

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
NOTE Azure Backup for Azure File Shares does not support Soft Delete at this time. Deleting this resource will also delete all associated backup data. Please exercise caution. Consider using protect to guard against accidental deletion.

Create a ProtectedFileShare Resource

new ProtectedFileShare(name: string, args: ProtectedFileShareArgs, opts?: CustomResourceOptions);

def ProtectedFileShare(resource_name, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_file_share_name=None, source_storage_account_id=None, __props__=None);

func NewProtectedFileShare(ctx *Context, name string, args ProtectedFileShareArgs, opts ...ResourceOption) (*ProtectedFileShare, error)

public ProtectedFileShare(string name, ProtectedFileShareArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ProtectedFileShareArgs: 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 ProtectedFileShareArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProtectedFileShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ProtectedFileShare Resource Properties

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

Inputs

The ProtectedFileShare resource accepts the following input properties:

BackupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
SourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
SourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

BackupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
SourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
SourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

backupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
sourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
sourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

backup_policy_id str: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
source_file_share_name str: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
source_storage_account_id str: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

Outputs

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

Get an existing ProtectedFileShare 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?: ProtectedFileShareState, opts?: CustomResourceOptions): ProtectedFileShare

static get(resource_name, id, opts=None, backup_policy_id=None, recovery_vault_name=None, resource_group_name=None, source_file_share_name=None, source_storage_account_id=None, __props__=None);

func GetProtectedFileShare(ctx *Context, name string, id IDInput, state *ProtectedFileShareState, opts ...ResourceOption) (*ProtectedFileShare, error)

public static ProtectedFileShare Get(string name, Input<string> id, ProtectedFileShareState? 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:

BackupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
SourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
SourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

BackupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
SourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
SourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

backupPolicyId string: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
sourceFileShareName string: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
sourceStorageAccountId string: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

backup_policy_id str: Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
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 Azure Backup Protected File Share. Changing this forces a new resource to be created.
source_file_share_name str: Specifies the name of the file share to backup. Changing this forces a new resource to be created.
source_storage_account_id str: Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

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