Get File Service Properties

Artikel
07/19/2023

Der Get File Service Properties Vorgang ruft Eigenschaften für die FileService Ressource mithilfe der FileREST-API ab. Obwohl diese API vollständig unterstützt wird, handelt es sich um eine Legacyverwaltungs-API. Es wird empfohlen, stattdessen Dateidienste – Diensteigenschaften abrufen zu verwenden, die vom Speicherressourcenanbieter (Microsoft.Storage) bereitgestellt wird. Weitere Informationen zur programmgesteuerten Interaktion mit der FileService Ressource mithilfe des Speicherressourcenanbieters finden Sie unter Vorgänge für die FileService-Ressource.

Protokollverfügbarkeit

Aktiviertes Dateifreigabeprotokoll	Verfügbar
SMB
NFS

Anforderung

Die Get File Service Properties-Anforderung kann wie folgt angegeben werden. Es wird empfohlen, HTTPS zu verwenden. Ersetzen Sie <account-name> durch den Namen Ihres Speicherkontos:

Methode	Anforderungs-URI	HTTP-Version
GET	`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. Bei 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

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader 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` oder `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 in Version 2015-02-21 und höher verfügbar. Zum Abrufen von Metrikeigenschaften 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 in den Azure-Storage Analytics-Protokollen aufgezeichnet wird, wenn die Protokollierung konfiguriert ist. 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

Keine.

Antwort

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

Statuscode

Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben.

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`	Identifiziert eindeutig eine Anforderung, die an den Dienst gestellt wird.
`x-ms-version`	Gibt die Version des Vorgangs an, der für die Antwort verwendet wird. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
`x-ms-client-request-id`	Kann zur Problembehandlung von Anforderungen und deren entsprechenden Antworten verwendet werden. Der Wert dieses 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

Das Format des Antworttexts 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>

Die folgende Tabelle erläutert die Elemente des Antworttexts:

Name	BESCHREIBUNG
`HourMetrics`	Gruppiert die Storage Analytics `HourMetrics` Einstellungen. Die `HourMetrics` Einstellungen bieten eine Zusammenfassung der Anforderungsstatistiken, gruppiert nach API in stündlich aggregierten Aggregaten.
`MinuteMetrics`	Gruppiert die Storage Analytics `MinuteMetrics` Einstellungen. Die `MinuteMetrics` Einstellungen stellen Anforderungsstatistiken für jede Minute bereit.
`Version`	Die Version von Storage Analytics, die derzeit verwendet wird.
`Enabled`	Gibt an, ob Metriken für den Dateidienst aktiviert sind.
`IncludeAPIs`	Gibt an, ob von einer Metrik eine Zusammenfassungsstatistik für aufgerufene API-Vorgänge generiert wird.
`RetentionPolicy/Enabled`	Gibt an, ob eine Aufbewahrungsrichtlinie für den Dateidienst aktiviert ist.
`RetentionPolicy/Days`	Gibt die Anzahl der Tage an, für die Metrikdaten aufbewahrt werden. Alle Daten, die älter als dieser Wert sind, werden nach bestem Aufwand gelöscht.
`Cors`	Gruppiert alle CORS-Regeln (Cross-Origin Resource Sharing).
`CorsRule`	Gruppiert Einstellungen für eine CORS-Regel.
`AllowedOrigins`	Eine durch Trennzeichen getrennte Liste von Ursprungsdomänen, die über CORS zulässig sind, oder "*", falls alle Domänen zulässig sind.
`ExposedHeaders`	Eine durch Trennzeichen getrennte Liste mit Antwortheadern, die für CORS-Clients verfügbar gemacht werden sollen.
`MaxAgeInSeconds`	Die Anzahl der Sekunden, die der Client oder Browser eine Preflightantwort zwischenspeichern soll.
`AllowedHeaders`	Eine durch Trennzeichen getrennte Liste von Headern, die Teil der ursprungsübergreifenden Anforderung sein dürfen.
`AllowedMethods`	Eine durch Trennzeichen getrennte Liste von HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen. Für Azure Files sind DELETE, GET, HEAD, MERGE, POST, OPTIONS und PUT zulässig.
`ShareDeleteRetentionPolicy`	Die Eigenschaften des vorläufigen Löschens für die Azure-Dateifreigaben in diesem Speicherkonto.
`Days`	Gibt die Anzahl der Tage an, für die die Azure-Dateifreigabe beibehalten werden soll (vorläufig gelöscht). Der angegebene Mindestwert kann 1 und der Höchstwert 365 sein.
`Enabled`	Gibt an, ob für das Speicherkonto vorläufiges Löschen für Azure Files aktiviert ist.
`ProtocolSettings`	Gruppiert die Einstellungen für Dateisystemprotokolle.
`SMB`	Gruppiert die Einstellungen für Server Message Block (SMB).
`Multichannel`	Enthält die Einstellungen für SMB Multichannel. Diese Einstellung hat eine Eigenschaft: aktiviert/deaktiviert.
`Version`	Verfügbar ab Version 2020-04-08. Eine durch Trennzeichen getrennte Liste zulässiger SMB-Versionen. Mögliche Werte: `SMB2.1`, `SMB3.0` und `SMB3.1.1`. Wenn `Version` nicht angegeben ist, ist der Standardwert, dass alle Versionen aktiviert sind. SMB 2.1 ist jedoch nur verfügbar, wenn die Eigenschaft des Speicherkontos `require secure transit` deaktiviert ist, da SMB 2.1 die Verschlüsselung nicht unterstützt.
`AuthenticationMethods`	Verfügbar ab Version 2020-04-08. Eine durch Trennzeichen getrennte Liste zulässiger Authentifizierungsmethoden. Mögliche Werte: `NTLMv2`, `Kerberos`. Wenn `AuthenticationMethods` nicht angegeben ist, ist der Standardwert, dass alle Authentifizierungsmethoden zulässig sind.
`KerberosTicketEncryption`	Verfügbar ab Version 2020-04-08. Eine durch Trennzeichen getrennte Liste zulässiger Kerberos-Ticketverschlüsselungsalgorithmen. Mögliche Werte: `RC4-HMAC` und `AES-256`. Wenn `KerberosTicketEncryption` nicht angegeben ist, wird standardmäßig alle Kerberos-Ticketverschlüsselungsalgorithmen unterstützt.
`ChannelEncryption`	Verfügbar ab Version 2020-04-08. Eine durch Trennzeichen getrennte Liste zulässiger SMB-Kanalverschlüsselungsprotokolle. Mögliche Werte: `AES-128-CCM`, `AES-128-GCM` und `AES-256-GCM`. Wenn `ChannelEncryption` nicht angegeben ist, werden standardmäßig alle Kanalverschlüsselungswerte unterstützt. Wenn die Eigenschaft des Speicherkontos `require secure transit` deaktiviert ist, ist auch unverschlüsselter SMB-Zugriff zulässig.

Authorization

Dieser Vorgang kann nur vom Speicherkontobesitzer aufgerufen werden.

Beispielanforderung und -antwort

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

Methode	URL	Protocol
GET	`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

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

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

Die Antwort enthält den folgenden XML-Text:

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

Hinweise

Ausführliche Informationen zu CORS-Regeln und der Auswertungslogik finden Sie unter CORS-Unterstützung für die Azure Storage-Dienste.

Weitere Informationen finden Sie unter Storage Analytics.