ShareCreateOptions interface

パッケージ:

@azure/storage-file-share

作成操作を構成するオプション。

Extends

CommonOptions

プロパティ

abortSignal	操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 たとえば、@azure/abort-controller を使用して AbortSignalを作成します。
accessTier	共有のアクセス層を指定します。 使用可能な値は、'TransactionOptimized'、'Hot'、'Cool' です。
enableSnapshotVirtualDirectoryAccess	NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 指定しない場合、既定値は true です。
metadata	ファイル ストレージ オブジェクトに関連付ける名前と値のペア。
paidBurstingEnabled	オプション。 ブール値。 指定しない場合の既定値は false です。 このプロパティを使用すると、有料バーストが有効になります。
paidBurstingMaxBandwidthMibps	オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大スループットです。 ファイル共有の現在の最大値は 10,340 MiB/秒です。
paidBurstingMaxIops	オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大 IOPS です。 ファイル共有の現在の最大値は 102,400 IOPS です。
protocols	バージョン 2020-02-10 以降でサポートされています。 共有で有効なプロトコルを指定します。 指定しない場合、既定値は SMB です。
quota	共有の最大サイズをギガバイト単位で指定します。
rootSquash	共有に設定するルート スカッシュ。 NFS 共有に対してのみ有効です。 使用可能な値は、'NoRootSquash'、'RootSquash'、'AllSquash' です。
shareProvisionedBandwidthMibps	オプション。 バージョン 2025-01-05 以降でサポートされています。 プロビジョニングされた v2 ファイル共有に対してのみ許可されます。 共有のプロビジョニングされた帯域幅を 1 秒あたりのメビバイト単位 (MiBps) で指定します。 これが指定されていない場合、プロビジョニングされた帯域幅は、推奨事項の数式に基づいて計算された値に設定されます。
shareProvisionedIops	オプション。 バージョン 2025-01-05 以降でサポートされています。 プロビジョニングされた v2 ファイル共有に対してのみ許可されます。 共有の 1 秒あたりの入力/出力操作のプロビジョニング数 (IOPS) を指定します。 これが指定されていない場合、プロビジョニングされた IOPS は、推奨事項の数式に基づいて計算された値に設定されます。

継承されたプロパティ

tracingOptions

プロパティの詳細

abortSignal

操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 たとえば、@azure/abort-controller を使用して AbortSignalを作成します。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

accessTier

共有のアクセス層を指定します。 使用可能な値は、'TransactionOptimized'、'Hot'、'Cool' です。

accessTier?: ShareAccessTier

プロパティ値

ShareAccessTier

enableSnapshotVirtualDirectoryAccess

NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 指定しない場合、既定値は true です。

enableSnapshotVirtualDirectoryAccess?: boolean

プロパティ値

boolean

metadata

ファイル ストレージ オブジェクトに関連付ける名前と値のペア。

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

プロパティ値

{[propertyName: string]: string}

paidBurstingEnabled

オプション。 ブール値。 指定しない場合の既定値は false です。 このプロパティを使用すると、有料バーストが有効になります。

paidBurstingEnabled?: boolean

プロパティ値

boolean

paidBurstingMaxBandwidthMibps

オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大スループットです。 ファイル共有の現在の最大値は 10,340 MiB/秒です。

paidBurstingMaxBandwidthMibps?: number

プロパティ値

number

paidBurstingMaxIops

オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大 IOPS です。 ファイル共有の現在の最大値は 102,400 IOPS です。

paidBurstingMaxIops?: number

プロパティ値

number

protocols

バージョン 2020-02-10 以降でサポートされています。 共有で有効なプロトコルを指定します。 指定しない場合、既定値は SMB です。

protocols?: ShareProtocols

プロパティ値

ShareProtocols

quota

共有の最大サイズをギガバイト単位で指定します。

quota?: number

プロパティ値

number

rootSquash

共有に設定するルート スカッシュ。 NFS 共有に対してのみ有効です。 使用可能な値は、'NoRootSquash'、'RootSquash'、'AllSquash' です。

rootSquash?: ShareRootSquash

プロパティ値

ShareRootSquash

shareProvisionedBandwidthMibps

オプション。 バージョン 2025-01-05 以降でサポートされています。 プロビジョニングされた v2 ファイル共有に対してのみ許可されます。 共有のプロビジョニングされた帯域幅を 1 秒あたりのメビバイト単位 (MiBps) で指定します。 これが指定されていない場合、プロビジョニングされた帯域幅は、推奨事項の数式に基づいて計算された値に設定されます。

shareProvisionedBandwidthMibps?: number

プロパティ値

number

shareProvisionedIops

オプション。 バージョン 2025-01-05 以降でサポートされています。 プロビジョニングされた v2 ファイル共有に対してのみ許可されます。 共有の 1 秒あたりの入力/出力操作のプロビジョニング数 (IOPS) を指定します。 これが指定されていない場合、プロビジョニングされた IOPS は、推奨事項の数式に基づいて計算された値に設定されます。

shareProvisionedIops?: number

プロパティ値

number

継承されたプロパティの詳細

tracingOptions

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元CommonOptions.tracingOptions