Dateidiensteigenschaften festlegen

  • Artikel

Der Set File Service Properties Vorgang legt Eigenschaften für die Dateidienstressource mithilfe der FileREST-API fest. Obwohl diese API vollständig unterstützt wird, handelt es sich um eine Legacyverwaltungs-API. Es wird empfohlen, stattdessen Dateidienste – Festlegen von Diensteigenschaften zu verwenden, die vom Azure Storage-Ressourcenanbieter (Microsoft.Storage) bereitgestellt werden. Weitere Informationen zur programmgesteuerten Interaktion mit der Dateidienstressource mithilfe des Azure Storage-Ressourcenanbieters finden Sie unter Vorgänge im Dateidienst.

Protokollverfügbarkeit

Aktiviertes Dateifreigabeprotokoll Verfügbar
SMB Ja
NFS Ja

Anforderung

Sie können die Set File Service Properties Anforderung wie folgt angeben. Es wird empfohlen, HTTPS zu verwenden. Ersetzen Sie account-name durch den Namen Ihres Speicherkontos:

Methode Anforderungs-URI HTTP-Version
PUT https://account-name.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Hinweis

Der URI muss immer einen Schrägstrich (/) enthalten, um den Hostnamen von den Pfad- und Abfrageabschnitten des URI zu trennen. In diesem Vorgang ist der Pfadteil des URI leer.

URI-Parameter

URI-Parameter Beschreibung
restype=service&comp=properties Erforderlich. Zum Festlegen der Speicherdiensteigenschaften ist die Kombination beider Abfragezeichenfolgen erforderlich.
timeout Optional. Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Dateidienstvorgänge.

Anforderungsheader

Die erforderlichen und optionalen Anforderungsheader werden in der folgenden Tabelle beschrieben:

Anforderungsheader BESCHREIBUNG
Authorization Erforderlich. Gibt das Autorisierungsschema, den Namen des Speicherkontos und die Signatur an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
Date or x-ms-date Erforderlich. Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
x-ms-version Erforderlich für alle autorisierten Anforderungen. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Dieser Vorgang ist nur ab Version 2015-02-21 verfügbar. Zum Aktivieren von Metriken für den Dateidienst müssen Sie Version 2015-04-05 oder höher angeben.

Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
x-ms-client-request-id Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Zeichenlimit von 1 Kibibyte (KiB) bereit, der beim Konfigurieren der Protokollierung in den Storage Analytics Protokollen aufgezeichnet wird. Es wird dringend empfohlen, diesen Header zu verwenden, um clientseitige Aktivitäten mit Anforderungen zu korrelieren, die der Server empfängt. Weitere Informationen finden Sie unter Überwachen Azure Files.

Anforderungstext

Das Format des Anforderungstexts für Version 2020-02-10 lautet wie folgt:

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

Es ist nicht erforderlich, jedes Stammelement für die Anforderung anzugeben. Wenn Sie ein Stammelement weglassen, werden die vorhandenen Diensteinstellungen für die jeweiligen Funktionen beibehalten. Wenn Sie jedoch ein bestimmtes Stammelement angeben, müssen Sie jedes untergeordnete Element für dieses Element angeben. Die Stammelemente umfassen:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

Die Elemente des Anforderungstexts werden in der folgenden Tabelle beschrieben:

