(FileREST API) 設定共用屬性 - Azure 檔案儲存體

發行項
08/05/2023

作業 Set Share Properties 會設定指定之 Azure 檔案共用的屬性。雖然完全支援此作業，但它是舊版管理作業。建議您改用儲存體資源提供者所提供的檔案共用 - 更新作業， (Microsoft.Storage) 。若要深入瞭解如何使用儲存體資源提供者以程式設計方式與資源互動 FileShare ，請參閱 FileShare 資源的作業。

通訊協定可用性

已啟用檔案共用通訊協定	可用
SMB
NFS

要求

您可以依照下列方式建構 Set Share Properties 要求。我們建議使用 HTTPS。以儲存體帳戶的名稱取代 myaccount 。

方法	要求 URI	HTTP 版本
`PUT`	`https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties`	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-share-quota`	選擇性。 2015-02-21 版和更新版本支援。指定共用的大小上限，以 gibibytes (GiB) 為單位。
`x-ms-access-tier`	選擇性。 2019-12-12 版和更新版本支援。指定共用的存取層。有效值是 `TransactionOptimized`、`Hot` 和 `Cool`。如需檔案共用階層處理的詳細資訊，請參閱Azure 檔案儲存體儲存層
`x-ms-root-squash: <NoRootSquash \| RootSquash \| AllSquash>`	選擇性。 2020-02-10 版和更新版本支援。指定啟用 NFS 時，共用上的根分割行為。如果未指定，則預設值為 `NoRootSquash` 。 `NoRootSquash`：關閉根四捨五入。 `RootSquash`：將來自 UID/GID 0 的要求對應至匿名 UID/GID。 `AllSquash`：將所有 UID 和 GID 對應至匿名使用者。
`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=properties  
  
Request Headers:  
x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount: Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00Jdjid0Q=  
x-ms-share-quota: 55  
x-ms-root-squash: RootSquash

回應

回應包括 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`	可用來針對要求和對應的回應進行疑難排解。如果此標頭存在於要求中，此標頭的值等於標頭的值 `x-ms-client-request-id` ，且此值最多為 1，024 個可見的 ASCII 字元。 `x-ms-client-request-id`如果要求中沒有標頭，則回應中不會顯示此標頭。

回應本文

無。

授權

只有帳戶擁有者可以呼叫這項作業。

備註

如需設定共用配額的詳細資訊，請參閱建立共用。

如果您將共用配額設定為小於共用上資料的大小，作業將會成功。不過，除非共用上的資料量低於配額，否則您將無法將更多資料新增至共用。您可以藉由刪除或壓縮檔案來減少資料量。

Set Share Properties 共用快照集不支援。嘗試在共用快照集上執行這項作業將會失敗，狀態碼為 400 (InvalidQueryParameterValue) 。

另請參閱

FileShare 資源的作業 (Azure 檔案儲存體)

設定共用屬性