ファイルのプロパティを設定する
Set File Properties 操作は、ファイルのシステム プロパティを設定します。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用できる |
|---|---|
| SMB |
|
| NFS |
なし |
依頼
Set File Properties 要求は、次のように構築できます。 HTTPS を使用することをお勧めします。
| 方式 | 要求 URI | HTTP バージョン |
|---|---|---|
| 置く | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties |
HTTP/1.1 |
次のように、要求 URI に表示されているパス コンポーネントを独自のコンポーネントに置き換えます。
| パス コンポーネント | 形容 |
|---|---|
myaccount |
ストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
mydirectorypath |
随意。 親ディレクトリへのパス。 |
myfile |
ファイルの名前。 |
パスの名前付けの制限については、「名前と参照共有、ディレクトリ、ファイル、およびメタデータのを参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 形容 |
|---|---|
timeout |
随意。
timeout パラメーターは秒単位で表されます。 詳細については、「ファイル サービス操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 形容 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
Date または x-ms-date |
必須。 要求の世界協定時刻 (UTC) を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、Azure Storage サービスのバージョン管理の |
x-ms-cache-control |
随意。 ファイルのキャッシュ 制御文字列を変更します。 要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-type |
随意。 ファイルのコンテンツ タイプを設定します。 要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-md5 |
随意。 ファイルの MD5 ハッシュを設定します。 要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-encoding |
随意。 ファイルのコンテンツ エンコードを設定します。 要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-language |
随意。 ファイルのコンテンツ言語を設定します。 要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-disposition |
随意。 ファイルの Content-Disposition ヘッダーを設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。 ファイルプロパティの取得 に対する後続の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。 |
x-ms-content-length: bytes |
随意。 指定したサイズにファイルのサイズを変更します。 指定したバイト値がファイルの現在のサイズより小さい場合、指定したバイト値より上のすべての範囲がクリアされます。 |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
バージョン 2019-02-02 から 2021-04-10 では、x-ms-file-permission-key が指定されていない場合は、このヘッダーが必要です。 バージョン 2021-06-08 の時点では、両方のヘッダーは省略可能です。 このアクセス許可は、セキュリティ記述子定義言語 (SDDL) または (バージョン 2024-11-04 以降) base64 でエンコードされたバイナリ セキュリティ記述子形式で指定されたファイル セキュリティ記述子です。
x-ms-file-permission-format ヘッダーで使用する形式を指定できます。 このヘッダーは、アクセス許可のサイズが 8 kibibytes (KiB) 以下の場合に使用できます。 それ以外の場合は、x-ms-file-permission-keyを使用できます。 指定する場合は、所有者、グループ、および随意アクセス制御リスト (DACL)preserve の値を渡して、既存の値を変更しないようにすることができます。注意: x-ms-file-permission または x-ms-file-permission-keyを指定できます。 どちらのヘッダーも指定されていない場合は、preserve の既定値が使用されます。 |
x-ms-file-permission-format: { sddl ¦ binary } |
随意。 バージョン 2024-11-04 以降。
x-ms-file-permission で渡される値が SDDL 形式かバイナリ形式かを指定します。
x-ms-file-permission-key が preserveに設定されている場合は、このヘッダーを設定しないでください。
x-ms-file-permission-key が preserve以外の値に設定されていて、このヘッダーが設定されていない場合は、sddl の既定値が使用されます。 |
x-ms-file-permission-key: <PermissionKey> |
バージョン 2019-02-02 から 2021-04-10 では、x-ms-file-permission が指定されていない場合は、このヘッダーが必要です。 バージョン 2021-06-08 の時点では、両方のヘッダーは省略可能です。 ファイルに設定するアクセス許可のキー。 これは、Create-Permission API を使用して作成できます。注意: x-ms-file-permission または x-ms-file-permission-keyを指定できます。 どちらのヘッダーも指定されていない場合は、preserve の既定値が x-ms-file-permission ヘッダーに使用されます。 |
x-ms-file-attributes: { preserve ¦ <FileAttributeList> } |
必須、バージョン 2019-02-02 から 2021-04-10。 オプション、バージョン 2021-06-08 以降。 ファイルに設定するファイル システム属性。 使用可能な属性preserve の値を渡して、既存の値を変更しないようにすることができます。 既定値は preserveです。 |
x-ms-file-creation-time: { preserve ¦ <DateTime> } |
必須、バージョン 2019-02-02 から 2021-04-10。 オプション、バージョン 2021-06-08 以降。 ファイルの協定世界時 (UTC) の作成時刻プロパティ。
preserve の値を渡して、既存の値を変更しないようにすることができます。 既定値は preserveです。 |
x-ms-file-last-write-time: { preserve ¦ <DateTime> } |
必須、バージョン 2019-02-02 から 2021-04-10。 オプション、バージョン 2021-06-08 以降。 ファイルの協定世界時 (UTC) の最後の書き込みプロパティ。
preserve の値を渡して、既存の値を変更しないようにすることができます。
preserve を指定し、ファイルのサイズを変更すると、最後の書き込み時刻が現在の時刻に更新されます。 ファイルのサイズが変更されても、明示的なタイムスタンプが指定されている場合は、明示的なタイムスタンプが使用されます。 既定値は preserveです。 |
x-ms-lease-id: <ID> |
ファイルにアクティブなリースがある場合に必要です。 バージョン 2019-02-02 以降で使用できます。 |
x-ms-client-request-id |
随意。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Files」を参照してください。 |
x-ms-file-change-time: { now ¦ <DateTime> } |
随意。 バージョン 2021-06-08 以降。 ISO 8601 形式で書式設定されたファイルの協定世界時 (UTC) 変更時刻プロパティ。
now の値を使用して、要求の時刻を示すことができます。 既定値は nowです。 |
x-ms-file-request-intent |
ヘッダー Authorization OAuth トークンを指定する場合は必須です。 許容される値は backupです。 このヘッダーは、Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action または Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action が、Authorization ヘッダーを使用して承認された ID に割り当てられた RBAC ポリシーに含まれている場合に付与されるように指定します。 バージョン 2022-11-02 以降で使用できます。 |
x-ms-allow-trailing-dot: { <Boolean> } |
随意。 バージョン 2022-11-02 以降。 ブール値は、要求 URL に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
要求本文
何一つ。
応答
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
状態コード
操作が成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「状態コードとエラー コードを参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれます。 応答には、追加の標準 HTTP ヘッダーも含まれる場合があります。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 形容 |
|---|---|
ETag |
ファイルのバージョンを表す値を格納します。 値は引用符で囲まれています。 |
Last-Modified |
ファイルが最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「ヘッダーの日付/時刻値を表す」を参照してください。 ディレクトリまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 ファイルに対する操作は、ディレクトリの最終変更時刻には影響しません。 |
x-ms-request-id |
作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されるファイル サービスのバージョンを示します。 |
Date または x-ms-date |
サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。 |
x-ms-request-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-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、1,024 文字以下の ASCII 文字が含まれている場合、x-ms-client-request-id ヘッダーの値と同じです。
x-ms-client-request-id ヘッダーが要求に存在しない場合、応答には存在しません。 |
応答本文
何一つ。
認可
アカウント所有者のみがこの操作を呼び出すことができます。
ファイル システム属性
| 属性 | Win32 ファイル属性 | 定義 |
|---|---|---|
| ReadOnly | FILE_ATTRIBUTE_READONLY | 読み取り専用のファイル。 アプリケーションはファイルを読み取ることができますが、ファイルに書き込んだり削除したりすることはできません。 |
| 隠れた | FILE_ATTRIBUTE_HIDDEN | ファイルは非表示になっています。 通常のディレクトリ 一覧には含まれません。 |
| 制 | FILE_ATTRIBUTE_SYSTEM | オペレーティング システムが一部を使用するファイル、または排他的に使用するファイル。 |
| 何一つ | FILE_ATTRIBUTE_NORMAL | 他の属性が設定されていないファイル。 この属性は、単独で使用されている場合にのみ有効です。 |
| アーカイブ | FILE_ATTRIBUTE_ARCHIVE | アーカイブ ファイルであるファイル。 通常、アプリケーションではこの属性を使用して、バックアップまたは削除のためにファイルをマークします。 |
| 一時的 | FILE_ATTRIBUTE_TEMPORARY | 一時ストレージに使用されているファイル。 |
| オフライン | FILE_ATTRIBUTE_OFFLINE | ファイルのデータはすぐには使用できません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。 Azure Files では、オフライン ストレージ オプションはサポートされていません。 |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | ファイルは、コンテンツ インデックス 作成サービスによってインデックス付けされることはありません。 |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | ユーザー データ ストリームは、バックグラウンド データ整合性スキャナーによって読み取られることはありません。 このファイル システム属性は、主に Windows との互換性を提供するために表示されます。 |
備考
ファイルのプロパティを更新するためのセマンティクスは次のとおりです。
ファイルのサイズは、要求で
x-ms-content-lengthヘッダーの値が指定されている場合にのみ変更されます。要求が
x-ms-content-lengthのみを設定し、その他のプロパティを設定しない場合、ファイルの他のプロパティは変更されません。要求で次のプロパティのいずれかが 1 つ以上設定されている場合、これらのプロパティはすべてまとめて設定されます。 次のプロパティの少なくとも 1 つが設定されているときに、指定されたプロパティの値が指定されていない場合、そのプロパティはファイルに対してクリアされます。
x-ms-cache-controlx-ms-content-typex-ms-content-md5x-ms-content-encodingx-ms-content-language
手記
上記のファイル プロパティは、SMB クライアントで使用できるファイル システム のプロパティとは別です。 SMB クライアントは、これらのプロパティ値の読み取り、書き込み、または変更を行うことはできません。
Set File properties は、共有スナップショット (共有の読み取り専用コピー) ではサポートされていません。 共有スナップショットに対してこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します。
ファイルにアクティブなリースがある場合、クライアントは、ファイルにプロパティを書き込む要求で有効なリース ID を指定する必要があります。 クライアントがリース ID を指定しない場合、または無効なリース ID を指定した場合、File サービスは状態コード 412 (前提条件に失敗) を返します。 クライアントがリース ID を指定しても、ファイルにアクティブなリースがない場合、File サービスは状態コード 412 (前提条件に失敗) も返します。
関連項目
Azure Files に対する