Ange egenskaper för filtjänst

  • Artikel

Åtgärden Set File Service Properties anger egenskaper för filtjänstresursen med hjälp av FileREST-API:et. Även om det här API:et stöds fullt ut är det ett äldre hanterings-API. Vi rekommenderar att du i stället använder Filtjänster – Ange tjänstegenskaper, som tillhandahålls av Azure Storage-resursprovidern (Microsoft.Storage). Mer information om hur du interagerar programmatiskt med filtjänstresursen med hjälp av Azure Storage-resursprovidern finns i Åtgärder på filtjänsten.

Protokolltillgänglighet

Aktiverat filresursprotokoll Tillgängligt
SMB Ja
NFS Yes

Förfrågan

Du kan ange begäran på Set File Service Properties följande sätt. Vi rekommenderar att du använder HTTPS. Ersätt kontonamn med namnet på ditt lagringskonto:

Metod URI för förfrågan HTTP-version
PUT https://account-name.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Anteckning

URI:n måste alltid innehålla ett snedstreck (/) för att skilja värdnamnet från sökvägen och frågedelarna i URI:n. I den här åtgärden är sökvägsdelen av URI:n tom.

URI-parametrar

URI-parameter Description
restype=service&comp=properties Krävs. Kombinationen av båda frågesträngarna krävs för att ange egenskaperna för lagringstjänsten.
timeout Valfritt. Parametern timeout uttrycks i sekunder. Mer information finns i Ange tidsgränser för filtjänståtgärder.

Begärandehuvuden

De obligatoriska och valfria begärandehuvudena beskrivs i följande tabell:

Begärandehuvud Beskrivning
Authorization Krävs. Anger auktoriseringsschema, lagringskontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
Date or x-ms-date Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage.
x-ms-version Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Den här åtgärden är endast tillgänglig i version 2015-02-21 och senare. Om du vill aktivera mått för filtjänsten måste du ange version 2015-04-05 eller senare.

Mer information finns i Versionshantering för Azure Storage-tjänsterna.
x-ms-client-request-id Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i Lagringsanalys loggarna när loggning har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Files.

Begärandetext

Formatet för begärandetexten för version 2020-02-10 är följande:

<?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>

Det är inte nödvändigt att ange varje rotelement i begäran. Om du utelämnar ett rotelement bevaras de befintliga inställningarna för tjänsten för den funktionen. Men om du anger ett visst rotelement måste du ange varje underordnat element för det elementet. Rotelementen omfattar:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

Elementen i begärandetexten beskrivs i följande tabell:

Name Beskrivning
HourMetrics Valfritt för version 2015-04-05 och senare. Gäller inte för tidigare versioner. Grupperar inställningarna för LagringsanalysHourMetrics, som ger en sammanfattning av begärandestatistik grupperad efter API i timaggregeringar.
MinuteMetrics Valfritt för version 2015-04-05 och senare. Gäller inte för tidigare versioner. Grupperar inställningarna för LagringsanalysMinuteMetrics, som tillhandahåller statistik för begäranden för varje minut.
Version Krävs om mått är aktiverade. Den version av Lagringsanalys som ska konfigureras. Använd 1.0 för det här värdet.
Enabled Krävs. Anger om mått är aktiverade för filtjänsten.
IncludeAPIs Krävs endast om mått är aktiverade. Anger om mått ska generera sammanfattningsstatistik för så kallade API-åtgärder.
RetentionPolicy/Enabled Krävs. Anger om en kvarhållningsprincip är aktiverad för filtjänsten. Om det är falskt behålls måttdata och användaren ansvarar för att ta bort dem.
RetentionPolicy/Days Krävs endast om en kvarhållningsprincip är aktiverad. Anger hur många dagar som måttdata ska behållas. Alla data som är äldre än det här värdet tas bort. Det minsta du kan ange är 1, och det maximala värdet är 365 (ett år). Måttdata tas bort efter bästa förmåga när kvarhållningsperioden går ut.
Cors Valfritt. Elementet Cors stöds för version 2015-02-21 och senare. Grupperar alla CORS-regler (cross-origin resource sharing). Om du utelämnar den här elementgruppen skrivs inte befintliga CORS-inställningar över.
CorsRule Valfritt. Anger en CORS-regel för filtjänsten. Du kan inkludera upp till fem CorsRule-element i begäran. Om inga CorsRule element ingår i begärandetexten tas alla CORS-regler bort och CORS inaktiveras för filtjänsten.
AllowedOrigins Krävs om elementet CorsRule finns. En kommaavgränsad lista över ursprungsdomäner som tillåts via CORS eller "*" för att tillåta alla domäner. En ursprungsdomän kan också innehålla jokertecken i underdomänen för att tillåta begäranden via CORS för alla underdomäner i en domän. Begränsat till 64 ursprungsdomäner. Varje tillåtet ursprung kan innehålla upp till 256 tecken.
ExposedHeaders Krävs om elementet CorsRule finns. En kommaavgränsad lista över svarshuvuden som ska exponeras för CORS-klienter. Begränsat till 64 definierade rubriker och två prefixrubriker. Varje rubrik kan innehålla upp till 256 tecken.
MaxAgeInSeconds Krävs om elementet CorsRule finns. Antalet sekunder som klienten/webbläsaren ska cachelagrat ett förhandssvar.
AllowedHeaders Krävs om elementet CorsRule finns. En kommaavgränsad lista över rubriker som tillåts vara en del av begäran om korsande ursprung. Begränsat till 64 definierade rubriker och 2 prefixrubriker. Varje rubrik kan innehålla upp till 256 tecken.
AllowedMethods Krävs om CorsRule elementet finns. En kommaavgränsad lista över HTTP-metoder som kan köras av ursprunget. För Azure Files är DELETEde tillåtna metoderna , GET, HEAD, MERGE, POST, OPTIONSoch PUT.
ShareDeleteRetentionPolicy Valfritt. Egenskaperna för mjuk borttagning för Azure-filresurserna i det här lagringskontot.
Days Valfritt. Anger antalet dagar som Azure-filresursen ska behållas (mjuk borttagning). Det minsta du kan ange är 1, och det maximala värdet är 365 (ett år).
Enabled Valfritt. Anger om lagringskontot har mjuk borttagning aktiverat för Azure Files.
ProtocolSettings Valfritt. Grupperar inställningarna för filsystemprotokoll.
SMB Valfritt. Grupperar inställningarna för SMB.
Multichannel Valfritt. Innehåller inställningarna för SMB multichannel. SMB multichannel innehåller den Enabled booleska egenskapen, som växlar tillståndet för SMB multichannel.
Version Valfritt från och med version 2020-04-08. Kommaavgränsad lista över tillåtna SMB-versioner. Tillåtna värden är SMB2.1, SMB3.0och SMB3.1.1.
AuthenticationMethods Valfritt från och med version 2020-04-08. Kommaavgränsad lista över tillåtna autentiseringsmetoder. Tillåtna värden är NTLMv2 och Kerberos.
KerberosTicketEncryption Valfritt från och med version 2020-04-08. Kommaavgränsad lista över tillåtna Kerberos-biljettkrypteringsalgoritmer. Tillåtna värden är RC4-HMAC och AES-256.
ChannelEncryption Valfritt från och med version 2020-04-08. Kommaavgränsad lista över tillåtna SMB-kanalkrypteringsprotokoll. Tillåtna värden är AES-128-CCM, AES-128-GCMoch AES-256-GCM.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod och en uppsättning svarshuvuden.

