Nastavení vlastností souborové služby

  • Článek

Operace Set File Service Properties nastaví vlastnosti pro prostředek souborové služby 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 – Nastavit vlastnosti služby, kterou poskytuje poskytovatel prostředků Azure Storage (Microsoft.Storage). Další informace o programové interakci s prostředkem Souborové služby pomocí poskytovatele prostředků Azure Storage najdete v tématu Operace se službou File.

Dostupnost protokolu

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

Žádost

Požadavek můžete zadat Set File Service Properties 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
PUT 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

Požadované a volitelné hlavičky požadavků jsou popsané v následující tabulce:

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 or 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 povolit metriky 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ů 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

Text požadavku 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>

V požadavku není nutné zadávat všechny kořenové prvky. Pokud vynecháte kořenový prvek, stávající nastavení služby pro tuto funkci se zachovají. Pokud však zadáte určitý kořenový prvek, musíte zadat každý podřízený prvek pro tento prvek. Mezi kořenové prvky patří:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

Prvky textu požadavku jsou popsány v následující tabulce:

Název Description
HourMetrics Volitelné pro verzi 2015-04-05 a novější. Neplatí pro starší verze. Seskupí HourMetrics nastavení Analýza úložiště, která poskytují souhrn statistik žádostí seskupených podle rozhraní API v agregovaných po hodinách.
MinuteMetrics Volitelné pro verzi 2015-04-05 a novější. Neplatí pro starší verze. Seskupí nastavení Analýza úložištěMinuteMetrics, která poskytují statistiky žádostí pro každou minutu.
Version Vyžaduje se, pokud jsou povolené metriky. Verze Analýza úložiště, která se má nakonfigurovat. Pro tuto hodnotu použijte 1.0 .
Enabled Povinná hodnota. Určuje, jestli jsou pro službu File povolené metriky.
IncludeAPIs Povinné jenom v případě, že jsou povolené metriky. Určuje, jestli mají metriky generovat souhrnné statistiky pro volané operace rozhraní API.
RetentionPolicy/Enabled Povinná hodnota. Určuje, jestli je pro službu File povolená zásada uchovávání informací. Pokud je false, data metrik se zachovají a uživatel zodpovídá za jejich odstranění.
RetentionPolicy/Days Vyžaduje se pouze v případě, že jsou povolené zásady uchovávání informací. Určuje počet dnů, po které se mají uchovávat data metrik. Všechna data starší než tato hodnota se odstraní. Minimum, které můžete zadat, je 1a maximální hodnota je 365 (jeden rok). Po uplynutí doby uchovávání se data metrik odstraňují na základě maximálního úsilí.
Cors Nepovinný parametr. Element Cors je podporovaný pro verzi 2015-02-21 a novější. Seskupí všechna pravidla sdílení prostředků mezi zdroji (CORS). Vynecháním této skupiny prvků nedojde k přepsání existujících nastavení CORS.
CorsRule Nepovinný parametr. Určuje pravidlo CORS pro službu File. Do požadavku můžete zahrnout až pět elementů CorsRule. Pokud text požadavku neobsahuje žádné CorsRule prvky, odstraní se všechna pravidla CORS a CORS se pro službu File zakáže.
AllowedOrigins Vyžaduje se, CorsRule pokud element existuje. Seznam počátečních domén oddělených čárkami, které jsou povoleny prostřednictvím CORS, nebo *, pokud chcete povolit všechny domény. Původní doména může také v subdoméně obsahovat zástupný znak, který umožňuje žádosti prostřednictvím CORS pro všechny subdomény domény. Omezeno na 64 domén původu. Každý povolený původ může mít maximálně 256 znaků.
ExposedHeaders Vyžaduje se, CorsRule pokud element existuje. Seznam hlaviček odpovědí oddělených čárkami, které se mají zpřístupnit klientům CORS. Omezeno na 64 definovaných hlaviček a dvě hlavičky s předponou. Každé záhlaví může obsahovat až 256 znaků.
MaxAgeInSeconds Vyžaduje se, CorsRule pokud element existuje. Počet sekund, po který má klient nebo prohlížeč ukládat předběžnou odpověď do mezipaměti.
AllowedHeaders Vyžaduje se, CorsRule pokud element existuje. Seznam hlaviček oddělených čárkami, které mohou být součástí požadavku mezi zdroji. Omezeno na 64 definovaných hlaviček a 2 hlavičky s předponou. Každé záhlaví může obsahovat až 256 znaků.
AllowedMethods Vyžaduje se, pokud CorsRule element existuje. Seznam metod HTTP oddělených čárkami, které mohou být provedeny původem. Pro Azure Files jsou DELETEpovolené metody , , GET, HEAD, MERGE, POST, OPTIONSa PUT.
ShareDeleteRetentionPolicy Nepovinný parametr. Vlastnosti obnovitelného odstranění sdílených složek Azure v tomto účtu úložiště
Days Nepovinný parametr. Určuje počet dnů, po které by se měla sdílená složka Azure zachovat (obnovitelně odstraněná). Minimum, které můžete zadat, je 1a maximální hodnota je 365 (jeden rok).
Enabled Nepovinný parametr. Určuje, jestli má účet úložiště povolené obnovitelné odstranění pro Azure Files.
ProtocolSettings Nepovinný parametr. Seskupí nastavení pro protokoly systému souborů.
SMB Nepovinný parametr. Seskupí nastavení smb.
Multichannel Nepovinný parametr. Obsahuje nastavení pro smb multichannel. SMB Multichannel obsahuje Enabled logickou vlastnost, která přepíná stav funkce SMB Multichannel.
Version Volitelné od verze 2020-04-08. Seznam povolených verzí SMB oddělených čárkami Povolené hodnoty jsou SMB2.1, SMB3.0a SMB3.1.1.
AuthenticationMethods Volitelné od verze 2020-04-08. Seznam povolených metod ověřování oddělených čárkami Povolené hodnoty jsou NTLMv2 a Kerberos.
KerberosTicketEncryption Volitelné od verze 2020-04-08. Seznam povolených algoritmů šifrování lístků Kerberos oddělených čárkami Povolené hodnoty jsou RC4-HMAC a AES-256.
ChannelEncryption Volitelné od verze 2020-04-08. Seznam povolených protokolů šifrování kanálu SMB oddělených čárkami Povolené hodnoty jsou AES-128-CCM, AES-128-GCMa AES-256-GCM.

