Eigenschappen van bestandsservice instellen

  • Artikel

De Set File Service Properties bewerking stelt eigenschappen voor de bestandsserviceresource in met behulp van de FileREST-API. Hoewel deze API volledig wordt ondersteund, is het een verouderde beheer-API. We raden u aan in plaats daarvan Bestandsservices - Service-eigenschappen instellen te gebruiken, die wordt geleverd door de Azure Storage-resourceprovider (Microsoft.Storage). Zie Bewerkingen op de bestandsservice voor meer informatie over programmatisch communiceren met de bestandsserviceresource met behulp van de Azure Storage-resourceprovider.

Protocol beschikbaarheid

Bestandsshareprotocol ingeschakeld Beschikbaar
SMB Ja
NFS Ja

Aanvraag

U kunt de Set File Service Properties aanvraag als volgt opgeven. U wordt aangeraden HTTPS te gebruiken. Vervang accountnaam door de naam van uw opslagaccount:

Methode Aanvraag-URI HTTP-versie
PUT 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

De vereiste en optionele aanvraagheaders worden beschreven in de volgende tabel:

Aanvraagheader Beschrijving
Authorization Vereist. Hiermee geeft u het autorisatieschema, de naam van het opslagaccount en de handtekening op. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
Date or x-ms-date Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren 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 2015-02-21 en hoger. Als u metrische gegevens wilt inschakelen voor de bestandsservice, 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 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

De indeling van de aanvraagbody 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>

Het is niet nodig om elk hoofdelement in de aanvraag op te geven. Als u een hoofdelement weglaat, blijven de bestaande instellingen voor de service voor die functionaliteit behouden. Als u echter een bepaald hoofdelement opgeeft, moet u elk onderliggend element voor dat element opgeven. De hoofdelementen zijn onder andere:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

De elementen van de aanvraagbody worden beschreven in de volgende tabel:

Naam Beschrijving
HourMetrics Optioneel voor versie 2015-04-05 en hoger. Niet van toepassing op eerdere versies. Groepeert de Opslaganalyse-instellingenHourMetrics, die een overzicht bieden van aanvraagstatistieken gegroepeerd per API in aggregaties per uur.
MinuteMetrics Optioneel voor versie 2015-04-05 en hoger. Niet van toepassing op eerdere versies. Hiermee worden de Opslaganalyse MinuteMetrics instellingen gegroepeerd, die aanvraagstatistieken voor elke minuut bieden.
Version Vereist als metrische gegevens zijn ingeschakeld. De versie van Opslaganalyse die moet worden geconfigureerd. Gebruik 1.0 voor deze waarde.
Enabled Vereist. Geeft aan of metrische gegevens zijn ingeschakeld voor de bestandsservice.
IncludeAPIs Alleen vereist als metrische gegevens zijn ingeschakeld. Geeft aan of metrische gegevens samenvattingsstatistieken moeten genereren voor aangeroepen API-bewerkingen.
RetentionPolicy/Enabled Vereist. Hiermee wordt aangegeven of een bewaarbeleid is ingeschakeld voor de bestandsservice. Als dit onwaar is, blijven de metrische gegevens behouden en is de gebruiker verantwoordelijk voor het verwijderen ervan.
RetentionPolicy/Days Alleen vereist als een bewaarbeleid is ingeschakeld. Geeft het aantal dagen aan dat metrische gegevens moeten worden bewaard. Alle gegevens die ouder zijn dan deze waarde, worden verwijderd. Het minimum dat u kunt opgeven is 1en de maximumwaarde is 365 (één jaar). Metrische gegevens worden naar beste vermogen verwijderd nadat de retentieperiode is verstreken.
Cors Optioneel. Het Cors element wordt ondersteund voor versie 21-02-2015 en hoger. Hiermee worden alle CORS-regels (Cross-Origin Resource Sharing) gegroepeerd. Als u deze elementgroep weglaat, worden bestaande CORS-instellingen niet overschreven.
CorsRule Optioneel. Hiermee geeft u een CORS-regel voor de bestandsservice. U kunt maximaal vijf CorsRule-elementen opnemen in de aanvraag. Als er geen CorsRule elementen zijn opgenomen in de hoofdtekst van de aanvraag, worden alle CORS-regels verwijderd en WORDT CORS uitgeschakeld voor de bestandsservice.
AllowedOrigins Vereist als het CorsRule element aanwezig is. Een door komma's gescheiden lijst met oorsprongsdomeinen die zijn toegestaan via CORS, of '*' om alle domeinen toe te staan. Een oorspronkelijk domein kan ook een jokerteken bevatten in het subdomein om aanvragen via CORS toe te laten voor alle subdomeinen van een domein. Beperkt tot 64 oorsprongsdomeinen. Elke toegestane oorsprong mag maximaal 256 tekens bevatten.
ExposedHeaders Vereist als het CorsRule element aanwezig is. Een door komma's gescheiden lijst met antwoordheaders om beschikbaar te maken voor CORS-clients. Beperkt tot 64 gedefinieerde headers en twee kopteksten met voorvoegsel. Elke koptekst mag maximaal 256 tekens bevatten.
MaxAgeInSeconds Vereist als het CorsRule element aanwezig is. Het aantal seconden dat de client/browser een voorbereidend antwoord in de cache moet opslaan.
AllowedHeaders Vereist als het CorsRule element bestaat. Een door komma's gescheiden lijst met kopteksten die deel mogen uitmaken van de cross-origin-aanvraag. Beperkt tot 64 gedefinieerde headers en 2 voorvoegsels. Elke koptekst mag maximaal 256 tekens bevatten.
AllowedMethods Vereist als CorsRule het element bestaat. Een door komma's gescheiden lijst met HTTP-methoden die door de oorsprong mogen worden uitgevoerd. Voor Azure Files zijn DELETEde toegestane methoden , GET, HEAD, MERGE, , POST, OPTIONSen PUT.
ShareDeleteRetentionPolicy Optioneel. De eigenschappen voor voorlopig verwijderen voor de Azure-bestandsshares in dit opslagaccount.
Days Optioneel. Geeft het aantal dagen aan dat de Azure-bestandsshare moet worden bewaard (voorlopig verwijderd). Het minimum dat u kunt opgeven is 1, en de maximumwaarde is 365 (één jaar).
Enabled Optioneel. Hiermee wordt aangegeven of voor het opslagaccount voorlopig verwijderen is ingeschakeld voor Azure Files.
ProtocolSettings Optioneel. Groepeert de instellingen voor bestandssysteemprotocollen.
SMB Optioneel. Hiermee worden de instellingen voor SMB gegroepeerd.
Multichannel Optioneel. Bevat de instellingen voor SMB meerdere kanalen. SMB meerdere kanalen bevat de Enabled booleaanse eigenschap, waarmee de status van SMB meerdere kanalen wordt ingeschakeld.
Version Optioneel vanaf versie 2020-04-08. Door komma's gescheiden lijst met toegestane SMB-versies. Toegestane waarden zijn SMB2.1, SMB3.0en SMB3.1.1.
AuthenticationMethods Optioneel vanaf versie 2020-04-08. Door komma's gescheiden lijst met toegestane verificatiemethoden. Toegestane waarden zijn NTLMv2 en Kerberos.
KerberosTicketEncryption Optioneel vanaf versie 2020-04-08. Door komma's gescheiden lijst met toegestane Kerberos-ticketversleutelingsalgoritmen. Toegestane waarden zijn RC4-HMAC en AES-256.
ChannelEncryption Optioneel vanaf versie 2020-04-08. Door komma's gescheiden lijst met toegestane SMB-kanaalversleutelingsprotocollen. Toegestane waarden zijn AES-128-CCM, AES-128-GCMen AES-256-GCM.