Statuskod

En lyckad åtgärd returnerar statuskoden 202 (accepterad).

Svarshuvuden

Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarsrubrik Description
x-ms-request-id Ett värde som unikt identifierar en begäran som görs mot tjänsten.
x-ms-version Anger vilken version av åtgärden som användes för svaret. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
x-ms-client-request-id Kan användas för att felsöka begäranden och motsvarande svar. Värdet för rubriken är lika med värdet x-ms-client-request-id för huvudet om det finns i begäran och värdet inte innehåller fler än 1 024 synliga ASCII-tecken. x-ms-client-request-id Om rubriken inte finns i begäran visas den inte i svaret.

Själva svaret

Inga.

Auktorisering

Endast kontoägaren kan anropa den här åtgärden.

Kommentarer

Följande begränsningar och begränsningar gäller för CORS-regler i Azure Files:

  • Högst fem regler kan lagras.

  • Den maximala storleken på alla CORS-regelinställningar för begäran, exklusive XML-taggar, får inte överstiga 2 KiB.

  • Längden på ett tillåtet huvud, ett exponerat huvud eller ett tillåtet ursprung får inte överstiga 256 tecken.

  • Tillåtna rubriker och synliga rubriker kan vara något av följande:

    • Literalrubriker, där det exakta rubriknamnet anges, till exempel x-ms-meta-processed. Högst 64 literalrubriker kan anges i begäran.

    • Prefixrubriker, där ett prefix för huvudet anges, till exempel x-ms-meta-data*. Om du anger ett prefix på det här sättet tillåts eller exponeras alla rubriker som börjar med prefixet. Högst två prefixrubriker kan anges i begäran.

  • De metoder (eller HTTP-verb) som anges i elementet AllowedMethods måste överensstämma med de metoder som stöds av Azure Storage-tjänstens API:er. Metoder som stöds är DELETE, GET, HEAD, MERGE, POST, OPTIONSoch PUT.

Det är valfritt att ange CORS-regler för begäran. Om du anropar Set File Service Properties utan att ange CORS-elementet i begärandetexten underhålls alla befintliga CORS-regler.

Om du vill inaktivera CORS anropar du Set File Service Properties med en tom CORS-regelinställning (d.v.s </Cors>. ) och inga inre CORS-regler. Det här anropet tar bort alla befintliga regler och inaktiverar CORS för filtjänsten.

Alla CORS-regelelement krävs om elementet CorsRule anges. Begäran misslyckas med felkoden 400 (felaktig begäran) om något element saknas.

Mer information om CORS-regler och utvärderingslogik finns i Stöd för resursdelning mellan ursprung för Azure Storage-tjänsterna.

Exempel på begäran och svar

Följande exempel-URI gör en begäran om att ändra filtjänstegenskaperna för ett lagringskonto med namnet myaccount:

PUT https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Begäran skickas med följande rubriker:

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

Begäran skickas med följande XML-brödtext:

<?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>

När begäran har skickats returneras följande svar:

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

Se även

Mer information om CORS-regler och utvärderingslogik finns i Stöd för resursdelning mellan ursprung för Azure Storage-tjänsterna.

Mer information om Lagringsanalys finns i Lagringsanalys.