Get File Properties操作は、ファイルのすべてのユーザー定義メタデータ、標準HTTPプロパティ、システムプロパティを返します。 ファイルの内容は返されません。 この操作は、NFS プロトコルが有効になっているファイル共有のバージョン 2025-05-05 以降でサポートされています。
プロトコルの可用性
| 有効なファイル共有プロトコル | Available |
|---|---|
| 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 に表示されるパス コンポーネントを独自のコンポーネントに置き換えます。
| パス コンポーネント | Description |
|---|---|
myaccount |
ご利用のストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
mydirectorypath |
このフィールドは省略可能です。 親ディレクトリへのパス。 |
myfile |
ファイルの名前。 |
パスネーミングの制限については、「 名前および参照共有、ディレクトリ、ファイル、メタデータ」をご覧ください。
URI パラメーター
リクエストURIに対して、以下の追加パラメータを指定できます:
| Parameter | Description |
|---|---|
sharesnapshot |
このフィールドは省略可能です。 バージョン 2017-04-17 以降。
sharesnapshotパラメータは不透明なDateTime値で、存在する場合、ファイルプロパティをクエリする共有スナップショットを指定します。 |
timeout |
このフィールドは省略可能です。
timeout パラメーターは秒単位で表されます。 詳細については、「 Azure Files Operationsのタイムアウト設定」をご覧ください。 |
リクエストヘッダー
必須および省略可能な要求ヘッダーについては、次の表で説明します。
共通要求ヘッダー
| リクエストヘッダー | Description |
|---|---|
| 許可 | Required. 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
Date または x-ms-date |
Required. 要求の世界協定時刻 (UTC) を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
x-ms-version |
許可されたすべての要求に必要です。 この要求に使用する操作のバージョンを指定します。 この操作は、NFS プロトコルが有効になっているファイル共有のバージョン 2025-05-05 以降でサポートされています。 詳細については、Azure Storage サービスのバージョン管理の |
x-ms-lease-id:<ID> |
このフィールドは省略可能です。 バージョン2019-02-02以降。 ヘッダーが指定されている場合、この操作はファイルのリースが現在有効で、リクエストで指定されたリースIDがファイルのリースIDと一致している場合にのみ実行されます。 一致しなければ、操作は失敗し、ステータスコードは412(前提条件失敗)となります。 このヘッダーは、ファイルが NFS プロトコルが有効になっているファイル共有上にあり、ファイルリースをサポートしていない場合は無視されます。 |
x-ms-client-request-id |
このフィールドは省略可能です。 クライアント生成の不透明な値を提供し、1キビバイト(KiB)文字制限があり、Azure Storage Analyticsログが有効になると分析ログに記録されます。 クライアント側のアクティビティとサーバーが受信するリクエストを関連付ける際には、このヘッダーの使用を強くお勧めします。 詳細については、「Monitor Azure Blob Storage」を参照してください。 |
x-ms-file-request-intent |
ヘッダー Authorization OAuth トークンを指定する場合は必須です。 許容される値は backupです。 このヘッダーは、Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ヘッダーを使用して承認された ID に割り当てられた RBAC ポリシーに含まれている場合、Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action または Authorization を付与するように指定します。 バージョン 2022-11-02 以降で使用できます。 |
x-ms-allow-trailing-dot: { <Boolean> } |
このフィールドは省略可能です。 バージョン 2022-11-02 以降。 ブール値は、要求 URL に存在する末尾のドットをトリミングするかどうかを指定します。 ターゲットが NFS プロトコルが有効なファイル共有上にある場合、このヘッダーは無視され、既定では末尾のドットがサポートされます。 詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
SMB のみの要求ヘッダー
None.
NFS 要求ヘッダーのみ
None.
リクエスト本文
None.
応答
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
ステータスコード
操作が成功すると、状態コード 200 (OK) が返されます。 状態コードの詳細については、「状態コードとエラー コードを参照してください。
応答ヘッダー
この操作の応答には、次の表のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーを含めることもできます。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。
一般的な応答ヘッダー
| 応答ヘッダー | Description |
|---|---|
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レスポンスヘッダーフィールドはレスポンスペイロードの処理方法に関する追加情報を伝え、追加のメタデータを付けることもできます。 例えば、 attachmentに設定されている場合、 Content-Disposition はユーザーエージェントが応答を表示すべきではなく、「保存する名前」ウィンドウを表示するべきだと示しています。 |
x-ms-request-id |
提出されたリクエストを一意に識別し、そのリクエストのトラブルシューティングに利用できます。 詳細については、「API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
リクエストを実行するために使用されたサービスバージョンを示します。 |
Date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-copy-completion-time:<datetime> |
バージョン2015-02-21以降。 このファイルが宛先ファイルである最後のコピー ファイル 操作の終了時間。 この値は、コピーの完了、中止、または失敗の時刻を指定できます。 コピーが保留中の場合、コピーファイル操作でそのファイルが一度も目的地でなかった場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には、このヘッダーは表示されません。 |
x-ms-copy-status-description: <error string> |
バージョン2015-02-21以降。
x-ms-copy-status
が失敗または保留中の場合にのみ表示されます。 致命的または非致命的なコピー作業の失敗の原因を記述しています。 コピーが保留中の場合、コピーファイル操作でそのファイルが一度も目的地でなかった場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には、このヘッダーは表示されません。 |
x-ms-copy-id: <id> |
バージョン2015-02-21以降。 このファイルが宛先ファイルである最後のコピー ファイル 操作の文字列識別子です。 このヘッダーは、このファイルがコピーファイル操作の宛先で一度も表示されたことがない場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には表示されません。 |
x-ms-copy-progress: <bytes copied/bytes total> |
バージョン2015-02-21以降。 このファイルが宛先ファイルだった最後のコピー操作でコピーされたバイト数と、送信元の合計バイト数を含みます。 0からコピーした Content-Length バイト数の間を表示できます。 このヘッダーは、このファイルがコピーファイル操作の宛先で一度も表示されたことがない場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には表示されません。 |
x-ms-copy-source: url |
バージョン2015-02-21以降。 最大2KB文字のURLで、最後に試みた コピーファイル 操作で使用されたソースファイルを指定します。このファイルが宛先ファイルでした。 サービスはSAS署名(sig)のみを削除し、その後このヘッダーを返します。 他のSASパラメータも残すことができます。 このヘッダーを使ってSAS認証情報を取得または再利用しないでください。 このヘッダーは、このファイルがコピーファイル操作の宛先で一度も表示されたことがない場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には表示されません。 |
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 を参照してください。このヘッダーは、このファイルがコピーファイル操作の宛先で一度も表示されたことがない場合、またはコピー操作終了後にSet File PropertiesやCreate Fileを使って変更された場合には表示されません。 |
x-ms-server-encrypted: true/false |
バージョン 2017-04-17 以降。 このヘッダーの値は、指定されたアルゴリズムを用いてファイルデータとアプリケーションメタデータが完全に暗号化されている場合に true に設定されます。 ファイルが暗号化されていない場合、またはファイルやアプリケーションのメタデータの一部のみが暗号化されている場合、値は false に設定されます。 |
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-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 ヘッダーが要求に存在しない場合、応答には存在しません。 |
SMB のみの応答ヘッダー
| 応答ヘッダー | Description |
|---|---|
x-ms-file-permission-key |
バージョン2019-02-02以降。 ファイルのアクセス許可のキー。 |
x-ms-file-attributes |
バージョン2019-02-02以降。 ファイルのファイル システム属性。 詳細については、使用可能な属性の一覧を参照してください。 |
NFS のみの応答ヘッダー
| 応答ヘッダー | Description |
|---|---|
x-ms-mode |
バージョン 2025-05-05 以降。 ファイルのモード。 POSIX ファイル アクセス許可 (モード)を参照してください。 |
x-ms-owner |
バージョン 2025-05-05 以降。 ファイル所有者のユーザー識別子 (UID)。 |
x-ms-group |
バージョン 2025-05-05 以降。 ファイル所有者のグループ識別子 (GID)。 |
x-ms-link-count |
バージョン 2025-05-05 以降。 ファイルのリンク数です。 |
x-ms-file-file-type |
バージョン 2025-05-05 以降。 ファイルの種類、可能な値は Regular、 Symlinkです。 |
応答本文
None.
サンプル応答
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
許可
この操作を呼び出すことができるのは、アカウント所有者だけです。
ファイル システム属性
| Attribute | Win32 ファイル属性 | Definition |
|---|---|---|
| ReadOnly | FILE_ATTRIBUTE_READONLY | 読み取り専用のファイル。 アプリケーションはファイルを読み取ることはできますが、書き込みや削除はできません。 |
| 非表示 | FILE_ATTRIBUTE_HIDDEN | ファイルは非表示になっています。 通常のディレクトリ 一覧には含まれません。 |
| System | FILE_ATTRIBUTE_SYSTEM | オペレーティング システムが一部を使用するファイル、または排他的に使用するファイル。 |
| None | FILE_ATTRIBUTE_NORMAL | 他の属性が設定されていないファイル。 この属性は、単独で使用されている場合にのみ有効です。 |
| Archive | FILE_ATTRIBUTE_ARCHIVE | アーカイブ ファイルであるファイル。 通常、アプリケーションではこの属性を使用して、バックアップまたは削除のためにファイルをマークします。 |
| Temporary | FILE_ATTRIBUTE_TEMPORARY | 一時ストレージに使用されているファイル。 |
| オフライン | FILE_ATTRIBUTE_OFFLINE | ファイルのデータはすぐには使用できません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。 Azure Filesはオフラインストレージオプションをサポートしていません。 |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | ファイルは、コンテンツ インデックス 作成サービスによってインデックス付けされることはありません。 |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | ユーザーデータストリームはバックグラウンドのデータ整合性スキャナーで読み取られるものではありません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。 |
POSIX ファイルのアクセス許可 (モード)
POSIX ファイルのアクセス許可は、12 ビット数値 8 進数形式またはシンボリック "rwx" 形式で数値で指定できます。 例 :
- "0644" または "rw-r--r--": ユーザー (ファイル所有者) に読み取り、書き込みアクセス許可があります。 グループには読み取りアクセス許可があります。 他のユーザーには読み取りアクセス許可があります。
- "0755" または "rwxr-xr-x": ユーザー (ファイル所有者) に読み取り、書き込み、実行のアクセス許可があります。 グループには読み取りと実行のアクセス許可があります。 他のユーザーには、読み取りと実行のアクセス許可があります。
数値の 8 進数形式
3 つの最下位の 8 進数は、所有者/ユーザー、グループなどのアクセス許可を表し、8 進数 (0 から 7) を使用して示されます。これは、ビットごとの組み合わせの '4' (読み取り)、'2' (書き込み)、'1' (実行) を使用して形成されます。 最上位の 8 進数 (0 から 7) は、'4' (SetUID)、'2' (SetGID)、'1' (StickyBit) のアクセス許可の組み合わせを示すために使用されます。
| Format | 許可 |
|---|---|
| 0700 | ユーザー (ファイル所有者) には、読み取り、書き込み、実行のアクセス許可があります。 |
| 0400 | ユーザーは読み取りアクセス許可を持っています。 |
| 0200 | ユーザーは書き込みアクセス許可を持っています。 |
| 0100 | ユーザーは実行アクセス許可を持っています。 |
| 0070 | グループには、読み取り、書き込み、実行のアクセス許可があります。 |
| 0040 | グループには読み取りアクセス許可があります。 |
| 0020 | グループには書き込みアクセス許可があります。 |
| 0010 | グループには実行アクセス許可があります。 |
| 0007 | 他のユーザーには、読み取り、書き込み、実行のアクセス許可があります。 |
| 0004 | 他のユーザーには読み取りアクセス許可があります。 |
| 0002 | 他のユーザーには書き込みアクセス許可があります。 |
| 0001 | 他のユーザーには実行アクセス許可があります。 |
| 4000 | ファイルに有効なユーザー ID を設定します。 |
| 2000 | ファイルに有効なグループ ID を設定します。 |
| 1000 | ファイルを削除または名前変更できるのは、ファイル所有者、ディレクトリ所有者、またはルート ユーザーのみであることを示すために設定します。 |
シンボリック "rwx" 形式
所有者/ユーザー、グループなどのアクセス許可は、'r' (読み取り)、'w' (書き込み)、および 'x' (実行) 文字の組み合わせを使用して示されます。
| Format | 許可 |
|---|---|
| rwx------ | ユーザー (ファイル所有者) には、読み取り、書き込み、実行のアクセス許可があります。 |
| r-------- | ユーザーは読み取りアクセス許可を持っています。 |
| -w------- | ユーザーは書き込みアクセス許可を持っています。 |
| --x------ | ユーザーは実行アクセス許可を持っています。 |
| ---rwx--- | グループには、読み取り、書き込み、実行のアクセス許可があります。 |
| ---r----- | グループには読み取りアクセス許可があります。 |
| ----w---- | グループには書き込みアクセス許可があります。 |
| -----x--- | グループには実行アクセス許可があります。 |
| ------rwx | 他のユーザーには、読み取り、書き込み、実行のアクセス許可があります。 |
| ------r-- | 他のユーザーには読み取りアクセス許可があります。 |
| -------w- | 他のユーザーには書き込みアクセス許可があります。 |
| --------x | 他のユーザーには実行アクセス許可があります。 |
参照
ファイル に対する 操作