ShareCreateOptions interface
Options to configure the create operation.
- Extends
Properties
abort |
An implementation of the |
access |
Specifies the access tier of the share. Possible values include: 'TransactionOptimized', 'Hot', 'Cool' |
enable |
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. |
paid |
Optional. Boolean. Default if not specified is false. This property enables paid bursting. |
paid |
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. |
paid |
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. |
root |
Root squash to set on the share. Only valid for NFS shares. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'. |
Inherited Properties
tracing |
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
accessTier
Specifies the access tier of the share. Possible values include: 'TransactionOptimized', 'Hot', 'Cool'
accessTier?: ShareAccessTier
Property Value
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
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