Získání vlastností souborové služby

Článek
07/19/2023

Operace Get File Service Properties získá vlastnosti prostředku FileService pomocí rozhraní FileREST API. I když je toto rozhraní API plně podporované, jedná se o starší verzi rozhraní API pro správu. Doporučujeme místo toho použít Souborovou službu – Získat vlastnosti služby, kterou poskytuje poskytovatel prostředků úložiště (Microsoft.Storage). Další informace o programové interakci s FileService prostředkem pomocí poskytovatele prostředků úložiště najdete v tématu Operace s prostředkem FileService.

Dostupnost protokolu

Povolený protokol sdílené složky	K dispozici.
SMB
NFS

Žádost

Žádost Get File Service Properties může být zadána následujícím způsobem. Doporučujeme používat protokol HTTPS. Nahraďte <account-name> názvem vašeho účtu úložiště:

Metoda	Identifikátor URI žádosti	Verze PROTOKOLU HTTP
GET	`https://<account-name>.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Poznámka

Identifikátor URI musí vždy obsahovat lomítko (/), aby se název hostitele oddělil od části URI cesty a dotazu. V této operaci je část cesty identifikátoru URI prázdná.

Parametry identifikátoru URI

Parametr identifikátoru URI	Description
`restype=service&comp=properties`	Povinná hodnota. K nastavení vlastností služby úložiště se vyžaduje kombinace obou řetězců dotazu.
`timeout`	Nepovinný parametr. Parametr se `timeout` vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace souborové služby.

Hlavičky požadavku

Následující tabulka popisuje požadované a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
`Authorization`	Povinná hodnota. Určuje schéma autorizace, název účtu úložiště a podpis. Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
`Date` nebo `x-ms-date`	Povinná hodnota. Určuje formát UTC (Coordinated Universal Time). Další informace najdete v tématu Autorizace požadavků do služby 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. Tato operace je k dispozici pouze ve verzi 2015-02-21 a novější. Pokud chcete načíst vlastnosti metrik pro službu File, musíte zadat verzi 2015-04-05 nebo novější. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Nepovinný parametr. Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu znaků 1 kibibajt (KiB), která se při konfiguraci protokolování zaznamená do protokolů Azure Analýza úložiště. 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í Azure Files.

Text požadavku

Žádné

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědi a tělo odpovědi.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK).

Hlavičky odpovědi

Odpověď na tuto operaci obsahuje následující hlavičky. Odpověď může také obsahovat další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi	Description
`x-ms-request-id`	Jednoznačně identifikuje požadavek, který je vůči službě proveden.
`x-ms-version`	Určuje verzi operace, která se použije pro odpověď. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Dá se použít k řešení potíží s požadavky a jejich odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě `x-ms-client-request-id` hlavičky, pokud se nachází v požadavku, a hodnota obsahuje maximálně 1 024 viditelných znaků ASCII. Pokud se hlavička `x-ms-client-request-id` v požadavku nenachází, v odpovědi se nenachází.

Text odpovědi

Text odpovědi pro verzi 2020-02-10 je následující:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Prvky textu odpovědi jsou popsány v následující tabulce:

Název	Description
`HourMetrics`	Seskupí nastavení Analýza úložiště`HourMetrics`. Nastavení `HourMetrics` poskytují souhrn statistik žádostí seskupených podle rozhraní API v agregovaných po hodinách.
`MinuteMetrics`	Seskupí nastavení Analýza úložiště`MinuteMetrics`. Nastavení `MinuteMetrics` poskytují statistiky požadavků pro každou minutu.
`Version`	Verze Analýza úložiště, která se aktuálně používá.
`Enabled`	Určuje, jestli jsou pro službu File povolené metriky.
`IncludeAPIs`	Určuje, jestli metriky generují souhrnné statistiky pro volané operace rozhraní API.
`RetentionPolicy/Enabled`	Určuje, jestli je pro službu File povolená zásada uchovávání informací.
`RetentionPolicy/Days`	Určuje počet dnů, po které se uchovávají data metrik. Všechna data, která jsou starší než tato hodnota, se odstraní s maximálním úsilím.
`Cors`	Seskupí všechna pravidla sdílení prostředků mezi zdroji (CORS).
`CorsRule`	Nastavení skupin pro pravidlo CORS
`AllowedOrigins`	Seznam počátečních domén oddělených čárkami, které jsou povolené prostřednictvím CORS, nebo *, pokud jsou povolené všechny domény.
`ExposedHeaders`	Seznam hlaviček odpovědí oddělených čárkami, které se mají zpřístupnit klientům CORS.
`MaxAgeInSeconds`	Počet sekund, po který by měl klient nebo prohlížeč uložit předběžnou odpověď do mezipaměti.
`AllowedHeaders`	Seznam hlaviček oddělených čárkami, které mohou být součástí požadavku mezi zdroji.
`AllowedMethods`	Seznam metod HTTP oddělených čárkami, které mohou být provedeny původem. Pro Azure Files jsou povolené metody DELETE, GET, HEAD, MERGE, POST, OPTIONS a PUT.
`ShareDeleteRetentionPolicy`	Vlastnosti obnovitelného odstranění sdílených složek Azure v tomto účtu úložiště
`Days`	Určuje počet dnů, po které by se měla sdílená složka Azure zachovat (obnovitelně odstraněná). Minimální zadaná hodnota může být 1 a maximální hodnota je 365.
`Enabled`	Určuje, jestli má účet úložiště povolené obnovitelné odstranění pro Azure Files.
`ProtocolSettings`	Seskupí nastavení pro protokoly systému souborů.
`SMB`	Seskupí nastavení smb (Server Message Block).
`Multichannel`	Obsahuje nastavení pro SMB Multichannel. Toto nastavení má jednu vlastnost: povoleno/zakázáno.
`Version`	K dispozici od verze 2020-04-08. Seznam povolených verzí PROTOKOLU SMB oddělených čárkami. Možné hodnoty: `SMB2.1`, `SMB3.0`a `SMB3.1.1`. Pokud `Version` není zadaný, ve výchozím nastavení jsou povolené všechny verze. Protokol SMB 2.1 je ale k dispozici jenom v případě, že je vlastnost účtu `require secure transit` úložiště zakázaná, protože PROTOKOL SMB 2.1 nepodporuje šifrování.
`AuthenticationMethods`	K dispozici od verze 2020-04-08. Seznam povolených metod ověřování oddělených čárkami Možné hodnoty: `NTLMv2`, `Kerberos`. Pokud `AuthenticationMethods` není zadaný, ve výchozím nastavení jsou povolené všechny metody ověřování.
`KerberosTicketEncryption`	K dispozici od verze 2020-04-08. Seznam povolených šifrovacích algoritmů lístku Kerberos oddělených čárkami. Možné hodnoty: `RC4-HMAC` a `AES-256`. Pokud `KerberosTicketEncryption` není zadaný, ve výchozím nastavení se podporují všechny algoritmy šifrování lístků Protokolu Kerberos.
`ChannelEncryption`	K dispozici od verze 2020-04-08. Seznam povolených protokolů šifrování kanálů SMB oddělených čárkami Možné hodnoty: `AES-128-CCM`, `AES-128-GCM`a `AES-256-GCM`. Pokud `ChannelEncryption` není zadaný, ve výchozím nastavení se podporují všechny hodnoty šifrování kanálu. Pokud je vlastnost účtu `require secure transit` úložiště zakázaná, je povolený také nešifrovaný přístup SMB.

Autorizace

Tuto operaci může volat pouze vlastník účtu úložiště.

Ukázkový požadavek a odpověď

Následující ukázkový identifikátor URI vytvoří požadavek na získání vlastností souborové služby pro účet úložiště myaccount:

Metoda	URL	Protokol
GET	`https://myaccount.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Požadavek se odešle s následujícími hlavičkami:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net

Po odeslání požadavku se vrátí následující odpověď:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

Odpověď obsahuje následující text XML:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Poznámky

Podrobné informace o pravidlech CORS a logice vyhodnocení najdete v tématu Podpora CORS pro služby Azure Storage.

Další informace najdete v tématu Analýza úložiště.