Odpověď

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

Stavový kód

Úspěšná operace vrátí stavový kód 202 (přijato).

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 Hodnota, která jednoznačně identifikuje požadavek provedený na službu.
x-ms-version Určuje verzi operace, která byla použita 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 odpovídajícími odpověďmi. Hodnota hlavičky se rovná hodnotě hlavičky, pokud se nachází v požadavku a hodnota obsahuje maximálně 1 024 viditelných x-ms-client-request-id znaků ASCII. Pokud se hlavička x-ms-client-request-id v požadavku nenachází, v odpovědi se nezobrazí.

Text odpovědi

Žádné

Autorizace

Tuto operaci může volat pouze vlastník účtu.

Poznámky

Na pravidla CORS v Azure Files platí následující omezení:

  • Je možné uložit maximálně pět pravidel.

  • Maximální velikost všech nastavení pravidel CORS v požadavku s výjimkou značek XML by neměla překročit 2 KiB.

  • Délka povolené hlavičky, zveřejněné hlavičky nebo povoleného původu by neměla překročit 256 znaků.

  • Povolené a vystavené hlavičky mohou být některé z následujících:

    • Záhlaví literálů, kde je zadaný přesný název hlavičky, například x-ms-meta-processed. V požadavku je možné zadat maximálně 64 literálových hlaviček.

    • Hlavičky s předponou, kde je k dispozici předpona hlavičky, například x-ms-meta-data*. Zadáním předpony tímto způsobem povolíte nebo zpřístupníte jakoukoli hlavičku, která touto předponou začíná. V požadavku je možné zadat maximálně dvě hlavičky s předponou.

  • Metody (nebo příkazy HTTP) zadané v elementu AllowedMethods musí odpovídat metodám podporovaným rozhraními API služby Azure Storage. Podporované metody jsou DELETE, GET, , MERGEHEAD, POST, OPTIONSa PUT.

Zadání pravidel CORS v požadavku je volitelné. Pokud zavoláte Set File Service Properties bez zadání elementu CORS v textu požadavku, budou zachována všechna existující pravidla CORS.

Pokud chcete CORS zakázat, volejte Set File Service Properties s prázdným nastavením pravidel CORS (tj </Cors>. ) a bez vnitřních pravidel CORS. Toto volání odstraní všechna existující pravidla a zakáže CORS pro službu File.

Všechny elementy pravidla CORS jsou vyžadovány, CorsRule pokud je zadaný element. Pokud některý prvek chybí, požadavek selže s kódem chyby 400 (Chybný požadavek).

Další informace o pravidlech CORS a logice vyhodnocení najdete v tématu Podpora sdílení prostředků mezi zdroji pro služby Azure Storage.

Ukázkový požadavek a odpověď

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

PUT 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žadavek se odešle s následujícím textem 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>

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

HTTP/1.1 202 Accepted  
Connection: Keep-Alive  
Transfer-Encoding: chunked  
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

Viz také

Další informace o pravidlech CORS a logice vyhodnocení najdete v tématu Podpora sdílení prostředků mezi zdroji pro služby Azure Storage.

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