ディレクトリのメタデータの設定

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

操作は Set Directory Metadata 、指定したディレクトリのユーザー定義メタデータを設定します。この操作は、バージョン 2015-02-21 以降で使用できます。

プロトコルの可用性

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

Request

Method	要求 URI	HTTP バージョン
PUT	`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`	すべての承認された要求に必要です。この要求に使用する操作のバージョンを指定します。この操作は、バージョン 2015-02-21 以降でのみ使用できます。詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
`x-ms-meta-name:value`	省略可能。ディレクトリの名前と値のペアを設定します。この操作を呼び出すと、その都度、ディレクトリに関連付けられている既存のメタデータがすべて置き換えられます。すべてのメタデータをディレクトリから削除するには、この操作をメタデータヘッダーなしで呼び出します。メタデータ名は、C# 識別子の名前付け規則に従う必要があります。
`x-ms-client-request-id`	省略可能。ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。詳細については、「Azure Filesの監視」を参照してください。
`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`	ディレクトリのバージョンを表す値を格納します。値は引用符で囲まれています。
`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` 要求に存在しない場合、応答には存在しません。

応答本文