Share via


FileShare Class

Definition

FileShare.

public class FileShare : Azure.Provisioning.Primitives.ProvisionableResource
public class FileShare : Azure.Provisioning.Primitives.Resource
type FileShare = class
    inherit ProvisionableResource
type FileShare = class
    inherit Resource
Public Class FileShare
Inherits ProvisionableResource
Public Class FileShare
Inherits Resource
Inheritance
Inheritance

Constructors

FileShare(String, String)

Creates a new FileShare.

Properties

AccessTier

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

AccessTierChangeOn

Indicates the last modification time for share access tier.

AccessTierStatus

Indicates if there is a pending transition for access tier.

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
DeletedOn

The deleted time if the share was deleted.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
DependsOn

Declares explicit dependencies on other resources.

(Inherited from Resource)
EnabledProtocol

The authentication protocol that is used for the file share. Can only be specified when creating a share.

ETag

Resource Etag.

Id

Gets the Id.

IdentifierName

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisioningConstruct)
IsDeleted

Indicates whether the share was deleted.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from Resource)
LastModifiedOn

Returns the date and time the share was last modified.

LeaseDuration

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.

LeaseState

Lease state of the share.

LeaseStatus

The lease status of the share.

Metadata

A name-value pair to associate with the share as metadata.

Name

The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

Parent

Gets or sets a reference to the parent FileService.

RemainingRetentionDays

Remaining retention days for share that was soft deleted.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceType

Gets the type of the resource.

(Inherited from Resource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from Resource)
RootSquash

The property is for NFS share only. The default is NoRootSquash.

ShareQuota

The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.

ShareUsageBytes

The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.

SignedIdentifiers

List of stored access policies specified on the share.

SnapshotOn

Creation time of share snapshot returned in the response of list shares with expand param "snapshots".

SystemData

Gets the SystemData.

Version

The version of the share.

Methods

AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Build(ProvisioningContext)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from Resource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from Resource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of FileShare.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing FileShare.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
GetResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
OverrideWithExpression(Expression)

Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs.

(Inherited from ProvisioningConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from Provisionable)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisioningConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Provisionable)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Resource)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Applies to