Set File Properties

[アーティクル]
03/29/2023

Set File Properties 操作はファイルのシステムプロパティを設定します。

プロトコルの可用性

有効なファイル共有プロトコル	使用可能
SMB
NFS

要求

Set File Properties 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。

Method	要求 URI	HTTP バージョン
PUT	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties`	HTTP/1.1

次のように、要求 URI に示されたパスコンポーネントを独自の 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`	省略可能。ファイルのキャッシュ制御文字列を変更します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-type`	省略可能。ファイルのコンテンツの種類を設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-md5`	省略可能。ファイルの MD5 ハッシュを設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-encoding`	省略可能。ファイルのコンテンツのエンコードを設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-language`	省略可能。ファイルのコンテンツの言語を設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-disposition`	省略可能。ファイルのヘッダーを `Content-Disposition` 設定します。要求でこのプロパティが指定されていない場合、ファイルのプロパティはクリアされます。その後の Get File Properties の呼び出しでは、ファイルに対して明示的に設定されていない限り、このプロパティは返されません。
`x-ms-content-length: bytes`	省略可能。ファイルを指定したサイズに変更します。指定したバイト値がファイルの現在のサイズより小さい場合は、指定したバイト値より上のすべての範囲がクリアされます。
`x-ms-file-permission: { preserve ¦ <SDDL> }`	バージョン 2019-02-02 から 2021-04-10 では、が指定されていない場合 `x-ms-file-permission-key` は、このヘッダーが必要です。バージョン 2021-06-08 の時点では、両方のヘッダーは省略可能です。このアクセス許可は、セキュリティ記述子定義言語 (SDDL) で指定されたファイルのセキュリティ記述子です。アクセス許可のサイズが 8 kibibytes (KiB) 以下の場合は、このヘッダーを使用できます。それ以外の場合は、を使用 `x-ms-file-permission-key`できます。指定する場合は、所有者、グループ、随意アクセス制御リスト (DACL) が必要です。既存の値を変更せずに保持するには、の `preserve` 値を渡すことができます。注: または `x-ms-file-permission-key`のいずれかを`x-ms-file-permission`指定できます。どちらのヘッダーも指定しない場合は、の既定値 `preserve` が使用されます。
`x-ms-file-permission-key: <PermissionKey>`	バージョン 2019-02-02 から 2021-04-10 では、が指定されていない場合 `x-ms-file-permission` は、このヘッダーが必要です。バージョン 2021-06-08 の時点では、両方のヘッダーは省略可能です。ファイルに設定するアクセス許可のキー。これは、API を `Create-Permission` 使用して作成できます。注: または `x-ms-file-permission-key`のいずれかを`x-ms-file-permission`指定できます。どちらのヘッダーも指定しない場合は、の既定値 `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) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。詳細については、「Azure Filesの監視」を参照してください。
`x-ms-file-change-time: { now ¦ <DateTime> }`	省略可能。バージョン 2021-06-08 以降。 ISO 8601 形式で書式設定されたファイルの協定世界時 (UTC) 変更時刻プロパティ。の値 `now` を使用して、要求の時刻を示すことができます。既定値は `now` です。
`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 プロトコル仕様に準拠しています。

応答ヘッダー	説明
`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`	要求と対応する応答のトラブルシューティングに使用できます。このヘッダーの値 `x-ms-client-request-id` は、要求に存在し、値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値と同じです。ヘッダーが `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-control
- x-ms-content-type
- x-ms-content-md5
- x-ms-content-encoding
- x-ms-content-language

注意

上記のファイルプロパティは、SMB クライアントで使用できるファイルシステムプロパティとは別です。 SMB クライアントは、これらのプロパティ値の読み取り、書き込み、または変更を行うことはできません。

Set File propertiesは、共有の読み取り専用コピーである共有スナップショットではサポートされていません。共有スナップショットに対してこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します。

ファイルにアクティブなリースがある場合、クライアントは要求に対して有効なリース ID を指定して、ファイルにプロパティを書き込む必要があります。クライアントがリース ID を指定しない場合、または無効なリース ID を指定した場合、ファイルサービスは状態コード 412 (前提条件に失敗しました) を返します。クライアントがリース ID を指定しても、ファイルにアクティブなリースがない場合、ファイルサービスは状態コード 412 (前提条件に失敗しました) も返します。

こちらもご覧ください

Azure Filesに対する操作