設定檔案屬性
Set File Properties 作業會在檔案上設定系統屬性。
通訊協定可用性
| 已啟用檔案共享通訊協定 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
請求
Set File Properties 要求可能建構如下。 建議您使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
| 放 | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties |
HTTP/1.1 |
以您自己的方式取代要求 URI 中顯示的路徑元件，如下所示：
| 路徑元件 | 描述 |
|---|---|
myaccount |
記憶體帳戶的名稱。 |
myshare |
檔案共享的名稱。 |
mydirectorypath |
自選。 父目錄的路徑。 |
myfile |
檔名。 |
如需路徑命名限制的相關信息，請參閱 名稱和參考共用、目錄、檔案和元數據。
URI 參數
您可以在要求 URI 中指定下列其他參數：
| 參數 | 描述 |
|---|---|
timeout |
自選。
timeout 參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定檔案服務作業逾時。 |
要求標頭
下表說明必要和選擇性的要求標頭：
| 要求標頭 | 描述 |
|---|---|
Authorization |
必填。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱 授權對 Azure 記憶體的要求。 |
Date 或 x-ms-date |
必填。 指定要求的國際標準時間（UTC）。 如需詳細資訊，請參閱 授權對 Azure 記憶體的要求。 |
x-ms-version |
所有已授權要求的必要專案。 指定要用於此要求的作業版本。 如需詳細資訊，請參閱 Azure 記憶體服務的版本設定。 |
x-ms-cache-control |
自選。 修改檔案的快取控制字串。 如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-type |
自選。 設定檔案的內容類型。 如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-md5 |
自選。 設定檔案的 MD5 哈希。 如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-encoding |
自選。 設定檔案的內容編碼。 如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-language |
自選。 設定檔案的內容語言。 如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-disposition |
自選。 設定檔案的 Content-Disposition 標頭。如果未在要求上指定這個屬性，則會清除檔案的屬性。 取得檔案屬性 的後續呼叫將不會傳回這個屬性，除非它再次明確在檔案上設定。 |
x-ms-content-length: bytes |
自選。 將檔案大小調整為指定的大小。 如果指定的位元組值小於檔案的目前大小，則會清除指定位元組值上方的所有範圍。 |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
在 2019-02-02 至 2021-04-10 版中，如果未指定 x-ms-file-permission-key，則需要此標頭。 自 2021-06-08 版起，這兩個標頭都是選擇性的。 此許可權是 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-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。 如果未指定這兩個標頭，則會針對 x-ms-file-permission 標頭使用 preserve 的預設值。 |
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 且檔案的大小已變更，則上次寫入時間會更新為目前時間。 如果檔案的大小已變更，但會提供明確的時間戳，則會使用明確的時間戳。 預設值為 preserve。 |
x-ms-lease-id: <ID> |
如果檔案具有使用中租用，則為必要專案。 適用於 2019-02-02 版和更新版本。 |
x-ms-client-request-id |
自選。 提供客戶端產生的不透明值，其中包含設定記錄時記錄的 1-kibibyte （KiB） 字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊，請參閱 監視 Azure 檔案服務。 |
x-ms-file-change-time: { now ¦ <DateTime> } |
自選。 版本 2021-06-08 和更新版本。 國際標準時間 （UTC） 會變更檔案的時間屬性，格式為 ISO 8601 格式。 您可以使用 now 值來指出要求的時間。 預設值為 now。 |
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 中的尾端點。 如需詳細資訊，請參閱 命名和參考共用、目錄、檔案和元資料。 |
要求本文
沒有。
回應
回應包含 HTTP 狀態代碼和一組響應標頭。
狀態代碼
成功的作業會傳回狀態代碼 200 （確定）。
如您需狀態代碼的相關資訊，請參閱 狀態和錯誤碼。
回應標頭
此作業的回應包含下列標頭。 回應也可能包含額外的標準 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 |
可用來針對要求和對應的回應進行疑難解答。 如果此標頭存在於要求中，則這個標頭的值等於 x-ms-client-request-id 標頭的值，而且值包含不超過 1,024 個可見的 ASCII 字元。 如果要求中沒有 x-ms-client-request-id 標頭，它就不會出現在回應中。 |
回應本文
沒有。
授權
只有帳戶擁有者可以呼叫這項作業。
檔案系統屬性
| 屬性 | Win32 檔案屬性 | 定義 |
|---|---|---|
| ReadOnly | FILE_ATTRIBUTE_READONLY | 唯讀的檔案。 應用程式可以讀取檔案，但無法寫入或刪除檔案。 |
| 隱藏 | FILE_ATTRIBUTE_HIDDEN | 檔案已隱藏。 它不包含在一般目錄清單中。 |
| 系統 | FILE_ATTRIBUTE_SYSTEM | 操作系統使用 部分或獨佔使用的檔案。 |
| 沒有 | FILE_ATTRIBUTE_NORMAL | 未設定其他屬性的檔案。 此屬性只有在單獨使用時才有效。 |
| 檔案 | FILE_ATTRIBUTE_ARCHIVE | 檔案是封存盤案。 應用程式通常會使用這個屬性來標記檔案以進行備份或移除。 |
| 臨時 | FILE_ATTRIBUTE_TEMPORARY | 用於暫存記憶體的檔案。 |
| 離線 | FILE_ATTRIBUTE_OFFLINE | 檔案的數據無法立即取得。 此文件系統屬性主要是為了提供與 Windows 的相容性。 Azure 檔案記憶體不支援離線記憶體選項。 |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | 檔案不會由內容索引服務編製索引。 |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | 背景數據完整性掃描器不會讀取用戶數據流。 此文件系統屬性主要是為了提供與 Windows 的相容性。 |
言論
更新檔案屬性的語意如下：
只有當要求指定
x-ms-content-length標頭的值時，才會修改檔案的大小。如果要求只設定
x-ms-content-length且沒有其他屬性，則不會修改檔案的其他屬性。如果要求中設定了下列任何一或多個屬性，則所有這些屬性都會一起設定。 如果至少設定下列其中一個屬性時，指定的屬性未提供值，則會清除該檔案的屬性。
x-ms-cache-controlx-ms-content-typex-ms-content-md5x-ms-content-encodingx-ms-content-language
注意
上述檔案屬性與SMB用戶端可用的檔案系統屬性不同。 SMB 用戶端無法讀取、寫入或修改這些屬性值。
共用快照集不支援 Set File properties，這是共用的唯讀複本。 嘗試在共用快照集上執行這項作業失敗，並出現 400 （InvalidQueryParameterValue）。
如果檔案具有作用中的租用，客戶端必須在要求上指定有效的租用標識碼，才能將屬性寫入檔案。 如果用戶端未指定租用標識碼，或指定無效的租用標識符，則檔案服務會傳回狀態代碼 412 （前置條件失敗）。 如果用戶端指定租用標識碼，但檔案沒有使用中租用，則檔案服務也會傳回狀態代碼 412（前置條件失敗）。
另請參閱
Azure 檔案服務 上的