Hämta filtjänstegenskaper

Artikel
07/19/2023

Åtgärden Get File Service Properties hämtar egenskaper för resursen FileService 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 File Services – Hämta tjänstegenskaper, som tillhandahålls av lagringsresursprovidern (Microsoft.Storage). Mer information om hur du programmatiskt interagerar med resursen FileService med hjälp av lagringsresursprovidern finns i Åtgärder på FileService-resursen.

Protokolltillgänglighet

Aktiverat filresursprotokoll	Tillgängligt
SMB
NFS

Förfrågan

Begäran Get File Service Properties kan anges på följande sätt. Vi rekommenderar att du använder HTTPS. Ersätt <account-name> med namnet på ditt lagringskonto:

Metod	URI för förfrågan	HTTP-version
GET	`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

I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.

Begärandehuvud	Beskrivning
`Authorization`	Krävs. Anger auktoriseringsschema, lagringskontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
`Date` eller `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 hämta måttegenskaper 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 kibibyte-teckengräns (KiB) som registreras i Azure-Lagringsanalys loggar när loggning konfigureras. 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

Inga.

Svarsåtgärder

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

Statuskod

En lyckad åtgärd returnerar statuskoden 200 (OK).

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`	Identifierar unikt en begäran som görs mot tjänsten.
`x-ms-version`	Anger vilken version av åtgärden som används 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 deras motsvarande svar. Värdet för det här huvudet ä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 finns den inte i svaret.

Själva svaret

Formatet för svarstexten 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>

Elementen i svarstexten beskrivs i följande tabell:

Name	Beskrivning
`HourMetrics`	Grupperar inställningarna för Lagringsanalys`HourMetrics`. `HourMetrics` Inställningarna ger en sammanfattning av begärandestatistik, grupperad efter API i timaggregeringar.
`MinuteMetrics`	Grupperar inställningarna för Lagringsanalys`MinuteMetrics`. `MinuteMetrics` Inställningarna tillhandahåller begärandestatistik för varje minut.
`Version`	Den version av Lagringsanalys som används för närvarande.
`Enabled`	Anger om mått är aktiverade för filtjänsten.
`IncludeAPIs`	Anger om mått genererar sammanfattningsstatistik för kallade API-åtgärder.
`RetentionPolicy/Enabled`	Anger om en kvarhållningsprincip är aktiverad för filtjänsten.
`RetentionPolicy/Days`	Anger hur många dagar måttdata ska behållas för. Alla data som är äldre än det här värdet tas bort på bästa sätt.
`Cors`	Grupperar alla CORS-regler (cross-origin resource sharing).
`CorsRule`	Grupperar inställningar för en CORS-regel.
`AllowedOrigins`	En kommaavgränsad lista över ursprungsdomäner som tillåts via CORS eller "*" om alla domäner tillåts.
`ExposedHeaders`	En kommaavgränsad lista över svarshuvuden som ska exponeras för CORS-klienter.
`MaxAgeInSeconds`	Antalet sekunder som klienten eller webbläsaren ska cachelagrat ett förhandssvar.
`AllowedHeaders`	En kommaavgränsad lista över rubriker som tillåts vara en del av begäran om korsande ursprung.
`AllowedMethods`	En kommaavgränsad lista över HTTP-metoder som kan köras av ursprunget. För Azure Files är tillåtna metoder DELETE, GET, HEAD, MERGE, POST, OPTIONS och PUT.
`ShareDeleteRetentionPolicy`	Egenskaperna för mjuk borttagning för Azure-filresurserna i det här lagringskontot.
`Days`	Anger antalet dagar som Azure-filresursen ska behållas (mjuk borttagning). Det minsta angivna värdet kan vara 1 och det maximala värdet är 365.
`Enabled`	Anger om lagringskontot har mjuk borttagning aktiverat för Azure Files.
`ProtocolSettings`	Grupperar inställningarna för filsystemprotokoll.
`SMB`	Grupperar inställningarna för Server Message Block (SMB).
`Multichannel`	Innehåller inställningarna för SMB Multichannel. Den här inställningen har en egenskap: aktiverad/inaktiverad.
`Version`	Tillgänglig från och med version 2020-04-08. En kommaavgränsad lista över tillåtna SMB-versioner. Möjliga värden: `SMB2.1`, `SMB3.0`och `SMB3.1.1`. Om `Version` inte anges är standardinställningen att alla versioner är aktiverade. SMB 2.1 är dock endast tillgängligt om lagringskontots `require secure transit` egenskap är inaktiverad, eftersom SMB 2.1 inte stöder kryptering.
`AuthenticationMethods`	Tillgänglig från och med version 2020-04-08. En kommaavgränsad lista över tillåtna autentiseringsmetoder. Möjliga värden: `NTLMv2`, `Kerberos`. Om `AuthenticationMethods` inte anges är standardinställningen att alla autentiseringsmetoder tillåts.
`KerberosTicketEncryption`	Tillgänglig från och med version 2020-04-08. En kommaavgränsad lista över tillåtna Kerberos-biljettkrypteringsalgoritmer. Möjliga värden: `RC4-HMAC` och `AES-256`. Om `KerberosTicketEncryption` inte anges är standardinställningen att alla Kerberos-biljettkrypteringsalgoritmer stöds.
`ChannelEncryption`	Tillgänglig från och med version 2020-04-08. En kommaavgränsad lista över tillåtna SMB-kanalkrypteringsprotokoll. Möjliga värden: `AES-128-CCM`, `AES-128-GCM`och `AES-256-GCM`. Om `ChannelEncryption` inte anges är standardvärdet att alla kanalkrypteringsvärden stöds. Om lagringskontots egenskap är inaktiverad tillåts `require secure transit` även okrypterad SMB-åtkomst.

Auktorisering

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

Exempel på begäran och svar

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

Metod	URL	Protokoll
GET	`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

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

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

Svaret innehåller 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>

Kommentarer

Detaljerad information om CORS-regler och utvärderingslogik finns i CORS-stöd för Azure Storage-tjänsterna.

Mer information finns i Lagringsanalys.