Antwoord

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

Statuscode

Een geslaagde bewerking retourneert statuscode 202 (Geaccepteerd).

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 Een waarde die een unieke identificatie vormt van een aanvraag die is ingediend bij de service.
x-ms-version Hiermee geeft u de versie van de bewerking op die is 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 bijbehorende antwoorden op te lossen. De waarde van de header is gelijk aan de waarde van de header als deze x-ms-client-request-id 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

Geen.

Autorisatie

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

De volgende beperkingen en beperkingen zijn van toepassing op CORS-regels in Azure Files:

  • Er kunnen maximaal vijf regels worden opgeslagen.

  • De maximale grootte van alle CORS-regels voor de aanvraag, met uitzondering van XML-tags, mag niet groter zijn dan 2 KiB.

  • De lengte van een toegestane koptekst, weergegeven koptekst of toegestane oorsprong mag niet langer zijn dan 256 tekens.

  • Toegestane headers en weergegeven headers kunnen een van de volgende zijn:

    • Letterlijke headers, waarbij de exacte headernaam wordt opgegeven, zoals x-ms-meta-processed. Er kunnen maximaal 64 letterlijke headers worden opgegeven voor de aanvraag.

    • Kopteksten met voorvoegsel, waarbij een voorvoegsel van de koptekst wordt opgegeven, zoals x-ms-meta-data*. Als u op deze manier een voorvoegsel opgeeft, wordt elke koptekst die met dat voorvoegsel begint, toegestaan of weergegeven. Er kunnen maximaal twee voorvoegsels worden opgegeven voor de aanvraag.

  • De methoden (of HTTP-woorden) die in het AllowedMethods element zijn opgegeven, moeten voldoen aan de methoden die worden ondersteund door de Api's van de Azure Storage-service. Ondersteunde methoden zijn DELETE, GET, HEAD, MERGE, POST, , OPTIONSen PUT.

Het opgeven van CORS-regels voor de aanvraag is optioneel. Als u aanroept Set File Service Properties zonder het CORS-element in de aanvraagbody op te geven, blijven alle bestaande CORS-regels behouden.

Als u CORS wilt uitschakelen, roept Set File Service Properties u aan met een lege CORS-regelinstelling (dat wil gezegd, </Cors>) en geen interne CORS-regels. Met deze aanroep worden alle bestaande regels verwijderd en CORS voor de bestandsservice uitgeschakeld.

Alle CORS-regelelementen zijn vereist als het CorsRule element is opgegeven. De aanvraag mislukt met foutcode 400 (ongeldige aanvraag) als er een element ontbreekt.

Zie Cross-origin resource sharing support for the Azure Storage services (Ondersteuning voor cross-origin resource sharing voor de Azure Storage-services) voor meer informatie over CORS-regels en evaluatielogica.

Voorbeeld van aanvraag en antwoord

Met de volgende voorbeeld-URI wordt een aanvraag ingediend om de eigenschappen van de bestandsservice te wijzigen voor een opslagaccount met de naam myaccount:

PUT 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

De aanvraag wordt verzonden met 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>

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

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

Zie ook

Zie Cross-origin resource sharing support for the Azure Storage services (Ondersteuning voor cross-origin resource sharing voor de Azure Storage-services) voor meer informatie over CORS-regels en evaluatielogica.

Zie Opslaganalyse voor meer informatie over Opslaganalyse.