設定共用中繼資料
此 Set Share Metadata
作業會設定指定共用的一或多個使用者定義名稱/值組。 雖然完全支援這項作業,但它是舊版管理作業。 建議您改用儲存體資源提供者所提供的 檔案共用 - 更新 作業, (Microsoft.Storage) 。 若要深入瞭解如何使用儲存體資源提供者以程式設計方式與 FileShare
資源互動,請參閱 FileShare 資源的作業。
通訊協定可用性
已啟用檔案共用通訊協定 | 可用 |
---|---|
SMB | |
NFS |
要求
您可以建構 Set Share Metadata
要求,如下所示。 我們建議使用 HTTPS。 以儲存體帳戶的名稱取代 myaccount 。
方法 | 要求 URI | HTTP 版本 |
---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
將要求 URI 中的路徑元件取代為您自己的路徑元件,如下所示:
路徑元件 | Description |
---|---|
myaccount |
儲存體帳戶的名稱。 |
myshare |
檔案共用的名稱。 |
如需路徑命名限制的詳細資訊,請參閱 命名和參考共用、目錄、檔案和中繼資料。
URI 參數
您可以在要求 URI 上指定下列其他參數:
參數 | 描述 |
---|---|
timeout |
選擇性。 以碼錶示。 如需詳細資訊,請參閱設定Azure 檔案儲存體作業的逾時。 |
要求標頭
下表描述必要和選擇性的要求標頭:
要求標頭 | 描述 |
---|---|
Authorization |
必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊,請參閱授權對 Azure 儲存體提出要求。 |
Date 或 x-ms-date |
必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊,請參閱授權對 Azure 儲存體提出要求。 |
x-ms-version |
所有已授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊,請參閱 Azure 儲存體服務的版本。 |
x-ms-meta-name:value |
選擇性。 提供名稱/值組,以包含共用的中繼資料。 每次呼叫這項作業都會取代附加至共用的所有現存中繼資料。 若要從共用中移除所有中繼資料,請呼叫這項作業並且不使用中繼資料標頭。 中繼資料名稱必須遵守 C# 識別碼的命名規則。 |
x-ms-client-request-id |
選擇性。 提供用戶端產生的不透明值,其中包含設定記錄時記錄在儲存體分析記錄中的 1 kibibyte (KiB) 字元限制。 強烈建議您使用此標頭,將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊,請參閱監視Azure Blob 儲存體。 |
x-ms-lease-id:<ID> |
如果目的地檔案共用有作用中的租用,則為必要專案。 適用于 2020-02-10 版和更新版本。 如果要求不包含租用識別碼或無效,作業會失敗,狀態碼為 412 (前置條件失敗) 。 如果指定此標頭,且目的地檔案共用目前沒有作用中租用,作業就會失敗,狀態碼為 412 (前置條件失敗) 。 |
要求本文
無。
範例要求
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1
Request Headers:
x-ms-version: 2014-02-14
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT
x-ms-meta-Category: Images
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=
回應
回應包括 HTTP 狀態碼和一組回應標頭。
狀態碼
成功的作業會傳回狀態碼 200 (OK)。
如需狀態碼的相關資訊,請參閱 狀態和錯誤碼。
回應標頭
這項作業的回應包括下列標頭。 回應也可能包含額外的標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協定規格。
回應標頭 | 描述 |
---|---|
Last-Modified |
傳回上次修改共用的日期和時間。 日期格式會依照 RFC 1123。 如需詳細資訊,請參閱 標頭中的日期/時間值表示。 修改共用或其屬性的任何作業,都會更新上次修改時間。 檔案上的作業不會影響共用的上次修改時間。 |
ETag |
包含值,表示共用的版本,以引號括住。 |
x-ms-request-id |
可唯一識別提出的要求。 您可以使用它對要求進行疑難排解。 如需詳細資訊,請參閱 針對 API 作業進行疑難排解。 |
x-ms-version |
指出用來執行要求的Azure 檔案儲存體版本。 |
Date 或 x-ms-date |
UTC 日期/時間值,指出服務傳送回應的時間。 |
x-ms-client-request-id |
可用來針對要求和對應的回應進行疑難排解。 如果此標頭存在於要求中,且此值最多為 1,024 個可見的 ASCII 字元,則此標頭的值等於標頭的值 x-ms-client-request-id 。
x-ms-client-request-id 如果要求中沒有標頭,此標頭將不會出現在回應中。 |
回應本文
無。
授權
只有帳戶擁有者可以呼叫這項作業。
備註
呼叫 Set Share Metadata
會覆寫與共享相關聯的所有現有中繼資料。 無法修改個別的名稱/值組。
您也可以在建立共用時設定共用的中繼資料,作為 建立共用 作業的一部分。
呼叫 Set Share Metadata
會 ETag
更新共用的 和 Last-Modified-Time
屬性。
Set Share Metadata
共用快照集不支援。 嘗試在共用快照集上執行這項作業將會失敗,狀態碼為 400 (InvalidQueryParameterValue) 。 您可以在建立共用快照集時設定共用快照集的中繼資料,作為作業的 Snapshot Share
一部分。