Získání vlastností sdílené složky
Požadavek Get Share Properties
vrátí vlastnosti pro zadaný snímek sdílené složky nebo sdílené složky.
I když je toto rozhraní API plně podporované, jedná se o starší rozhraní API pro správu. Z tohoto důvodu doporučujeme použít sdílené složky – získat, který poskytuje poskytovatel prostředků úložiště (Microsoft.Storage).
Další informace o programové interakci s prostředky FileShare
pomocí poskytovatele prostředků úložiště najdete v tématu Operace se sdílenými složkami.
Dostupnost protokolu
Povolený protokol sdílené složky | K dispozici |
---|---|
SMB | |
NFS |
Prosba
Požadavek Get Share Properties
lze vytvořit následujícím způsobem. Doporučujeme používat PROTOKOL HTTPS.
Metoda | Identifikátor URI požadavku | Verze 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 |
Součásti cesty zobrazené v identifikátoru URI požadavku nahraďte vlastními, a to následujícím způsobem:
Komponenta Path | Popis |
---|---|
myaccount |
Název vašeho účtu úložiště. |
myshare |
Název sdílené složky. |
Informace o omezeních pojmenování cest najdete v tématu Název a referenční sdílené složky, adresáře, soubory a metadata.
Parametry identifikátoru URI
V identifikátoru URI požadavku je možné zadat následující další parametry:
Parametr | Popis |
---|---|
sharesnapshot |
Volitelný. Verze 2017-04-17 a novější Parametr sharesnapshot je neprůhlená hodnota data a času, která při přítomnosti určuje snímek sdílené složky, který se má dotazovat na načtení vlastností. |
timeout |
Volitelný. Parametr časového limitu se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace azure Files. |
Hlavičky požadavku
Povinná a volitelná záhlaví jsou popsaná v následující tabulce:
Hlavička požadavku | Popis |
---|---|
Authorization |
Požadovaný. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage. |
Date nebo x-ms-date |
Požadovaný. Určuje standard UTC (Coordinated Universal Time) pro požadavek. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage. |
x-ms-version |
Vyžaduje se pro všechny autorizované žádosti. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage. |
x-ms-client-request-id |
Volitelný. Poskytuje hodnotu vygenerovanou klientem, neprůshlenou hodnotou s limitem znaků 1 kibibajtů (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Files. |
x-ms-lease-id:<ID> |
Volitelný. Verze 2020-02-10 a novější Pokud je zadána hlavička, operace se provede pouze v případě, že je zapůjčení sdílené složky aktuálně aktivní a ID zapůjčení zadané v požadavku odpovídá ID zapůjčení sdílené složky. Pokud neexistuje shoda, operace selže se stavovým kódem 412 (předběžná podmínka se nezdařila). |
Text požadavku
Žádný.
Odpověď
Odpověď obsahuje stavový kód HTTP a sadu hlaviček odpovědi.
Stavový kód
Úspěšná operace vrátí stavový kód 200 (OK).
Další informace o stavových kódech najdete v tématu Stav a kódy chyb.
Hlavičky odpovědi
Odpověď pro tuto operaci obsahuje následující hlavičky. Odpověď může obsahovat také další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.
Hlavička odpovědi | Popis |
---|---|
Last-Modified |
Vrátí datum a čas poslední změny sdílené složky. Formát data se řídí dokumentem RFC 1123. Další informace naleznete v tématu Reprezentace hodnot Date-Time v záhlaví. Jakákoli operace, která upravuje sdílenou složku nebo její vlastnosti, aktualizuje čas poslední změny. Operace se soubory nemají vliv na čas poslední změny sdílené složky. |
x-ms-meta-name:value |
Sada párů název-hodnota, které obsahují uživatelsky definovaná metadata sdílené složky. |
ETag |
Obsahuje hodnotu, kterou můžete použít k podmíněnému provádění operací. Hodnota je uzavřena v uvozovkách. |
x-ms-request-id |
Jednoznačně identifikuje požadavek, který byl proveden, a lze ho použít k řešení potíží s požadavkem. Další informace najdete v tématu Řešení potíží s operacemi rozhraní API. |
x-ms-version |
Verze služby Azure Files, která se použila k provedení požadavku. |
Date |
Hodnota data a času UTC vygenerovaná službou, která označuje čas zahájení odpovědi. |
x-ms-share-quota |
Verze 2015-02-21 a novější Vrátí aktuální kvótu sdílené složky v gibibajtech (GiB). |
x-ms-share-provisioned-iops |
Verze 2019-07-07 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Vrátí počet vstupně-výstupních operací za sekundu (IOPS), jak je zřízeno pro sdílenou složku Úrovně Premium. |
x-ms-share-provisioned-ingress-mbps |
Verze 2019-07-07 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Vrátí příchozí přenos dat v mebibajtech za sekundu (MiB/s), jak je zřízeno pro prémiový podíl. |
x-ms-share-provisioned-egress-mbps |
Verze 2019-07-07 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Vrátí výchozí přenos dat v MiB/s, jak je zřízeno pro sdílenou složku Premium. |
x-ms-share-provisioned-bandwidth-mibps |
Verze 2021-02-12 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Vrátí kombinovanou šířku pásma (příchozí a výchozí přenos) v MiB/s, jak je zřízená pro sdílenou úroveň Premium. |
x-ms-share-next-allowed-quota-downgrade-time |
Verze 2019-07-07 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Hodnota data a času, která určuje, kdy je povolena snížení kvóty sdílené složky úrovně Premium. Formát data se řídí dokumentem RFC 1123. |
x-ms-access-tier |
Verze 2019-12-12 a novější. Vrátí aktuální úroveň přístupu sdílené složky. V účtech úložiště pro obecné účely verze 2 (GPv2) je TransationOptimized výchozí úrovní sdílené složky. V typech účtů úložiště FileStorage je Premium výchozí vrstvou sdílené složky. |
x-ms-access-tier-change-time |
Verze 2019-12-12 a novější. Vrátí datum a čas poslední změny úrovně přístupu sdílené složky. |
x-ms-access-tier-transition-state |
Verze 2019-12-12 a novější. Pokud sdílená složka prochází přechodem vrstvy, označuje tato hlavička úroveň, ze které přechází. |
x-ms-lease-duration:<fixed,infinite> |
Verze 2020-02-10 a novější Určuje, zda zapůjčení sdílené složky má neomezenou nebo pevnou dobu trvání. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Verze 2020-02-10 a novější Při zapůjčení sdílené složky určuje tato hlavička stav zapůjčení sdílené složky. |
x-ms-lease-status: <locked;unlocked> |
Verze 2020-02-10 a novější Při zapůjčení sdílené složky určuje tato hlavička stav zapůjčení sdílené složky. |
x-ms-enabled-protocols: <SMB;NFS> |
Vrátí aktuální protokoly s podporou sdílených složek pro verzi 2019-07-07 a novější. - SMB : Ke sdílené složce má přístup SMBv3.0, SMBv2.1 a REST.- NFS : Ke sdílené složce má přístup NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Vrátí aktuální chování kořenového squashingu sdílené složky pro verzi 2019-07-07 a novější. Pouze systém souborů NFS. - NoRootSquash : Root squashing je vypnutý.- RootSquash : Požadavky z UID/GID 0 se mapují na anonymní UID/GID.- AllSquash : Všechny identifikátory UID a identifikátory GID se mapují na anonymního uživatele.Tato hlavička se vrátí jenom pro sdílené složky, ne pro snímky. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Verze 2024-08-04 a novější. Určuje, jestli má být virtuální adresář snímků přístupný v kořenovém adresáři přípojného bodu sdílené složky, pokud je povolen systém souborů NFS. Tato hlavička se vrátí jenom pro sdílené složky, ne pro snímky. |
x-ms-client-request-id |
Dá se použít k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě hlavičky x-ms-client-request-id , pokud se nachází v požadavku a hodnota neobsahuje více než 1 024 viditelných znaků ASCII. Pokud v požadavku není hlavička x-ms-client-request-id , nezobrazí se v odpovědi. |
x-ms-share-paid-bursting-enabled: <true;false> |
Verze 2024-11-04 a novější. Vráceno pouze pro sdílené složky úrovně Premium (sdílené složky v rámci typu účtu úložiště FileStorage). Určuje, jestli je povolené placené shlukování. Tato hlavička se vrátí jenom pro sdílené složky, ne pro snímky. |
x-ms-share-paid-bursting-max-iops |
Verze 2024-11-04 a novější. Vráceno pouze pro sdílené složky úrovně Premium. Vrátí maximální počet placených vstupně-výstupních operací za sekundu povolených pro sdílenou složku. Vrátí se pouze v případě, že x-ms-share-paid-bursting-enabled je true.Tato hlavička se vrátí jenom pro sdílené složky, ne pro snímky. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Verze 2024-11-04 a novější. Vráceno pouze pro sdílené složky úrovně Premium. Vrátí maximální počet placených nárůstů MiB/s povolených pro sdílenou složku. Vrátí se pouze v případě, že x-ms-share-paid-bursting-enabled je true.Tato hlavička se vrátí jenom pro sdílené složky, ne pro snímky. |
Text odpovědi
Žádný.
Ukázková odpověď
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
Oprávnění
Tuto operaci může volat pouze vlastník účtu.
Poznámky
Žádný.
Viz také
operace ve sdílených složkách Azure