設定檔案元數據
Set File Metadata 作業會設定指定檔案的用戶定義元數據。 啟用 NFS 通訊協定的檔案共用版本 2025-05-05 和更新版本支援這項作業。
通訊協定可用性
| 已啟用檔案共享通訊協定 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
請求
Set File Metadata 要求建構方式如下。 建議您使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
| 放 | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
將要求 URI 中顯示的路徑元件取代為您自己的路徑元件，如下所示：
| 路徑元件 | 描述 |
|---|---|
myaccount |
記憶體帳戶的名稱。 |
myshare |
檔案共享的名稱。 |
mydirectorypath |
自選。 父目錄的路徑。 |
myfile |
檔名。 |
如需路徑命名限制的相關信息，請參閱 名稱和參考共用、目錄、檔案和元數據。
URI 參數
您可以在要求 URI 中指定下列其他參數：
| 參數 | 描述 |
|---|---|
timeout |
自選。 timeout 參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定檔案服務作業逾時。 |
要求標頭
下表說明必要和選擇性的要求標頭：
常見的要求標頭
| 要求標頭 | 描述 |
|---|---|
Authorization |
必填。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱 授權對 Azure 記憶體的要求。 |
Date 或 x-ms-date |
必填。 指定要求的國際標準時間（UTC）。 如需詳細資訊，請參閱 授權對 Azure 記憶體的要求。 |
x-ms-version |
所有已授權要求的必要專案。 指定要用於此要求的作業版本。 啟用 NFS 通訊協定的檔案共用版本 2025-05-05 和更新版本支援這項作業。 如需詳細資訊，請參閱 Azure 記憶體服務的版本設定。 |
x-ms-meta-name:value |
自選。 設定檔案的名稱/值組。 對這項作業的每個呼叫都會取代附加至檔案的所有現有元數據。 若要從檔案中移除所有元數據，請呼叫不含元數據標頭的這項作業。 中繼資料名稱必須遵循 C# 識別子的命名規則，。 |
x-ms-lease-id:<ID> |
如果檔案具有使用中租用，則為必要專案。 適用於 2019-02-02 版和更新版本。 如果檔案位於已啟用 NFS 通訊協定的檔案共用上，則忽略此標頭，這不支援檔案租用。 |
x-ms-client-request-id |
自選。 提供客戶端產生的不透明值，其中包含設定記錄時記錄的 1-kibibyte （KiB） 字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊，請參閱 監視 Azure 檔案服務。 |
x-ms-file-request-intent |
如果 Authorization 標頭指定 OAuth 令牌，則為必要項。 可接受的值為 backup。 如果 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 包含在指派給使用 Authorization 標頭授權的身分識別中，則此標頭指定應授與 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action。 適用於 2022-11-02 版和更新版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
自選。 版本 2022-11-02 和更新版本。 布爾值會指定是否應該修剪要求 URL 中的尾端點。 如果目標位於已啟用 NFS 通訊協定的檔案共用上，預設支援尾端點，則會忽略此標頭。 如需詳細資訊，請參閱 命名和參考共用、目錄、檔案和元資料。 |
僅限SMB要求標頭
沒有。
僅限 NFS 要求標頭
沒有。
要求本文
沒有。
回應
回應包含 HTTP 狀態代碼和一組響應標頭。
狀態代碼
成功的作業會傳回狀態代碼 200 （確定）。 如您需狀態代碼的相關資訊，請參閱 狀態和錯誤碼。
回應標頭
此作業的回應包含下表中的標頭。 回應也可能包含額外的標準 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 標頭，它就不會出現在回應中。 |
僅限SMB回應標頭
沒有。
僅限 NFS 回應標頭
沒有。
回應本文
沒有。
授權
只有帳戶擁有者可以呼叫這項作業。
言論
共用快照集不支援 Set File Metadata，這是共用的唯讀複本。 嘗試在共用快照集上執行這項作業失敗，並出現 400 （InvalidQueryParameterValue）
如果檔案具有使用中租用，客戶端必須在要求上指定有效的租用標識碼，才能將元數據寫入檔案。 如果用戶端未指定租用標識碼，或指定無效的租用標識符，則檔案服務會傳回狀態代碼 412 （前置條件失敗）。 如果用戶端指定租用標識碼，但檔案沒有使用中租用，則檔案服務也會傳回狀態代碼 412（前置條件失敗）。
另請參閱
檔案 上的 作業