Pobieranie właściwości udziału

Żądanie Get Share Properties zwraca właściwości dla określonego udziału lub migawki udziału.

Mimo że ten interfejs API jest w pełni obsługiwany, jest to starszy interfejs API zarządzania. Z tego powodu zalecamy użycie udziałów plików — Pobierz, który jest dostarczany przez dostawcę zasobów magazynu (Microsoft.Storage).

Aby dowiedzieć się więcej o programowej interakcji z zasobami FileShare przy użyciu dostawcy zasobów magazynu, zobacz Operations on FileShares.

Dostępność protokołu

Włączony protokół udziału plików	Dostępny
SMB
NFS

Prosić

Żądanie Get Share Properties można skonstruować w następujący sposób. Zalecamy używanie protokołu HTTPS.

Metoda	Identyfikator URI żądania	Wersja PROTOKOŁU 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

Zastąp składniki ścieżki wyświetlane we własnym identyfikatorze URI żądania, w następujący sposób:

Składnik ścieżki	Opis
myaccount	Nazwa konta magazynu.
myshare	Nazwa udziału plików.

Aby uzyskać informacje o ograniczeniach nazewnictwa ścieżek, zobacz Nazwa i odwołania udziały, katalogi, pliki i metadane.

Parametry identyfikatora URI

W identyfikatorze URI żądania można określić następujące dodatkowe parametry:

Parametr	Opis
sharesnapshot	Fakultatywny. Wersja 2017-04-17 lub nowsza. Parametr sharesnapshot jest nieprzezroczystą wartością daty/godziny, która w chwili obecnej określa migawkę udziału, aby wykonać zapytanie w celu pobrania właściwości.
timeout	Fakultatywny. Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi Azure Files.

Nagłówki żądań

Wymagane i opcjonalne nagłówki zostały opisane w poniższej tabeli:

Nagłówek żądania	Opis
Authorization	Wymagane. Określa schemat autoryzacji, nazwę konta i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
Date lub x-ms-date	Wymagane. Określa uniwersalny czas koordynowany (UTC) dla żądania. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
x-ms-version	Wymagane dla wszystkich autoryzowanych żądań. Określa wersję operacji do użycia dla tego żądania. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji dla usług Azure Storage.
x-ms-client-request-id	Fakultatywny. Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitor Azure Files.
x-ms-lease-id:<ID>	Fakultatywny. Wersja 2020-02-10 lub nowsza. Jeśli nagłówek jest określony, operacja jest wykonywana tylko wtedy, gdy dzierżawa udziału plików jest obecnie aktywna, a identyfikator dzierżawy określony w żądaniu jest zgodny z identyfikatorem dzierżawy udziału plików. Jeśli nie ma dopasowania, operacja zakończy się niepowodzeniem z kodem stanu 412 (Warunek wstępny nie powiodł się).

Treść żądania

Żaden.

Odpowiedź

Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.

Kod stanu

Pomyślna operacja zwraca kod stanu 200 (OK).

Aby uzyskać więcej informacji na temat kodów stanu, zobacz Stan i kody błędów.

Nagłówki odpowiedzi

Odpowiedź dla tej operacji zawiera następujące nagłówki. Odpowiedź może również zawierać dodatkowe standardowe nagłówki HTTP. Wszystkie standardowe nagłówki są zgodne ze specyfikacją protokołu HTTP/1.1 .

