ShareCreateOptions interface

Package:

@azure/storage-file-share

Options to configure the create operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
accessTier	Specifies the access tier of the share. Possible values include: 'TransactionOptimized', 'Hot', 'Cool'
enableSnapshotVirtualDirectoryAccess	Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true.
metadata	A name-value pair to associate with a file storage object.
paidBurstingEnabled	Optional. Boolean. Default if not specified is false. This property enables paid bursting.
paidBurstingMaxBandwidthMibps	Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
paidBurstingMaxIops	Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
protocols	Supported in version 2020-02-10 and above. Specifies the enabled protocols on the share. If not specified, the default is SMB.
quota	Specifies the maximum size of the share, in gigabytes.
rootSquash	Root squash to set on the share. Only valid for NFS shares. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
shareProvisionedBandwidthMibps	Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula.
shareProvisionedIops	Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.

Inherited Properties

tracingOptions

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

accessTier

Specifies the access tier of the share. Possible values include: 'TransactionOptimized', 'Hot', 'Cool'

accessTier?: ShareAccessTier

Property Value

ShareAccessTier

enableSnapshotVirtualDirectoryAccess

Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true.

enableSnapshotVirtualDirectoryAccess?: boolean

Property Value

boolean

metadata

A name-value pair to associate with a file storage object.

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

paidBurstingEnabled

Optional. Boolean. Default if not specified is false. This property enables paid bursting.

paidBurstingEnabled?: boolean

Property Value

boolean

paidBurstingMaxBandwidthMibps

Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.

paidBurstingMaxBandwidthMibps?: number

Property Value

number

paidBurstingMaxIops

Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.

paidBurstingMaxIops?: number

Property Value

number

protocols

Supported in version 2020-02-10 and above. Specifies the enabled protocols on the share. If not specified, the default is SMB.

protocols?: ShareProtocols

Property Value

ShareProtocols

quota

Specifies the maximum size of the share, in gigabytes.

quota?: number

Property Value

number

rootSquash

Root squash to set on the share. Only valid for NFS shares. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.

rootSquash?: ShareRootSquash

Property Value

ShareRootSquash

shareProvisionedBandwidthMibps

Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula.

shareProvisionedBandwidthMibps?: number

Property Value

number

shareProvisionedIops

Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.

shareProvisionedIops?: number

Property Value

number

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions