ファイル プロパティの取得
Get File Properties 操作は、すべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびファイルのシステム プロパティを返します。 ファイルの内容は返されません。
プロトコルの可用性
| 有効なファイル共有プロトコル | 使用可能 |
|---|---|
| SMB |
|
| NFS |
|
要求
Get File Properties 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> |
HTTP/1.1 |
次のように、要求 URI に表示されるパス コンポーネントを独自のパス コンポーネントに置き換えます。
| パス コンポーネント | 説明 |
|---|---|
myaccount |
ご利用のストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
mydirectorypath |
省略可能。 親ディレクトリへのパス。 |
myfile |
ファイルの名前です。 |
パスの名前付けの制限については、「 名前と参照共有、ディレクトリ、ファイル、およびメタデータ」を参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 説明 |
|---|---|
sharesnapshot |
省略可能。 バージョン 2017-04-17 以降。 パラメーターはsharesnapshot不透明な DateTime 値であり、存在する場合は、ファイル プロパティのクエリを実行する共有スナップショットを指定します。 |
timeout |
省略可能。
timeout パラメーターは、秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
| 承認 | 必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-lease-id:<ID> |
省略可能。 バージョン 2019-02-02 以降。 ヘッダーが指定されている場合、この操作は、ファイルのリースが現在アクティブであり、要求で指定されたリース ID がファイルのリース ID と一致する場合にのみ実行されます。 一致しない場合、操作は状態コード 412 (前提条件に失敗) で失敗します。 |
x-ms-client-request-id |
省略可能。 Azure Storage Analytics ログが有効になっているときに分析ログに記録される、1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 クライアント側のアクティビティをサーバーが受信した要求と関連付ける場合は、このヘッダーを使用することを強くお勧めします。 詳細については、「Azure Blob Storageの監視」を参照してください。 |
x-ms-file-request-intent |
ヘッダーが OAuth トークンを指定する場合 Authorization は必須です。 許容される値は です backup。 このヘッダーは、 ヘッダーをMicrosoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action使用してAuthorization承認された ID に割り当てられた RBAC ポリシーに 含まれている場合に、 または Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action を許可するように指定します。 バージョン 2022-11-02 以降で使用できます。 |
x-ms-allow-trailing-dot: { <Boolean> } |
省略可能。 バージョン 2022-11-02 以降。 ブール値は、要求 URL に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
要求本文
[なし] :
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
status code
操作に成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 説明 |
|---|---|
Last-Modified |
ファイルが最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダーの日付/時刻値を表す」を参照してください。 ファイルまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 |
x-ms-meta-name:value |
ユーザー定義メタデータとしてこのファイルに関連付けられている名前と値のペアのセット。 |
x-ms-type: <File> |
File 型を返します。 将来利用するために予約されています。 |
Content-Length |
ファイルのサイズ (バイト単位)。 このヘッダーは、ファイルと共に x-ms-content-length 格納されているヘッダーの値を返します。 |
Content-Type |
ファイルに対して指定されたコンテンツ タイプ。 コンテンツ タイプが指定されていない場合、既定のコンテンツ タイプは です application/octet-stream。 |
ETag |
ETag には、条件に基づく操作の実行に使用できる値が含まれます。 値は引用符で囲まれています。 |
Content-MD5 |
Content-MD5 ヘッダーがファイルに対して設定されている場合、クライアントがメッセージの内容の整合性をチェックできるように Content-MD5 応答ヘッダーが返されます。 |
Content-Encoding |
Content-Encoding 要求ヘッダーがファイルに対して設定されていた場合は、Content-Encoding の値がこのヘッダーで返されます。 |
Content-Language |
Content-Language 要求ヘッダーがファイルに対して設定されていた場合は、Content-Language の値がこのヘッダーで返されます。 |
Cache-Control |
Cache-Control 要求ヘッダーがファイルに対して設定されていた場合は、Cache-Control の値がこのヘッダーで返されます。 |
Content-Disposition |
x-ms-content-disposition ヘッダーに指定された値を返し、応答を処理する方法を指定します。応答ヘッダー フィールドは Content-Disposition 、応答ペイロードの処理方法に関する追加情報を伝達し、それを使用して追加のメタデータを添付できます。 たとえば、 が にattachmentContent-Disposition設定されている場合は、ユーザー エージェントは応答を表示しないが、代わりに [名前を付けて保存] ウィンドウが表示されることを示します。 |
x-ms-request-id |
作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されたサービス バージョンを示します。 |
Date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-copy-completion-time:<datetime> |
バージョン 2015-02-21 以降。 最後に試行した ファイルのコピー 操作の終了時刻。このファイルはコピー先ファイルでした。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。 コピーが保留中の場合、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合、このヘッダーは表示されません。 |
x-ms-copy-status-description: <error string> |
バージョン 2015-02-21 以降。
失敗または保留中の場合x-ms-copy-statusにのみ表示されます。 致命的または致命的でないコピー操作エラーの原因について説明します。 コピーが保留中の場合、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合、このヘッダーは表示されません。 |
x-ms-copy-id: <id> |
バージョン 2015-02-21 以降。 最後に試行した ファイルのコピー 操作の文字列識別子。このファイルはコピー先ファイルでした。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合や、ファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-progress: <bytes copied/bytes total> |
バージョン 2015-02-21 以降。 コピーされたバイト数と、このファイルがコピー先ファイルであった最後に試行された ファイルのコピー 操作のソース内の合計バイト数が含まれます。 0 からコピーしたバイト数を Content-Length 表示できます。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合や、ファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-source: url |
バージョン 2015-02-21 以降。 このファイルがコピー先ファイルであった最後に試行されたファイルの コピー 操作で使用されたソース ファイルを指定する最大 2 KB 文字の URL。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合や、ファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
バージョン 2015-02-21 以降。 で x-ms-copy-id識別されるコピー操作の状態と、次の値を指定します。- 成功： コピーが正常に完了しました。 - 保留 中： コピーが進行中です。 断続的で致命的でないエラーによってコピーの進行状況が妨げられたが、エラーが発生しないかどうかを確認 x-ms-copy-status-description します。- 中止： コピーは、コピー ファイルの中止によって終了しました。 - 失敗 しました： コピーに失敗しました。 エラーの詳細については、「 x-ms-copy-status-description」を参照してください。このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合や、ファイルのプロパティの設定またはファイルの作成を使用してファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-server-encrypted: true/false |
バージョン 2017-04-17 以降。 指定したアルゴリズムを true 使用してファイル データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は に設定されます。 ファイルが暗号化されていない場合、またはファイルまたはアプリケーション メタデータの一部のみが暗号化されている場合、値は に false 設定されます。 |
x-ms-file-permission-key |
バージョン 2019-02-02 以降。 ファイルのアクセス許可のキー。 |
x-ms-file-attributes |
バージョン 2019-02-02 以降。 ファイルのファイル システム属性。 詳細については、 使用可能な属性の一覧を参照してください。 |
x-ms-file-creation-time |
バージョン 2019-02-02 以降。 ファイルの作成時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-last-write-time |
バージョン 2019-02-02 以降。 ファイルの最後の書き込み時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-change-time |
バージョン 2019-02-02 以降。 ファイルの変更時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-file-id |
バージョン 2019-02-02 以降。 ファイルのファイル ID。 |
x-ms-file-parent-id |
バージョン 2019-02-02 以降。 ファイルの親ファイル ID。 |
x-ms-lease-duration:infinite |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、リースが無限の期間であることを指定します。 |
x-ms-lease-state:<available;leased;broken> |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、ファイルのリース状態を指定します。 |
x-ms-lease-status:<locked;unlocked> |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、ファイルのリース状態を指定します。 |
x-ms-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合は、応答に存在しません。 |
応答本文
[なし] :
応答のサンプル
Response Status:
HTTP/1.1 200 OK
Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked
承認
この操作を呼び出すことができるのはアカウント所有者のみです。