Nagłówek odpowiedzi	Opis
Last-Modified	Zwraca datę i godzinę ostatniej modyfikacji udziału. Format daty jest zgodny z RFC 1123. Aby uzyskać więcej informacji, zobacz Reprezentacja wartości Date-Time w nagłówkach. Każda operacja modyfikując udział lub jego właściwości aktualizuje czas ostatniej modyfikacji. Operacje na plikach nie mają wpływu na czas ostatniej modyfikacji udziału.
x-ms-meta-name:value	Zestaw par nazwa-wartość, które zawierają metadane zdefiniowane przez użytkownika udziału.
ETag	Zawiera wartość, której można użyć do warunkowego wykonywania operacji. Wartość jest ujęta w cudzysłów.
x-ms-request-id	Jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem. Aby uzyskać więcej informacji, zobacz Rozwiązywanie problemów z operacjami interfejsu API.
x-ms-version	Wersja usługi Azure Files, która została użyta do wykonania żądania.
Date	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę zainicjowania odpowiedzi.
x-ms-share-quota	Wersja 2015-02-21 lub nowsza. Zwraca bieżący limit przydziału udziału w gibibajtach (GiB).
x-ms-share-provisioned-iops	Wersja 2019-07-07 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca liczbę operacji wejścia/wyjścia na sekundę (we/wy na sekundę) jako aprowizowaną dla udziału w warstwie Premium.
x-ms-share-provisioned-ingress-mbps	Wersja 2019-07-07 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca ruch przychodzący w mebibajtach na sekundę (MiB/s), zgodnie z aprowizowaną dla udziału w warstwie Premium.
x-ms-share-provisioned-egress-mbps	Wersja 2019-07-07 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca ruch wychodzący w usłudze MiB/s, zgodnie z aprowizowaną dla udziału w warstwie Premium.
x-ms-share-provisioned-bandwidth-mibps	Wersja 2021-02-12 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca łączną przepustowość (ruch przychodzący i wychodzący) w usłudze MiB/s, zgodnie z aprowizowaną dla udziału w warstwie Premium.
x-ms-share-next-allowed-quota-downgrade-time	Wersja 2019-07-07 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Wartość daty/godziny określająca, kiedy limit przydziału udziału plików w warstwie Premium może zostać zmniejszony. Format daty jest zgodny z RFC 1123.
x-ms-access-tier	Wersja 2019-12-12 lub nowsza. Zwraca bieżącą warstwę dostępu udziału. W przypadku kont magazynu ogólnego przeznaczenia w wersji 2 (GPv2) TransationOptimized jest domyślną warstwą udziału. W typach kont magazynu FileStorage Premium jest domyślną warstwą udziału.
x-ms-access-tier-change-time	Wersja 2019-12-12 lub nowsza. Zwraca datę i godzinę ostatniej modyfikacji warstwy dostępu w udziale.
x-ms-access-tier-transition-state	Wersja 2019-12-12 lub nowsza. Jeśli udział przechodzi przejście do warstwy, ten nagłówek wskazuje warstwę, z której następuje przejście.
x-ms-lease-duration:<fixed,infinite>	Wersja 2020-02-10 lub nowsza. Określa, czy dzierżawa udziału ma nieskończony lub stały czas trwania.
x-ms-lease-state: <available;leased;expired;breaking;broken>	Wersja 2020-02-10 lub nowsza. Gdy udział jest dzierżawiony, ten nagłówek określa stan dzierżawy udziału.
x-ms-lease-status: <locked;unlocked>	Wersja 2020-02-10 lub nowsza. Gdy udział jest dzierżawiony, ten nagłówek określa stan dzierżawy udziału.
x-ms-enabled-protocols: <SMB;NFS>	Zwraca bieżące protokoły z obsługą udziału dla wersji 2019-07-07 lub nowszej. - SMB: dostęp do udziału można uzyskać za pomocą protokołu SMBv3.0, SMBv2.1 i REST. - NFS: dostęp do udziału można uzyskać za pomocą systemu plików NFSv4.1.
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash>	Zwraca zachowanie 2019-07-07-07-07 i nowszego elementu głównego udziału. Tylko system plików NFS. - NoRootSquash: root squashing is off .- NoRootSquash. - RootSquash: żądania z identyfikatora UID/GID 0 są mapowane na anonimowy identyfikator UID/GID. - AllSquash: wszystkie identyfikatory UID i GID są mapowane na użytkownika anonimowego. Ten nagłówek jest zwracany tylko dla udziałów, a nie dla migawek.
x-ms-enable-snapshot-virtual-directory-access: <true;false>	Wersja 2024-08-04 i nowsze. Określa, czy katalog wirtualny migawki powinien być dostępny w katalogu głównym punktu instalacji udziału, gdy system plików NFS jest włączony. Ten nagłówek jest zwracany tylko dla udziałów, a nie dla migawek.
x-ms-client-request-id	Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi odpowiedziami. Wartość tego nagłówka jest równa wartości nagłówka x-ms-client-request-id, jeśli znajduje się w żądaniu, a wartość nie zawiera więcej niż 1024 widocznych znaków ASCII. Jeśli nagłówek x-ms-client-request-id nie znajduje się w żądaniu, nie będzie on obecny w odpowiedzi.
x-ms-share-paid-bursting-enabled: <true;false>	Wersja 2024-11-04 lub nowsza. Zwracane tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Określa, czy płatne skalowanie jest włączone. Ten nagłówek jest zwracany tylko dla udziałów, a nie dla migawek.
x-ms-share-paid-bursting-max-iops	Wersja 2024-11-04 lub nowsza. Zwracane tylko w przypadku udziałów plików w warstwie Premium. Zwraca maksymalną liczbę płatnych operacji we/wy na sekundę dozwoloną dla udziału. Zwracane tylko wtedy, gdy x-ms-share-paid-bursting-enabled ma wartość true. Ten nagłówek jest zwracany tylko dla udziałów, a nie dla migawek.
x-ms-share-paid-bursting-max-bandwidth-mibps	Wersja 2024-11-04 lub nowsza. Zwracane tylko w przypadku udziałów plików w warstwie Premium. Zwraca maksymalną liczbę płatnych serii dozwolonych dla udziału MiB/s. Zwracane tylko wtedy, gdy x-ms-share-paid-bursting-enabled ma wartość true. Ten nagłówek jest zwracany tylko dla udziałów, a nie dla migawek.

Treść odpowiedzi

Żaden.

Przykładowa odpowiedź

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  

Autoryzacja

Tylko właściciel konta może wywołać tę operację.

Uwagi

Żaden.

Zobacz też

operacje w udziałach plików platformy Azure