Name BESCHREIBUNG
HourMetrics Optional für Version 2015-04-05 und höher. Gilt nicht für frühere Versionen. Gruppiert die Storage Analytics HourMetrics Einstellungen, die eine Nach API gruppierte Zusammenfassung der Anforderungsstatistiken in Stündchenaggregaten bereitstellen.
MinuteMetrics Optional für Version 2015-04-05 und höher. Gilt nicht für frühere Versionen. Gruppiert die Storage Analytics MinuteMetrics Einstellungen, die Anforderungsstatistiken für jede Minute bereitstellen.
Version Erforderlich, wenn Metriken aktiviert sind. Die Version der zu konfigurierenden Speicheranalyse. Verwenden Sie 1.0 für diesen Wert.
Enabled Erforderlich. Gibt an, ob Metriken für den Dateidienst aktiviert sind.
IncludeAPIs Nur erforderlich, wenn Metriken aktiviert sind. Gibt an, ob Metriken Zusammenfassungsstatistiken für aufgerufene API-Vorgänge generieren sollen.
RetentionPolicy/Enabled Erforderlich. Gibt an, ob eine Aufbewahrungsrichtlinie für den Dateidienst aktiviert ist. Wenn false, werden Metrikdaten beibehalten, und der Benutzer ist für das Löschen verantwortlich.
RetentionPolicy/Days Nur erforderlich, wenn eine Beibehaltungsrichtlinie aktiviert ist. Gibt die Anzahl der Tage an, in denen Metrikdaten aufbewahrt werden sollen. Alle Daten, die älter als dieser Wert sind, werden gelöscht. Das Minimum, das Sie angeben können, ist 1, und der Maximalwert ist 365 (ein Jahr). Metrikdaten werden nach Ablauf des Aufbewahrungszeitraums mit best-effort gelöscht.
Cors Optional. Das Cors Element wird ab Version 2015-02-21 unterstützt. Gruppiert alle CORS-Regeln (Cross-Origin Resource Sharing). Wenn Sie diese Elementgruppe weglassen, werden vorhandene CORS-Einstellungen nicht überschrieben.
CorsRule Optional. Gibt eine CORS-Regel für den Dateidienst an. In der Anforderung können bis zu fünf CorsRule-Elemente enthalten sein. Wenn keine CorsRule Elemente im Anforderungstext enthalten sind, werden alle CORS-Regeln gelöscht, und CORS ist für den Dateidienst deaktiviert.
AllowedOrigins Erforderlich, wenn das CorsRule Element vorhanden ist. Eine durch Trennzeichen getrennte Liste von Ursprungsdomänen, die über CORS zulässig sind, oder "*", um alle Domänen zuzulassen. Eine Ursprungsdomäne kann auch ein Platzhalterzeichen in der Unterdomäne enthalten, um Anforderungen über CORS für alle Unterdomänen einer Domäne zuzulassen. Auf 64 Ursprungsdomänen begrenzt. Jede zulässige Ursprungsdomäne darf bis zu 256 Zeichen aufweisen.
ExposedHeaders Erforderlich, wenn das CorsRule Element vorhanden ist. Eine durch Trennzeichen getrennte Liste mit Antwortheadern, die für CORS-Clients verfügbar gemacht werden sollen. Auf 64 definierte Header und zwei Header mit Präfix begrenzt. Jeder Header kann bis zu 256 Zeichen enthalten.
MaxAgeInSeconds Erforderlich, wenn das CorsRule Element vorhanden ist. Gibt an, wie viele Sekunden eine Preflight-Antwort vom Client/Browser zwischengespeichert werden soll.
AllowedHeaders Erforderlich, wenn das CorsRule Element vorhanden ist. Eine durch Trennzeichen getrennte Liste von Headern, die Teil der ursprungsübergreifenden Anforderung sein dürfen. Auf 64 definierte Header und zwei Header mit Präfix begrenzt. Jeder Header kann bis zu 256 Zeichen enthalten.
AllowedMethods Erforderlich, wenn das CorsRule-Element existiert. Eine durch Trennzeichen getrennte Liste von HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen. Für Azure Files sind DELETEdie zulässigen Methoden , , GET, HEADMERGE, POST, OPTIONSund PUT.
ShareDeleteRetentionPolicy Optional. Die Eigenschaften des vorläufigen Löschens für die Azure-Dateifreigaben in diesem Speicherkonto.
Days Optional. Gibt die Anzahl der Tage an, die die Azure-Dateifreigabe beibehalten (vorläufig gelöscht) werden soll. Das Minimum, das Sie angeben können, ist 1, und der Maximalwert ist 365 (ein Jahr).
Enabled Optional. Gibt an, ob für das Speicherkonto vorläufiges Löschen für Azure Files aktiviert ist.
ProtocolSettings Optional. Gruppiert die Einstellungen für Dateisystemprotokolle.
SMB Optional. Gruppiert die Einstellungen für SMB.
Multichannel Optional. Enthält die Einstellungen für SMB Multichannel. SMB Multichannel enthält die Enabled boolesche Eigenschaft, die den Zustand von SMB Multichannel umgeschaltet.
Version Optional ab Version 2020-04-08. Durch Trennzeichen getrennte Liste der zulässigen SMB-Versionen. Zulässige Werte sind SMB2.1, SMB3.0 und SMB3.1.1.
AuthenticationMethods Optional ab Version 2020-04-08. Durch Trennzeichen getrennte Liste der zulässigen Authentifizierungsmethoden. Zulässige Werte sind NTLMv2 und Kerberos.
KerberosTicketEncryption Optional ab Version 2020-04-08. Durch Trennzeichen getrennte Liste der zulässigen Kerberos-Ticketverschlüsselungsalgorithmen. Zulässige Werte sind RC4-HMAC und AES-256.
ChannelEncryption Optional ab Version 2020-04-08. Durch Trennzeichen getrennte Liste der zulässigen SMB-Kanalverschlüsselungsprotokolle. Zulässige Werte sind AES-128-CCM, AES-128-GCM und AES-256-GCM.

