次の方法で共有

FileGetPropertiesHeaders interface

  • リファレンス
パッケージ:
@azure/storage-file-share

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

プロパティ

cacheControl

Cache-Control要求ヘッダーがファイルに対して以前に設定されている場合は、このヘッダーにCache-Control値が返されます。
contentDisposition

'x-ms-content-disposition' ヘッダーに指定された値を返し、応答の処理方法を指定します。
contentEncoding

ファイルに対して Content-Encoding 要求ヘッダーが以前に設定されている場合は、このヘッダーに Content-Encoding 値が返されます。
contentLanguage

Content-Language 要求ヘッダーに指定された値を返します。
contentLength

ファイルのサイズ (バイト単位)。 このヘッダーは、ファイルと共に格納されている 'x-ms-content-length' ヘッダーの値を返します。
contentMD5

ファイルに Content-MD5 ヘッダーが設定されている場合は、クライアントがメッセージ コンテンツの整合性を確認できるように、Content-MD5 応答ヘッダーが返されます。
contentType

ファイルに対して指定されたコンテンツの種類。 既定のコンテンツ タイプは 'application/octet-stream' です
copyCompletedOn

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作の終了時刻。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。
copyId

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作の文字列識別子。
copyProgress

コピーされたバイト数と、このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作のソース内の合計バイト数を格納します。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。
copySource

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作で使用されたソース ファイルを指定する最大 2 KB の URL。
copyStatus

'x-ms-copy-id' で識別されるコピー操作の状態。
copyStatusDescription

x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 コピー操作の致命的なエラーまたは致命的ではないエラーの原因を示します。
date

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

エラー コード
etag

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

ファイルに設定された属性。
fileChangeOn

ファイルの時刻を変更します。
fileCreatedOn

ファイルの作成時刻。
fileId

ファイルの fileId。
fileLastWriteOn

ファイルの最終書き込み時刻。
fileParentId

ファイルの親 fileId。
filePermissionKey

ファイルのアクセス許可セットのキー。
fileType

File 型を返します。 将来利用するために予約されています。
isServerEncrypted

指定したアルゴリズムを使用してファイル データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は true に設定されます。 それ以外の場合、値は false に設定されます (ファイルが暗号化されていない場合、またはファイル/アプリケーション メタデータの一部のみが暗号化されている場合)。
lastModified

ファイルが最後に更新された日時を返します。 日付形式は RFC 1123 に従います。 ファイルまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。
leaseDuration

ファイルがリースされるときに、リース期間が無限か固定期間かを指定します。
leaseState

ファイルのリース状態。
leaseStatus

ファイルの現在のリース状態。
metadata

このファイルにユーザー定義メタデータとして関連付けられた名前と値のペアのセット。
requestId

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

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

プロパティの詳細

cacheControl

Cache-Control要求ヘッダーがファイルに対して以前に設定されている場合は、このヘッダーにCache-Control値が返されます。

cacheControl?: string

プロパティ値

string

contentDisposition

'x-ms-content-disposition' ヘッダーに指定された値を返し、応答の処理方法を指定します。

contentDisposition?: string

プロパティ値

string

contentEncoding

ファイルに対して Content-Encoding 要求ヘッダーが以前に設定されている場合は、このヘッダーに Content-Encoding 値が返されます。

contentEncoding?: string

プロパティ値

string

contentLanguage

Content-Language 要求ヘッダーに指定された値を返します。

contentLanguage?: string

プロパティ値

string

contentLength

ファイルのサイズ (バイト単位)。 このヘッダーは、ファイルと共に格納されている 'x-ms-content-length' ヘッダーの値を返します。

contentLength?: number

プロパティ値

number

contentMD5

ファイルに Content-MD5 ヘッダーが設定されている場合は、クライアントがメッセージ コンテンツの整合性を確認できるように、Content-MD5 応答ヘッダーが返されます。

contentMD5?: Uint8Array

プロパティ値

Uint8Array

contentType

ファイルに対して指定されたコンテンツの種類。 既定のコンテンツ タイプは 'application/octet-stream' です

contentType?: string

プロパティ値

string

copyCompletedOn

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作の終了時刻。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。

copyCompletedOn?: Date

プロパティ値

Date

copyId

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作の文字列識別子。

copyId?: string

プロパティ値

string

copyProgress

コピーされたバイト数と、このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作のソース内の合計バイト数を格納します。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。

copyProgress?: string

プロパティ値

string

copySource

このファイルがコピー先ファイルであった最後に試行されたファイルのコピー操作で使用されたソース ファイルを指定する最大 2 KB の URL。

copySource?: string

プロパティ値

string

copyStatus

'x-ms-copy-id' で識別されるコピー操作の状態。

copyStatus?: CopyStatusType

プロパティ値

CopyStatusType

copyStatusDescription

x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 コピー操作の致命的なエラーまたは致命的ではないエラーの原因を示します。

copyStatusDescription?: string

プロパティ値

string

date

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

date?: Date

プロパティ値

Date

errorCode

エラー コード

errorCode?: string

プロパティ値

string

etag

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

etag?: string

プロパティ値

string

fileAttributes

ファイルに設定された属性。

fileAttributes?: string

プロパティ値

string

fileChangeOn

ファイルの時刻を変更します。

fileChangeOn?: Date

プロパティ値

Date

fileCreatedOn

ファイルの作成時刻。

fileCreatedOn?: Date

プロパティ値

Date

fileId

ファイルの fileId。

fileId?: string

プロパティ値

string

fileLastWriteOn

ファイルの最終書き込み時刻。

fileLastWriteOn?: Date

プロパティ値

Date

fileParentId

ファイルの親 fileId。

fileParentId?: string

プロパティ値

string

filePermissionKey

ファイルのアクセス許可セットのキー。

filePermissionKey?: string

プロパティ値

string

fileType

File 型を返します。 将来利用するために予約されています。

fileType?: string

プロパティ値

string

isServerEncrypted

指定したアルゴリズムを使用してファイル データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は true に設定されます。 それ以外の場合、値は false に設定されます (ファイルが暗号化されていない場合、またはファイル/アプリケーション メタデータの一部のみが暗号化されている場合)。

isServerEncrypted?: boolean

プロパティ値

boolean

lastModified

ファイルが最後に更新された日時を返します。 日付形式は RFC 1123 に従います。 ファイルまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。

lastModified?: Date

プロパティ値

Date

leaseDuration

ファイルがリースされるときに、リース期間が無限か固定期間かを指定します。

leaseDuration?: LeaseDurationType

プロパティ値

LeaseDurationType

leaseState

ファイルのリース状態。

leaseState?: LeaseStateType

プロパティ値

LeaseStateType

leaseStatus

ファイルの現在のリース状態。

leaseStatus?: LeaseStatusType

プロパティ値

LeaseStatusType

metadata

このファイルにユーザー定義メタデータとして関連付けられた名前と値のペアのセット。

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

プロパティ値

{[propertyName: string]: string}

requestId

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

requestId?: string

プロパティ値

string

version

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

version?: string

プロパティ値

string