Class 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.

Inheritance

System.Object

Resource

CustomResource

ProtectedFileShare

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Backup

Assembly: Pulumi.Azure.dll

Syntax

public class ProtectedFileShare : CustomResource

Constructors

ProtectedFileShare(String, ProtectedFileShareArgs, CustomResourceOptions)

Create a ProtectedFileShare resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ProtectedFileShareArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BackupPolicyId

Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.

Declaration

public Output<string> BackupPolicyId { get; }

Property Value

Type	Description
Output<System.String>

RecoveryVaultName

Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.

Declaration

public Output<string> RecoveryVaultName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SourceFileShareName

Specifies the name of the file share to backup. Changing this forces a new resource to be created.

Declaration

public Output<string> SourceFileShareName { get; }

Property Value

Type	Description
Output<System.String>

SourceStorageAccountId

Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.

Declaration

public Output<string> SourceStorageAccountId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ProtectedFileShareState, CustomResourceOptions)

Get an existing ProtectedFileShare resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ProtectedFileShare Get(string name, Input<string> id, ProtectedFileShareState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ProtectedFileShareState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ProtectedFileShare