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

  • [アーティクル]

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

プロトコルの可用性

有効なファイル共有プロトコル 利用できる
SMB はい
NFS なし

依頼

Set Directory Properties 要求は、次のように構築できます。 HTTPS を使用することをお勧めします。

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

次のように、要求 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> ¦ <binary> } バージョン 2019-02-02 から 2021-04-10 では、x-ms-file-permission-key が指定されていない場合は、このヘッダーが必要です。 バージョン 2021-06-08 の時点では、両方のヘッダーは省略可能です。 このアクセス許可は、セキュリティ記述子定義言語 (SDDL) または base64 でエンコードされたバイナリ セキュリティ記述子形式 (バージョン 2024-11-04 以降) で指定されたディレクトリ セキュリティ記述子。 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 ヘッダーに使用されます。
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です。
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_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 を呼び出す必要があります。

関連項目

ディレクトリ に対する 操作