Package version:

Interface ShareCreateOptions

Options to configure the ShareClient.create operation.

interface ShareCreateOptions {
    abortSignal?: any;
    accessTier?: ShareAccessTier;
    enableSnapshotVirtualDirectoryAccess?: boolean;
    metadata?: {
        [propertyName: string]: string;
    };
    paidBurstingEnabled?: boolean;
    paidBurstingMaxBandwidthMibps?: number;
    paidBurstingMaxIops?: number;
    protocols?: ShareProtocols;
    quota?: number;
    rootSquash?: ShareRootSquash;
    shareProvisionedBandwidthMibps?: number;
    shareProvisionedIops?: number;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? accessTier? enableSnapshotVirtualDirectoryAccess? metadata? paidBurstingEnabled? paidBurstingMaxBandwidthMibps? paidBurstingMaxIops? protocols? quota? rootSquash? shareProvisionedBandwidthMibps? shareProvisionedIops? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalaccessTier

accessTier?: ShareAccessTier

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

OptionalenableSnapshotVirtualDirectoryAccess

enableSnapshotVirtualDirectoryAccess?: boolean

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.

Optionalmetadata

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

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

OptionalpaidBurstingEnabled

paidBurstingEnabled?: boolean

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

OptionalpaidBurstingMaxBandwidthMibps

paidBurstingMaxBandwidthMibps?: number

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.

OptionalpaidBurstingMaxIops

paidBurstingMaxIops?: number

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.

Optionalprotocols

protocols?: ShareProtocols

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

Optionalquota

quota?: number

Specifies the maximum size of the share, in gigabytes.

OptionalrootSquash

rootSquash?: ShareRootSquash

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

OptionalshareProvisionedBandwidthMibps

shareProvisionedBandwidthMibps?: number

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.

OptionalshareProvisionedIops

shareProvisionedIops?: number

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.

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility