ディレクトリプロパティの設定

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

操作は、 Set Directory Properties 指定したディレクトリのシステムプロパティを設定します。この API は、バージョン 2019-02-02 の時点で使用できます。

プロトコルの可用性

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

要求

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

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

次のように、要求 URI に示されたパスコンポーネントを独自の URI に置き換えます。

パスコンポーネント	説明
`myaccount`	ご利用のストレージアカウントの名前。
`myshare`	ファイル共有の名前。
`mydirectorypath`	省略可能。親ディレクトリへのパス。
`mydirectory`	ファイルの名前です。

パスの名前付けの制限については、「名前と参照共有、ディレクトリ、ファイル、およびメタデータ」を参照してください。

URI パラメーター

要求 URI には、次の追加パラメーターを指定できます。

パラメーター	説明
`timeout`	省略可能。 `timeout` パラメーターは、秒単位で表されます。詳細については、「ファイルサービス操作のタイムアウトを設定する」を参照してください。

要求ヘッダー

必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求ヘッダー	説明
`Authorization`	必須。承認スキーム、アカウント名、署名を指定します。詳細については、「Azure Storage への要求を承認する」をご覧ください。
`Date` または `x-ms-date`	必須。要求に対して協定世界時 (UTC) を指定します。詳細については、「Azure Storage への要求を承認する」をご覧ください。
`x-ms-version`	すべての承認された要求に必要です。この要求に使用する操作のバージョンを指定します。詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
`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` 使用されます。
`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` です。
`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_DIRECTORY	ディレクトリを識別するハンドル。
アーカイブ	FILE_ATTRIBUTE_ARCHIVE	アーカイブディレクトリであるディレクトリ。通常、アプリケーションでは、この属性を使用して、バックアップまたは削除のためにファイルをマークします。
オフライン	FILE_ATTRIBUTE_OFFLINE	ディレクトリのデータはすぐには使用できません。このファイルシステム属性は、主に Windows との互換性を提供するために表示されます。 Azure Filesでは、オフラインストレージオプションはサポートされていません。
NotContentIndexed	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED	ディレクトリは、コンテンツインデックス作成サービスによってインデックス付けされません。
NoScrubData	FILE_ATTRIBUTE_NO_SCRUB_DATA	ユーザーデータストリームは、バックグラウンドデータ整合性スキャナーで読み取られるわけではありません。このファイルシステム属性は、主に Windows との互換性を提供するために表示されます。

注釈

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

を持つ Set Directory Properties ディレクトリに設定されたプロパティは、そのディレクトリの下のサブディレクトリには反映されません。プロパティを更新するディレクトリごとにを呼び出 Set Directory Properties す必要があります。

こちらもご覧ください

ディレクトリでの操作

ディレクトリ プロパティの設定