取得共享屬性
Get Share Properties 要求會傳回指定共用或共用快照集的屬性。
雖然完全支援此 API，但它是舊版管理 API。 基於這個理由，我們建議您改用 檔案共用 - 取得，這是由記憶體資源提供者 （Microsoft.Storage） 提供。
若要深入瞭解如何使用記憶體資源提供者以程序設計方式與
通訊協定可用性
| 已啟用檔案共享通訊協定 | 可用 |
|---|---|
| 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 中顯示的路徑元件，如下所示：
| 路徑元件 | 描述 |
|---|---|
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 （確定）。
如您需狀態代碼的詳細資訊，請參閱 狀態和錯誤碼。
回應標頭
此作業的回應包含下列標頭。 回應也可能包含額外的標準 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 記憶體帳戶類型內的檔案共用）。 傳回以每秒 MB 為單位的輸入（MiB/s），如為進階共用布建。 |
x-ms-share-provisioned-egress-mbps |
版本 2019-07-07 和更新版本。 僅針對進階檔案共享傳回 （FileStorage 記憶體帳戶類型內的檔案共用）。 傳回MiB/s中的輸出，如為進階共用布建。 |
x-ms-share-provisioned-bandwidth-mibps |
版本 2021-02-12 和更新版本。 僅針對進階檔案共享傳回 （FileStorage 記憶體帳戶類型內的檔案共用）。 傳回MiB/s 中合併的 （輸入 + 輸出） 頻寬，如為進階共用布建。 |
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-enable-snapshot-virtual-directory-access: <true;false> |
版本 2024-08-04 和更新版本。 指定啟用 NFS 時，是否應該在共用裝入點的根目錄存取快照集虛擬目錄。 此標頭只會針對共用傳回，而不是針對快照集傳回。 |
x-ms-client-request-id |
可用來針對要求和對應的回應進行疑難解答。 如果此標頭存在於要求中，則這個標頭的值等於 x-ms-client-request-id 標頭的值，而且值包含不超過 1,024 個可見的 ASCII 字元。 如果要求中沒有 x-ms-client-request-id 標頭，它就不會出現在回應中。 |
x-ms-share-paid-bursting-enabled: <true;false> |
版本 2024-11-04 和更新版本。 僅針對進階檔案共享傳回 （FileStorage 記憶體帳戶類型內的檔案共用）。 指定是否啟用付費高載。 此標頭只會針對共用傳回，而不是針對快照集傳回。 |
x-ms-share-paid-bursting-max-iops |
版本 2024-11-04 和更新版本。 僅針對進階檔案共享傳回。 傳回共用允許的付費高載 IOPS 上限。 只有在 x-ms-share-paid-bursting-enabled 為 true 時才會傳回。此標頭只會針對共用傳回，而不是針對快照集傳回。 |
x-ms-share-paid-bursting-max-bandwidth-mibps |
版本 2024-11-04 和更新版本。 僅針對進階檔案共享傳回。 傳回共用所允許的最大付費高載MiB/秒。 只有在 x-ms-share-paid-bursting-enabled 為 true 時才會傳回。此標頭只會針對共用傳回，而不是針對快照集傳回。 |
回應本文
沒有。
範例回應
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 檔案共用上的 作業