取得共用屬性

  • 發行項

要求 Get Share Properties 會傳回指定之共用或共用快照集的屬性。

雖然完全支援此 API，但它是舊版管理 API。 基於這個理由，我們建議您改用 檔案共用 - 取得，這是由記憶體資源提供者提供， (Microsoft.Storage) 。

若要深入瞭解如何使用記憶體資源提供者以程序設計方式與 FileShare 資源互動，請參閱 FileShares 上的作業。

通訊協定可用性

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

要求

Get Share Properties 要求的建構如下。 建議您使用 HTTPS。

方法 要求 URI HTTP 版本
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> HTTP/1.1

將要求 URI 中的路徑元件取代為您自己的路徑元件，如下所示：

路徑元件 Description
myaccount 儲存體帳戶的名稱。
myshare 檔案共用的名稱。

如需路徑命名限制的詳細資訊，請參閱 名稱和參考共用、目錄、檔案和元數據。

URI 參數

您可以在要求 URI 中指定下列其他參數：

參數 描述
sharesnapshot 選擇性。 版本 2017-04-17 和更新版本。 參數 sharesnapshot 是不透明的日期/時間值，當存在時，會指定要查詢的共用快照集來擷取屬性。
timeout 選擇性。 timeout 參數以秒為單位。 如需詳細資訊，請參閱設定 Azure 檔案儲存體 作業的逾時。

要求標頭

下表說明必要的和選擇性標頭：

要求標頭 描述
Authorization 必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。
Date 或 x-ms-date 必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。
x-ms-version 所有授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊，請參閱 Azure 儲存體服務的版本。
x-ms-client-request-id 選擇性。 提供客戶端產生的不透明值，其中包含 1-kibibyte (KiB) 設定記錄時記錄在記錄中的字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器收到的要求相互關聯。 如需詳細資訊，請參閱監視 Azure 檔案儲存體。
x-ms-lease-id:<ID> 選擇性。 版本 2020-02-10 和更新版本。 如果指定標頭，則只有在檔案共用的租用目前為使用中，且要求中指定的租用標識符符合檔案共用的租用標識符時，才會執行作業。 如果沒有相符專案，作業會失敗，狀態代碼為 412 (前置條件失敗) 。

要求本文

無。

回應

回應包括 HTTP 狀態碼和一組回應標頭。

狀態碼

成功的作業會傳回狀態碼 200 (OK)。

如需狀態代碼的詳細資訊，請參閱 狀態和錯誤碼。

回應標頭

這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協議規格。

回應標頭 描述
Last-Modified 傳回上次修改共用的日期和時間。 日期格式會依照 RFC 1123。 如需詳細資訊，請參閱 標頭中 Date-Time 值的表示。 修改共用或其屬性的任何作業，都會更新上次修改時間。 檔案上的作業不會影響共用的上次修改時間。
x-ms-meta-name:value 一組含有使用者定義之共用中繼資料的名稱/值對。
ETag 包含值，您可以用來有條件地執行作業。 此值會以引弧括住。
x-ms-request-id 可唯一識別已提出的要求，並可用來對要求進行疑難解答。 如需詳細資訊，請參閱 針對 API 作業進行疑難解答。
x-ms-version 用來執行要求的 Azure 檔案儲存體 版本。
Date 服務所產生的 UTC 日期/時間值，表示起始響應的時間。
x-ms-share-quota 版本 2015-02-21 和更新版本。 傳回 gibibytes (GiB) 的目前共用配額。
x-ms-share-provisioned-iops 版本 2019-07-07 和更新版本。 僅針對進階檔案共享傳回， (FileStorage 記憶體帳戶類型) 內的檔案共用。 傳回針對進階共用布建的每秒輸入/輸出作業數目 (IOPS) 。
x-ms-share-provisioned-ingress-mbps 版本 2019-07-07 和更新版本。 僅針對進階檔案共享傳回， (FileStorage 記憶體帳戶類型) 內的檔案共用。 傳回針對進階共用布建的MiB/s () 每秒以mebibytes為單位的輸入。
x-ms-share-provisioned-egress-mbps 版本 2019-07-07 和更新版本。 僅針對進階檔案共享傳回， (FileStorage 記憶體帳戶類型) 內的檔案共用。 傳回MiB/秒中的輸出，如為進階共用布建。
x-ms-share-provisioned-bandwidth-mibps 版本 2021-02-12 和更新版本。 僅針對進階檔案共享傳回， (FileStorage 記憶體帳戶類型) 內的檔案共用。 傳回 MiB/秒中已布建的合併 (輸入 + 輸出) 頻寬。
x-ms-share-next-allowed-quota-downgrade-time 版本 2019-07-07 和更新版本。 僅針對進階檔案共享傳回 (FileStorage 記憶體帳戶類型內的檔案分享) 。 日期/時間值，指定允許減少進階檔案共用配額的時間。 日期格式會依照 RFC 1123。
x-ms-access-tier 版本 2019-12-12 和更新版本。 傳回共用的目前存取層。 在一般用途第 2 版 (GPv2) 記憶體帳戶中， TransationOptimized 是共用的預設層。 在 FileStorage 記憶體帳戶類型中， Premium 是共用的預設層。
x-ms-access-tier-change-time 版本 2019-12-12 和更新版本。 傳回上次修改共用上存取層的日期和時間。
x-ms-access-tier-transition-state 版本 2019-12-12 和更新版本。 如果共用正在進行階層轉換，此標頭會指出其轉換的來源層。
x-ms-lease-duration:<fixed,infinite> 版本 2020-02-10 和更新版本。 指定共用上的租用是無限期或固定持續時間。
x-ms-lease-state: <available;leased;expired;breaking;broken> 版本 2020-02-10 和更新版本。 當共用租用時，此標頭會指定共用的租用狀態。
x-ms-lease-status: <locked;unlocked> 版本 2020-02-10 和更新版本。 當共用租用時，此標頭會指定共用的租用狀態。
x-ms-enabled-protocols: <SMB;NFS> 傳回 2019-07-07 版和更新版本的目前共用通訊協定。

- SMB：SMBv3.0、SMBv2.1 和 REST 可以存取共用。
- NFS：NFSv4.1 可以存取共用。
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> 傳回 2019-07-07 版和更新版本的目前共用根壓縮行為。 僅限 NFS。

- NoRootSquash：根壓縮已關閉。
- RootSquash：來自 UID/GID 0 的要求會對應至匿名 UID/GID。
- AllSquash：所有 UID 和 GID 都會對應至匿名使用者。
x-ms-client-request-id 可用來針對要求和對應的回應進行疑難解答。 如果此標頭存在於要求中，且值包含不超過 1,024 個可見的 ASCII 字元，則此標頭的值等於標頭的值 x-ms-client-request-id 。 x-ms-client-request-id如果要求中沒有標頭，它就不會出現在回應中。

回應本文

無。

範例回應

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-meta-name: some_metadata  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

授權

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

備註

無。

另請參閱

Azure 檔案共用上的作業