設定共用屬性
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 中顯示的路徑元件,如下所示:
路徑元件 | 描述 |
---|---|
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 時,共用上的根壁球行為。
|
x-ms-enable-snapshot-virtual-directory-access: <true \| false> |
自選。 2024-08-04 版和更新版本支援。 指定啟用 NFS 時,是否應該在共用裝入點的根目錄存取快照集虛擬目錄。 |
x-ms-client-request-id |
自選。 提供客戶端產生的不透明值,其中包含設定記錄時,記憶體分析記錄中記錄的 1-kibibyte (KiB) 字元限制。 強烈建議您使用此標頭,將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊,請參閱 監視 Azure Blob 記憶體。 |
x-ms-lease-id:<ID> |
如果目的地檔案共用具有使用中租用,則為必要專案。 適用於 2020-02-10 版和更新版本。 如果要求不包含租用標識碼或無效,則作業會失敗,狀態代碼為 412(前置條件失敗)。 如果指定此標頭,且目的地檔案共用目前沒有作用中租用,則作業會失敗,狀態代碼為 412 (前置條件失敗)。 |
x-ms-share-paid-bursting-enabled: <true \| false> |
自選。 2024-11-04 版和更新版本支援。 僅允許進階檔案共用(FileStorage 記憶體帳戶類型內的檔案共用)。 這個屬性可用來啟用或停用付費高載。 如果未指定 屬性,共用將會保留其現有的付費高載啟用狀態。 |
x-ms-share-paid-bursting-max-iops |
自選。 2024-11-04 版和更新版本支援。 僅允許進階檔案共用。 整數,表示共用所允許的每秒付費高載輸入/輸出作業數上限。 如果共用上尚未啟用付費高載:此行為與建立共用中的 x-ms-share-paid-bursting-max-iops 標頭相同。 如果未指定,則預設值為共用允許的最大 IOPS。 如果已設定此標頭,x-ms-share-paid-bursting-enabled 也必須設定為 true。如果共用上已啟用付費高載: x-ms-share-paid-bursting-max-iops 可用來更新共用的付費高載 IOPS 上限。 在此情況下,不需要設定 x-ms-share-paid-bursting-enabled 。 如果 x-ms-share-paid-bursting-enabled 設定為 true,但未設定 x-ms-share-paid-bursting-max-iops ,則最大付費高載 IOPS 會保持不變。 |
x-ms-share-paid-bursting-max-bandwidth-mibps |
自選。 2024-11-04 版和更新版本支援。 僅允許進階檔案共用。 整數,代表允許共用的每秒付費高載位元節數上限(MiB/秒)。 如果共用上尚未啟用付費高載:此行為與建立共用中的 x-ms-share-paid-bursting-max-bandwidth-mibps 標頭相同。 如果未指定,則預設值為共用允許的MiB/秒上限。 如果已設定此標頭,x-ms-share-paid-bursting-enabled 也必須設定為 true。如果共用上已啟用付費高載: x-ms-share-paid-bursting-max-bandwidth-mibps 可用來更新共用的最大付費高載MiB/秒。 在此情況下,不需要設定 x-ms-share-paid-bursting-enabled 。 如果 x-ms-share-paid-bursting-enabled 設定為 true,但未設定 x-ms-share-paid-bursting-max-bandwidth-mibps ,則付費高載頻寬上限會維持不變。 |
要求本文
沒有。
範例要求
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 (確定)。
如您需狀態代碼的相關資訊,請參閱 狀態和錯誤碼。
回應標頭
此作業的回應包含下列標頭。 回應也可能包含額外的標準 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 Properties
。 嘗試在共用快照集上執行這項作業將會失敗,狀態代碼為 400 (InvalidQueryParameterValue)。
如果您為 NFS 共用設定 x-ms-enable-snapshot-virtual-directory-access 標頭,請重新掛接共用以觀察更新的行為。