Freigabeeigenschaften abrufen
Die Get Share Properties Anforderung gibt Eigenschaften für die angegebene Freigabe oder freigabe Momentaufnahme zurück.
Obwohl diese API vollständig unterstützt wird, handelt es sich um eine Legacyverwaltungs-API. Aus diesem Grund wird empfohlen, stattdessen Dateifreigaben – Abrufen zu verwenden, die vom Speicherressourcenanbieter (Microsoft.Storage) bereitgestellt wird.
Weitere Informationen zur programmgesteuerten Interaktion mit FileShare Ressourcen mithilfe des Speicherressourcenanbieters finden Sie unter Vorgänge in FileShares.
Protokollverfügbarkeit
| Aktiviertes Dateifreigabeprotokoll | Verfügbar |
|---|---|
| SMB |  |
| NFS | |
Anforderung
Die Get Share Properties-Anforderung kann wie folgt erstellt werden. Es wird empfohlen, HTTPS zu verwenden.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
Ersetzen Sie die im Anforderungs-URI angezeigten Pfadkomponenten wie folgt durch Ihre eigenen Angaben:
| Pfadkomponente | BESCHREIBUNG |
|---|---|
myaccount |
Der Name Ihres Speicherkontos. |
myshare |
Der Name der Dateifreigabe. |
Informationen zu Pfadbenennungseinschränkungen finden Sie unter Namens- und Verweisfreigaben, Verzeichnisse, Dateien und Metadaten.
URI-Parameter
Die folgenden zusätzlichen Parameter können im Anforderungs-URI angegeben werden:
| Parameter | BESCHREIBUNG |
|---|---|
sharesnapshot |
Optional. Version 2017-04-17 und höher. Der sharesnapshot Parameter ist ein undurchsichtiger Datums-/Uhrzeitwert, der, wenn vorhanden, die Freigabe angibt, Momentaufnahme abgefragt werden soll, um die Eigenschaften abzurufen. |
timeout |
Optional. Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Azure Files Vorgänge. |
Anforderungsheader
Die erforderlichen und optionalen Header werden in der folgenden Tabelle beschrieben:
| Anforderungsheader | BESCHREIBUNG |
|---|---|
Authorization |
Erforderlich. Gibt das Autorisierungsschema, den Kontonamen 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. 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 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. |
x-ms-lease-id:<ID> |
Optional. Version 2020-02-10 und höher. Wenn der Header angegeben ist, wird der Vorgang nur ausgeführt, wenn die Lease der Dateifreigabe derzeit aktiv ist und die in der Anforderung angegebene Lease-ID mit der Lease-ID der Dateifreigabe übereinstimmt. Wenn keine Übereinstimmung vorhanden ist, schlägt der Vorgang mit status Code 412 (Vorbedingung fehlgeschlagen) fehl. |
Anforderungstext
Keine.
Antwort
Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.
Statuscode
Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben.
Weitere Informationen zu status Codes finden Sie unter Status- und Fehlercodes.
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 |
|---|---|
Last-Modified |
Gibt das Datum und die Uhrzeit der letzten Änderung der Freigabe zurück. Das Datumsformat entspricht RFC 1123. Weitere Informationen finden Sie unter Darstellung von Date-Time-Werten in Headern. Bei jedem Vorgang, durch den die Freigabe oder deren Eigenschaften geändert werden, wird der Zeitpunkt der letzten Änderung aktualisiert. Vorgänge für Dateien wirken sich nicht auf den Zeitpunkt der letzten Änderung der Freigabe aus. |
x-ms-meta-name:value |
Ein Satz von Name-Wert-Paaren, die die benutzerdefinierten Metadaten der Freigabe enthalten. |
ETag |
Enthält einen Wert, den Sie verwenden können, um Vorgänge bedingt auszuführen. Der Wert wird in Anführungszeichen eingeschlossen. |
x-ms-request-id |
Identifiziert eindeutig die Anforderung, die gestellt wurde, und kann zur Problembehandlung für die Anforderung verwendet werden. Weitere Informationen finden Sie unter Problembehandlung bei API-Vorgängen. |
x-ms-version |
Die Azure Files Version, die zum Ausführen der Anforderung verwendet wurde. |
Date |
Ein UTC-Datums-/Uhrzeitwert, der vom Dienst generiert wird, der die Uhrzeit angibt, zu der die Antwort initiiert wurde. |
x-ms-share-quota |
Version 2015-02-21 und höher. Gibt das aktuelle Freigabekontingent in Gibibytes (GiB) zurück. |
x-ms-share-provisioned-iops |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps). Gibt die Anzahl von Eingabe-/Ausgabevorgängen pro Sekunde (IOPS) zurück, wie sie für die Premium-Freigabe bereitgestellt wird. |
x-ms-share-provisioned-ingress-mbps |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps). Gibt den Eingangseingang in Mebibytes pro Sekunde (MiB/s) zurück, wie für die Premium-Freigabe bereitgestellt. |
x-ms-share-provisioned-egress-mbps |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps). Gibt den ausgehenden Wert in MiB/s zurück, wie für die Premium-Aktie bereitgestellt. |
x-ms-share-provisioned-bandwidth-mibps |
Version 2021-02-12 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps). Gibt die kombinierte Bandbreite (eingangs und ausgehend) in MiB/s zurück, wie für die Premium-Freigabe bereitgestellt. |
x-ms-share-next-allowed-quota-downgrade-time |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps). Ein Datum/Uhrzeit-Wert, der angibt, wann das Kontingent für die Premium-Dateifreigabe reduziert werden darf. Das Datumsformat entspricht RFC 1123. |
x-ms-access-tier |
Version 2019-12-12 und höher. Gibt die aktuelle Zugriffsebene der Freigabe zurück. In GPv2-Speicherkonten TransationOptimized (General Purpose Version 2) ist die Standardebene der Freigabe. In FileStorage-Speicherkontotypen Premium ist die Standardebene der Freigabe. |
x-ms-access-tier-change-time |
Version 2019-12-12 und höher. Gibt das Datum und die Uhrzeit zurück, an dem die Zugriffsebene für die Freigabe zuletzt geändert wurde. |
x-ms-access-tier-transition-state |
Version 2019-12-12 und höher. Wenn die Freigabe einen Ebenenübergang durchläuft, gibt dieser Header die Ebene an, von der sie wechselt. |
x-ms-lease-duration:<fixed,infinite> |
Version 2020-02-10 und höher. Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Version 2020-02-10 und höher. Wenn eine Freigabe geleast wird, gibt dieser Header den Leasestatus der Freigabe an. |
x-ms-lease-status: <locked;unlocked> |
Version 2020-02-10 und höher. Wenn eine Freigabe geleast wird, gibt dieser Header die Lease-status der Freigabe an. |
x-ms-enabled-protocols: <SMB;NFS> |
Gibt die aktuellen freigabefähigen Protokolle für Version 2019-07-07 und höher zurück. - SMB: Auf die Freigabe kann von SMBv3.0, SMBv2.1 und REST zugegriffen werden.- NFS: Auf die Freigabe kann von NFSv4.1 zugegriffen werden. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Gibt das aktuelle Stammküringverhalten der Freigabe für Version 2019-07-07 und höher zurück. Nur NFS. - NoRootSquash: Root Squashing ist deaktiviert.- RootSquash: Anforderungen von UID/GID 0 werden der anonymen UID/GID zugeordnet.- AllSquash: Alle UIDs und GIDs werden dem anonymen Benutzer zugeordnet. |
x-ms-client-request-id |
Kann verwendet werden, um Anforderungen und entsprechende Antworten zu behandeln. 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
Keine.
Beispiel für eine Antwort
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Authorization
Dieser Vorgang kann nur vom Kontobesitzer aufgerufen werden.
Bemerkungen
Keine.