ShareGetPropertiesHeaders interface

パッケージ:

@azure/storage-file-share

Share_getProperties操作のヘッダーを定義します。

プロパティ

accessTier	共有に設定されているアクセス層を返します。
accessTierChangeTime	共有のアクセス層の最終変更時刻 (UTC) を返します。
accessTierTransitionState	アクセス層間の遷移状態 (存在する場合) を返します。
date	応答が開始された時刻を示すサービスによって生成された UTC 日付/時刻値。
enabledProtocols	共有で有効になっているプロトコル。
enableSnapshotVirtualDirectoryAccess	バージョン 2023-08-03 以降。 NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 このヘッダーは、スナップショットではなく共有に対してのみ返されます。
errorCode	エラー コード
etag	ETag には、条件付きで操作を実行するために使用できる値が引用符で囲まれています。
includedBurstIops	共有の計算されたバースト IOPS を返します。
lastModified	共有が最後に変更された日時を返します。 共有またはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 ファイルに対する操作は、共有の最終変更時刻には影響しません。
leaseDuration	共有がリースされるときに、リースの期間が無限か固定かを指定します。
leaseState	共有のリース状態。
leaseStatus	共有の現在のリース状態。
maxBurstCreditsForIops	計算された最大バースト クレジットを返しました。 これは現在のバースト クレジット レベルではありませんが、共有で使用できる最大バースト クレジットです。
metadata	共有のユーザー定義メタデータを含む名前と値のペアのセット。
nextAllowedProvisionedBandwidthDowngradeTime	現在の共有で次に許可されているプロビジョニングされた帯域幅のダウングレード時間を返します。
nextAllowedProvisionedIopsDowngradeTime	現在の共有の次に許可されているプロビジョニングされた iops ダウングレード時間を返します。
nextAllowedQuotaDowngradeTime	現在の共有の次に許可されているクォータのダウングレード時間を返します。
paidBurstingEnabled	オプション。 ブール値。 指定しない場合の既定値は false です。 このプロパティを使用すると、有料バーストが有効になります。
paidBurstingMaxBandwidthMibps	オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大スループットです。 ファイル共有の現在の最大値は 10,340 MiB/秒です。
paidBurstingMaxIops	オプション。 整数。 指定しない場合の既定値は、ファイル共有でサポートできる最大 IOPS です。 ファイル共有の現在の最大値は 102,400 IOPS です。
provisionedBandwidthMibps	現在の共有プロビジョニング帯域幅を 1 秒あたりメビバイト単位で返します。
provisionedEgressMBps	現在の共有によってプロビジョニングされたエグレスをメガバイト/秒で返します。
provisionedIngressMBps	現在の共有によってプロビジョニングされたイングレスをメガバイト/秒で返します。
provisionedIops	現在プロビジョニングされている共有 ipos を返します。
quota	現在の共有クォータを GB 単位で返します。
requestId	このヘッダーは、作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。
rootSquash	NFS 共有にのみ有効です。
version	要求の実行に使用されるファイル サービスのバージョンを示します。

プロパティの詳細

accessTier

共有に設定されているアクセス層を返します。

accessTier?: string

プロパティ値

string

accessTierChangeTime

共有のアクセス層の最終変更時刻 (UTC) を返します。

accessTierChangeTime?: Date

プロパティ値

Date

accessTierTransitionState

アクセス層間の遷移状態 (存在する場合) を返します。

accessTierTransitionState?: string

プロパティ値

string

date

応答が開始された時刻を示すサービスによって生成された UTC 日付/時刻値。

date?: Date

プロパティ値

Date

enabledProtocols

共有で有効になっているプロトコル。

enabledProtocols?: string

プロパティ値

string

enableSnapshotVirtualDirectoryAccess

バージョン 2023-08-03 以降。 NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 このヘッダーは、スナップショットではなく共有に対してのみ返されます。

enableSnapshotVirtualDirectoryAccess?: boolean

プロパティ値

boolean

errorCode

エラー コード

errorCode?: string

プロパティ値

string

etag

ETag には、条件付きで操作を実行するために使用できる値が引用符で囲まれています。

etag?: string

プロパティ値

string

includedBurstIops

共有の計算されたバースト IOPS を返します。

includedBurstIops?: number

プロパティ値

number

lastModified

共有が最後に変更された日時を返します。 共有またはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 ファイルに対する操作は、共有の最終変更時刻には影響しません。

lastModified?: Date

プロパティ値

Date

leaseDuration

共有がリースされるときに、リースの期間が無限か固定かを指定します。

leaseDuration?: LeaseDurationType

プロパティ値

LeaseDurationType

leaseState

共有のリース状態。

leaseState?: LeaseStateType

プロパティ値

LeaseStateType

leaseStatus

共有の現在のリース状態。

leaseStatus?: LeaseStatusType

プロパティ値

LeaseStatusType

maxBurstCreditsForIops

計算された最大バースト クレジットを返しました。 これは現在のバースト クレジット レベルではありませんが、共有で使用できる最大バースト クレジットです。

maxBurstCreditsForIops?: number

プロパティ値

number

metadata

共有のユーザー定義メタデータを含む名前と値のペアのセット。

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

プロパティ値

{[propertyName: string]: string}

nextAllowedProvisionedBandwidthDowngradeTime

現在の共有で次に許可されているプロビジョニングされた帯域幅のダウングレード時間を返します。

nextAllowedProvisionedBandwidthDowngradeTime?: Date

プロパティ値

Date

nextAllowedProvisionedIopsDowngradeTime

現在の共有の次に許可されているプロビジョニングされた iops ダウングレード時間を返します。

nextAllowedProvisionedIopsDowngradeTime?: Date

プロパティ値

Date

nextAllowedQuotaDowngradeTime

現在の共有の次に許可されているクォータのダウングレード時間を返します。

nextAllowedQuotaDowngradeTime?: Date

プロパティ値

Date

paidBurstingEnabled

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

paidBurstingEnabled?: boolean

プロパティ値

boolean

paidBurstingMaxBandwidthMibps

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

paidBurstingMaxBandwidthMibps?: number

プロパティ値

number

paidBurstingMaxIops

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

paidBurstingMaxIops?: number

プロパティ値

number

provisionedBandwidthMibps

現在の共有プロビジョニング帯域幅を 1 秒あたりメビバイト単位で返します。

provisionedBandwidthMibps?: number

プロパティ値

number

provisionedEgressMBps

現在の共有によってプロビジョニングされたエグレスをメガバイト/秒で返します。

provisionedEgressMBps?: number

プロパティ値

number

provisionedIngressMBps

現在の共有によってプロビジョニングされたイングレスをメガバイト/秒で返します。

provisionedIngressMBps?: number

プロパティ値

number

provisionedIops

現在プロビジョニングされている共有 ipos を返します。

provisionedIops?: number

プロパティ値

number

quota

現在の共有クォータを GB 単位で返します。

quota?: number

プロパティ値

number

requestId

このヘッダーは、作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。

requestId?: string

プロパティ値

string

rootSquash

NFS 共有にのみ有効です。

rootSquash?: ShareRootSquash

プロパティ値

ShareRootSquash

version

要求の実行に使用されるファイル サービスのバージョンを示します。

version?: string

プロパティ値

string