ディレクトリ メタデータの設定
Set Directory Metadata 操作は、指定したディレクトリのユーザー定義メタデータを設定します。 この操作は、SMB プロトコルが有効なファイル共有ではバージョン 2015-02-21 以降でサポートされ、NFS プロトコルが有効なファイル共有ではバージョン 2025-05-05 以降でサポートされています。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用できる |
|---|---|
| SMB |
|
| NFS |
|
依頼
Set Directory Metadata 要求は次のように構成されます。 HTTPS を使用することをお勧めします。
| 方式 | 要求 URI | HTTP バージョン |
|---|---|---|
| 置く | https://myaccount.file.core.windows.net/myshare/ myparentdirectorypath/mydirectory?restype=directory& comp=metadata |
HTTP/1.1 |
次のように、要求 URI に表示されるパス コンポーネントを独自のコンポーネントに置き換えます。
| パス コンポーネント | 形容 |
|---|---|
myaccount |
ストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
myparentdirectorypath |
随意。 親ディレクトリへのパス。 |
mydirectory |
ディレクトリの名前。 |
パスの名前付けの制限については、「名前と参照共有、ディレクトリ、ファイル、およびメタデータのを参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 形容 |
|---|---|
timeout |
随意。
timeout パラメーターは秒単位で表されます。 詳細については、「ファイル サービス操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須および省略可能な要求ヘッダーについては、次の表で説明します。
一般的な要求ヘッダー
| 要求ヘッダー | 形容 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
Date または x-ms-date |
必須。 要求の世界協定時刻 (UTC) を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 この操作は、SMB プロトコルが有効なファイル共有ではバージョン 2015-02-21 以降でサポートされ、NFS プロトコルが有効なファイル共有ではバージョン 2025-05-05 以降でサポートされています。 詳細については、Azure Storage サービス のバージョン管理のに関するページを参照してください。 |
x-ms-meta-name:value |
随意。 ディレクトリの名前と値のペアを設定します。 この操作を呼び出すたびに、ディレクトリにアタッチされているすべての既存のメタデータが置き換えられます。 ディレクトリからすべてのメタデータを削除するには、メタデータ ヘッダーなしでこの操作を呼び出します。 メタデータ名は、C# 識別子の名前付け規則に従う必要があります。 |
x-ms-client-request-id |
随意。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Files」を参照してください。 |
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 に存在する末尾のドットをトリミングするかどうかを指定します。 ターゲットが NFS プロトコルが有効なファイル共有上にある場合、このヘッダーは無視され、既定では末尾のドットがサポートされます。 詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
SMB のみの要求ヘッダー
何一つ。
NFS 要求ヘッダーのみ
何一つ。
要求本文
何一つ。
応答
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
状態コード
操作が成功すると、状態コード 200 (OK) が返されます。 状態コードの詳細については、「状態コードとエラー コードを参照してください。
応答ヘッダー
この操作の応答には、次の表のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーも含まれる場合があります。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。
一般的な応答ヘッダー
| 応答ヘッダー | 形容 |
|---|---|
ETag |
ディレクトリのバージョンを表す値を格納します。 値は引用符で囲まれています。 |
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-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、1,024 文字以下の ASCII 文字が含まれている場合、x-ms-client-request-id ヘッダーの値と同じです。
x-ms-client-request-id ヘッダーが要求に存在しない場合、応答には存在しません。 |
SMB のみの応答ヘッダー
何一つ。
NFS のみの応答ヘッダー
何一つ。
応答本文
何一つ。
認可
アカウント所有者のみがこの操作を呼び出すことができます。
備考
Set Directory Metadata は、共有スナップショット (共有の読み取り専用コピー) ではサポートされていません。 共有スナップショットに対してこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します。
関連項目
ディレクトリ に対する 操作