Eigenschappen van bestandsservice ophalen

Artikel
07/19/2023

Met Get File Service Properties de bewerking worden eigenschappen voor de FileService resource opgehaald met behulp van de FileREST-API. Hoewel deze API volledig wordt ondersteund, is het een verouderde beheer-API. U wordt aangeraden in plaats daarvan Bestandsservices - Service-eigenschappen ophalen te gebruiken, die wordt geleverd door de opslagresourceprovider (Microsoft.Storage). Zie Bewerkingen op de FileServiceFileService-resource voor meer informatie over programmatische interactie met de resource met behulp van de opslagresourceprovider.

Protocol beschikbaarheid

Bestandsshareprotocol ingeschakeld	Beschikbaar
SMB
NFS

Aanvraag

De Get File Service Properties aanvraag kan als volgt worden opgegeven. U wordt aangeraden HTTPS te gebruiken. Vervang door <account-name> de naam van uw opslagaccount:

Methode	Aanvraag-URI	HTTP-versie
GET	`https://<account-name>.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Notitie

De URI moet altijd een slash (/) bevatten om de hostnaam te scheiden van het pad en de querygedeelten van de URI. In deze bewerking is het padgedeelte van de URI leeg.

URI-parameters

URI-parameter	Beschrijving
`restype=service&comp=properties`	Vereist. De combinatie van beide queryreeksen is vereist om de eigenschappen van de opslagservice in te stellen.
`timeout`	Optioneel. De `timeout` parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor bestandsservicebewerkingen voor meer informatie.

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de naam van het opslagaccount en de handtekening op. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`Date` of `x-ms-date`	Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`x-ms-version`	Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Deze bewerking is alleen beschikbaar in versie 21-02-2015 en hoger. Als u eigenschappen van metrische gegevens voor de bestandsservice wilt ophalen, moet u versie 2015-04-05 of hoger opgeven. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de Azure Opslaganalyse-logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Files bewaken voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst.

Statuscode

Een geslaagde bewerking retourneert statuscode 200 (OK).

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook aanvullende standaard-HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Beschrijving
`x-ms-request-id`	Identificeert op unieke wijze een aanvraag die is ingediend bij de service.
`x-ms-version`	Hiermee geeft u de versie van de bewerking op die wordt gebruikt voor het antwoord. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Kan worden gebruikt om problemen met aanvragen en de bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de `x-ms-client-request-id` header als deze aanwezig is in de aanvraag en de waarde niet meer dan 1024 zichtbare ASCII-tekens bevat. Als de `x-ms-client-request-id` header niet aanwezig is in de aanvraag, is deze niet aanwezig in het antwoord.

Hoofdtekst van de reactie

De indeling van de antwoordtekst voor versie 2020-02-10 is als volgt:

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

De elementen van de hoofdtekst van het antwoord worden beschreven in de volgende tabel:

Naam	Beschrijving
`HourMetrics`	Groepeert de Opslaganalyse-instellingen`HourMetrics`. De `HourMetrics` instellingen bieden een overzicht van aanvraagstatistieken, gegroepeerd per API in aggregaties per uur.
`MinuteMetrics`	Groepeert de Opslaganalyse-instellingen`MinuteMetrics`. De `MinuteMetrics` instellingen bieden aanvraagstatistieken voor elke minuut.
`Version`	De versie van Opslaganalyse die momenteel in gebruik is.
`Enabled`	Hiermee wordt aangegeven of metrische gegevens zijn ingeschakeld voor de Bestandsservice.
`IncludeAPIs`	Geeft aan of metrische gegevens samenvattingsstatistieken genereren voor aangeroepen API-bewerkingen.
`RetentionPolicy/Enabled`	Hiermee wordt aangegeven of een bewaarbeleid is ingeschakeld voor de bestandsservice.
`RetentionPolicy/Days`	Geeft het aantal dagen aan dat metrische gegevens worden bewaard. Alle gegevens die ouder zijn dan deze waarde, worden naar beste vermogen verwijderd.
`Cors`	Hiermee worden alle CORS-regels (Cross-Origin Resource Sharing) gegroepeerd.
`CorsRule`	Groepeert instellingen voor een CORS-regel.
`AllowedOrigins`	Een door komma's gescheiden lijst met oorspronkelijke domeinen die zijn toegestaan via CORS, of '*' als alle domeinen zijn toegestaan.
`ExposedHeaders`	Een door komma's gescheiden lijst met antwoordheaders om beschikbaar te maken voor CORS-clients.
`MaxAgeInSeconds`	Het aantal seconden dat de client of browser een preflight-reactie in de cache moet opslaan.
`AllowedHeaders`	Een door komma's gescheiden lijst met kopteksten die deel mogen uitmaken van de cross-origin-aanvraag.
`AllowedMethods`	Een door komma's gescheiden lijst met HTTP-methoden die door de oorsprong mogen worden uitgevoerd. Voor Azure Files zijn de toegestane methoden DELETE, GET, HEAD, MERGE, POST, OPTIONS en PUT.
`ShareDeleteRetentionPolicy`	De eigenschappen voor voorlopig verwijderen voor de Azure-bestandsshares in dit opslagaccount.
`Days`	Geeft het aantal dagen aan dat de Azure-bestandsshare moet worden bewaard (voorlopig verwijderd). De minimaal opgegeven waarde kan 1 zijn en de maximumwaarde is 365.
`Enabled`	Hiermee wordt aangegeven of voor het opslagaccount voorlopig verwijderen is ingeschakeld voor Azure Files.
`ProtocolSettings`	Groepeert de instellingen voor bestandssysteemprotocollen.
`SMB`	Hiermee worden de instellingen voor Server Message Block (SMB) gegroepeerd.
`Multichannel`	Bevat de instellingen voor SMB meerdere kanalen. Deze instelling heeft één eigenschap: ingeschakeld/uitgeschakeld.
`Version`	Beschikbaar vanaf versie 2020-04-08. Een door komma's gescheiden lijst met toegestane SMB-versies. Mogelijke waarden: `SMB2.1`, `SMB3.0`en `SMB3.1.1`. Als `Version` niet is opgegeven, is de standaardinstelling dat alle versies zijn ingeschakeld. SMB 2.1 is echter alleen beschikbaar als de eigenschap van `require secure transit` het opslagaccount is uitgeschakeld, omdat SMB 2.1 geen ondersteuning biedt voor versleuteling.
`AuthenticationMethods`	Beschikbaar vanaf versie 2020-04-08. Een door komma's gescheiden lijst met toegestane verificatiemethoden. Mogelijke waarden: `NTLMv2`, `Kerberos`. Als `AuthenticationMethods` niet is opgegeven, is de standaardinstelling dat alle verificatiemethoden zijn toegestaan.
`KerberosTicketEncryption`	Beschikbaar vanaf versie 2020-04-08. Een door komma's gescheiden lijst met toegestane Kerberos-ticketversleutelingsalgoritmen. Mogelijke waarden: `RC4-HMAC` en `AES-256`. Als `KerberosTicketEncryption` niet is opgegeven, is de standaardinstelling dat alle Kerberos-ticketversleutelingsalgoritmen worden ondersteund.
`ChannelEncryption`	Beschikbaar vanaf versie 2020-04-08. Een door komma's gescheiden lijst met toegestane SMB-kanaalversleutelingsprotocollen. Mogelijke waarden: `AES-128-CCM`, `AES-128-GCM`en `AES-256-GCM`. Als `ChannelEncryption` niet is opgegeven, is de standaardinstelling dat alle kanaalversleutelingswaarden worden ondersteund. Als de eigenschap van `require secure transit` het opslagaccount is uitgeschakeld, is ook niet-versleutelde SMB-toegang toegestaan.

Autorisatie

Alleen de eigenaar van het opslagaccount kan deze bewerking aanroepen.

Voorbeeld van aanvraag en antwoord

De volgende voorbeeld-URI doet een aanvraag om de bestandsservice-eigenschappen op te halen voor een opslagaccount met de naam myaccount:

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

De aanvraag wordt verzonden met de volgende headers:

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

Nadat de aanvraag is verzonden, wordt het volgende antwoord geretourneerd:

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

Het antwoord bevat de volgende XML-hoofdtekst:

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

Opmerkingen

Zie CORS-ondersteuning voor de Azure Storage-services voor gedetailleerde informatie over CORS-regels en evaluatielogica.

Zie Opslaganalyse voor meer informatie.