設定檔案中繼資料
作業 Set File Metadata 會設定指定檔案的使用者定義中繼資料。
通訊協定可用性
| 已啟用檔案共用通訊協定 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
要求
您可以依照下列方式建構 Set File Metadata 要求。 建議您使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
以您自己的要求 URI 取代顯示在要求 URI 中的路徑元件，如下所示：
| 路徑元件 | Description |
|---|---|
myaccount |
儲存體帳戶的名稱。 |
myshare |
檔案共用的名稱。 |
mydirectorypath |
選擇性。 上層目錄的路徑。 |
myfile |
檔案的名稱。 |
如需路徑命名限制的詳細資訊，請參閱 名稱和參考共用、目錄、檔案和中繼資料。
URI 參數
您可以在要求 URI 中指定下列其他參數：
| 參數 | 描述 |
|---|---|
timeout |
選擇性。 timeout 參數以秒為單位。 如需詳細資訊，請參閱 設定檔案服務作業的逾時。 |
要求標頭
| 要求標頭 | 描述 |
|---|---|
Authorization |
必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
Date 或 x-ms-date |
必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
x-ms-version |
所有授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊，請參閱 Azure 儲存體服務的版本。 |
x-ms-meta-name:value |
選擇性。 設定檔案的名稱/值組。 每次呼叫這項作業都會取代附加至檔案的所有現有中繼資料。 若要從檔案中移除所有中繼資料，請呼叫這項作業，並且不使用中繼資料標頭。 中繼資料名稱必須遵守 C# 識別碼的命名規則。 |
x-ms-lease-id:<ID> |
如果檔案具有作用中的租用，則為必要專案。 適用于 2019-02-02 版和更新版本。 |
x-ms-client-request-id |
選擇性。 提供用戶端產生的不透明值，其中包含 1-kibibyte (KiB) 設定記錄時記錄在記錄中的字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器收到的要求相互關聯。 如需詳細資訊，請參閱監視Azure 檔案儲存體。 |
x-ms-file-request-intent |
如果 Authorization 標頭指定 OAuth 權杖，則為必要專案。 可接受的值為 backup 。 此標頭會 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 指定如果指派給使用 Authorization 標頭授權之身分識別的 RBAC 原則中包含 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action ，則應該授與 或 。 適用于 2022-11-02 版和更新版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
選擇性。 版本 2022-11-02 和更新版本。 布林值會指定是否應該修剪要求 URL 中的尾端點。 如需詳細資訊，請參閱 命名和參考共用、目錄、檔案和中繼資料。 |
要求本文
無。
回應
回應包括 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 |
可用來針對要求和對應的回應進行疑難排解。 如果標頭存在於要求中，此標頭的值等於標頭的值 x-ms-client-request-id ，且值不超過 1，024 個可見的 ASCII 字元。
x-ms-client-request-id如果標頭不存在於要求中，則不會出現在回應中。 |
回應本文
無。
授權
只有帳戶擁有者可呼叫這項作業。
備註
Set File Metadata 共用快照集不支援，這是共用的唯讀複本。 嘗試在共用快照集上執行此作業失敗， (InvalidQueryParameterValue)
如果檔案具有作用中的租用，用戶端必須在要求上指定有效的租用識別碼，才能將中繼資料寫入檔案。 如果用戶端未指定租用識別碼，或指定不正確租用識別碼，檔案服務會傳回狀態碼 412 (前置條件失敗) 。 如果用戶端指定租用識別碼，但檔案沒有作用中租用，則檔案服務也會傳回狀態碼 412 (前置條件失敗) 。