Antwort

Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.

Statuscode

Ein erfolgreicher Vorgang gibt den Statuscode 202 (Akzeptiert) zurück.

Antwortheader

Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann außerdem weitere HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.

Antwortheader BESCHREIBUNG
x-ms-request-id Ein Wert, der eine Anforderung eindeutig identifiziert, die für den Dienst gestellt wird.
x-ms-version Gibt die Version des Vorgangs an, der für die Antwort verwendet wurde. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
x-ms-client-request-id Kann verwendet werden, um Anforderungen und entsprechende Antworten zu behandeln. Der Wert des Headers ist gleich dem Wert des x-ms-client-request-id Headers, wenn er in der Anforderung vorhanden ist und der Wert nicht mehr als 1.024 sichtbare ASCII-Zeichen enthält. Wenn der x-ms-client-request-id Header in der Anforderung nicht vorhanden ist, ist er in der Antwort nicht vorhanden.

Antworttext

Keine.

Authorization

Dieser Vorgang kann nur vom Kontobesitzer aufgerufen werden.

Hinweise

Die folgenden Einschränkungen gelten für CORS-Regeln in Azure Files:

  • Es können maximal fünf Regeln gespeichert werden.

  • Die maximale Größe aller CORS-Regeleinstellungen für die Anforderung, mit Ausnahme von XML-Tags, sollte 2 KiB nicht überschreiten.

  • Die Länge eines zulässigen Headers oder Ursprungs bzw. eines verfügbar gemachten Headers sollte maximal 256 Zeichen betragen.

  • Zulässige Header und verfügbar gemachte Header können eine der folgenden sein:

    • Literale Header, bei denen der genaue Headername angegeben ist, z. B. x-ms-meta-processed. Für die Anforderung können maximal 64 Literalheader angegeben werden.

    • Header mit Präfix, bei denen ein Präfix des Headers angegeben ist, z. B. x-ms-meta-data*. Die Angabe eines Präfixes auf diese Weise ermöglicht oder macht jeden Header verfügbar, der mit diesem Präfix beginnt. Für die Anforderung können maximal zwei präfixierte Header angegeben werden.

  • Die im AllowedMethods -Element angegebenen Methoden (oder HTTP-Verben) müssen den Methoden entsprechen, die von den Azure-Speicherdienst-APIs unterstützt werden. Unterstützte Methoden sind DELETE, GET, HEAD, MERGE, POST, OPTIONSund PUT.

Optional können CORS-Regeln für die Anforderung angegeben werden. Wenn Sie aufrufen Set File Service Properties , ohne das CORS-Element im Anforderungstext anzugeben, werden alle vorhandenen CORS-Regeln beibehalten.

Um CORS zu deaktivieren, rufen Sie Set File Service Properties mit einer leeren CORS-Regeleinstellung (d. h. </Cors>) und ohne innere CORS-Regeln auf. Dieser Aufruf löscht alle vorhandenen Regeln und deaktiviert CORS für den Dateidienst.

Wenn das CorsRule-Element angegeben wird, sind alle CORS-Regelelemente erforderlich. Die Anforderung schlägt mit dem Fehlercode 400 (Ungültige Anforderung) fehl, wenn ein Element fehlt.

Weitere Informationen zu CORS-Regeln und der Auswertungslogik finden Sie unter Unterstützung der ressourcenübergreifenden Ressourcenfreigabe für die Azure Storage-Dienste.

Beispielanforderung und -antwort

Der folgende Beispiel-URI stellt eine Anforderung zum Ändern der Dateidiensteigenschaften für ein Speicherkonto namens myaccount:

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

Die Anforderung wird mit den folgenden Headern gesendet;

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

Die Anforderung wird mit dem folgenden XML-Text gesendet:

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

Nachdem die Anforderung gesendet wurde, wird die folgende Antwort zurückgegeben:

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

Weitere Informationen

Weitere Informationen zu CORS-Regeln und der Auswertungslogik finden Sie unter Unterstützung der ressourcenübergreifenden Ressourcenfreigabe für die Azure Storage-Dienste.

Weitere Informationen zu Storage Analytics finden Sie unter Storage Analytics.