Abrufen von Freigabeeigenschaften
Die Get Share Properties Anforderung gibt Eigenschaften für die angegebene Freigabe- oder Freigabemomentaufnahme zurück.
Obwohl diese API vollständig unterstützt wird, handelt es sich um eine Legacyverwaltungs-API. Aus diesem Grund wird empfohlen, Dateifreigaben zu verwenden –abrufen, das stattdessen vom Speicherressourcenanbieter (Microsoft.Storage) bereitgestellt wird.
Weitere Informationen zur programmgesteuerten Interaktion mit FileShare Ressourcen mithilfe des Speicherressourcenanbieters finden Sie unter Vorgänge auf FileShares.
Protokollverfügbarkeit
| Aktiviertes Dateifreigabeprotokoll | Verfügbar |
|---|---|
| SMB |
|
| NFS |
|
Bitten
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 pfadkomponenten, die im Anforderungs-URI angezeigt werden, wie folgt:
| Pfadkomponente | Beschreibung |
|---|---|
myaccount |
Der Name Ihres Speicherkontos. |
myshare |
Der Name Ihrer Dateifreigabe. |
Informationen zu Pfadbenennungseinschränkungen finden Sie unter Namen- und Referenzfreigaben, Verzeichnisse, Dateien und Metadaten.
URI-Parameter
Die folgenden zusätzlichen Parameter können im Anforderungs-URI angegeben werden:
| Parameter | Beschreibung |
|---|---|
sharesnapshot |
Wahlfrei. Version 2017-04-17 und höher. Der parameter sharesnapshot ist ein undurchsichtiger Datums-/Uhrzeitwert, der, wenn vorhanden, die Freigabemomentaufnahme angibt, um die Eigenschaften abzurufen. |
timeout |
Wahlfrei. Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Azure Files-Vorgänge. |
Anforderungsheader
Die erforderlichen und optionalen Kopfzeilen 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 (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 Vorgangs an, der für diese Anforderung verwendet werden soll. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure Storage-Dienste. |
x-ms-client-request-id |
Wahlfrei. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem 1-Kibibyte-Zeichenlimit (KiB) bereit, der in den 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 von Azure Files. |
x-ms-lease-id:<ID> |
Wahlfrei. Version 2020-02-10 und höher. Wenn der Header angegeben ist, wird der Vorgang nur ausgeführt, wenn die Lease der Dateifreigabe aktuell 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 dem Statuscode 412 fehl (Vorbedingung fehlgeschlagen). |
Anforderungstext
Nichts.
Antwort
Die Antwort enthält einen HTTP-Statuscode und eine Reihe von Antwortheadern.
Statuscode
Ein erfolgreicher Vorgang gibt den Statuscode 200 (OK) zurück.
Weitere Informationen zu Statuscodes finden Sie unter Status- und Fehlercodes.
Antwortheader
Die Antwort für diesen Vorgang enthält die folgenden Header. Die Antwort kann auch zusätzliche Standard-HTTP-Header 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 folgt RFC 1123. Weitere Informationen finden Sie unter Darstellung von Date-Time Werten in Kopfzeilen. Jeder Vorgang, der die Freigabe oder seine Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung. Vorgänge für Dateien wirken sich nicht auf den Zeitpunkt der letzten Änderung der Freigabe aus. |
x-ms-meta-name:value |
Eine Gruppe von Name-Wert-Paaren, die die benutzerdefinierten Metadaten der Freigabe enthalten. |
ETag |
Enthält einen Wert, den Sie zum bedingten Ausführen von Vorgängen verwenden können. Der Wert wird in Anführungszeichen eingeschlossen. |
x-ms-request-id |
Identifiziert eindeutig die Anforderung, die durchgeführt wurde, und kann zur Problembehandlung der Anforderung verwendet werden. Weitere Informationen finden Sie unter Problembehandlung für API-Vorgänge. |
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 (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Gibt die Anzahl der Eingabe-/Ausgabevorgänge pro Sekunde (IOPS) zurück, wie für die Premium-Aktie bereitgestellt. |
x-ms-share-provisioned-ingress-mbps |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Gibt den Ingress in mebibytes pro Sekunde (MiB/s) zurück, wie für die Premium-Aktie bereitgestellt. |
x-ms-share-provisioned-egress-mbps |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Gibt den Ausgang 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 (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Gibt die kombinierte Bandbreite (Ausgang + Ausgang) in MiB/s zurück, wie für die Premium-Aktie bereitgestellt. |
x-ms-share-next-allowed-quota-downgrade-time |
Version 2019-07-07 und höher. Wird nur für Premium-Dateifreigaben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Ein Datums-/Uhrzeitwert, der angibt, wann das Kontingent für die Premium-Dateifreigabe reduziert werden darf. Das Datumsformat folgt RFC 1123. |
x-ms-access-tier |
Version 2019-12-12 und höher. Gibt die aktuelle Zugriffsebene der Freigabe zurück. In allgemeinen Version 2 (GPv2)-Speicherkonten ist TransationOptimized die Standardebene der Freigabe. In FileStorage-Speicherkontotypen ist Premium die Standardebene der Freigabe. |
x-ms-access-tier-change-time |
Version 2019-12-12 und höher. Gibt das Datum und die Uhrzeit der letzten Änderung der Zugriffsebene der Freigabe zurück. |
x-ms-access-tier-transition-state |
Version 2019-12-12 und höher. Wenn sich der Freigabeübergang unterliegt, 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 Leasingdauer für einen Anteil unendlich oder fest ist. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Version 2020-02-10 und höher. Wenn ein Anteil verleast wird, gibt dieser Header den Leasingstatus der Aktie an. |
x-ms-lease-status: <locked;unlocked> |
Version 2020-02-10 und höher. Wenn ein Anteil verleast wird, gibt dieser Header den Leasingstatus der Aktie 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 Stammverhalten der Freigabe für Version 2019-07-07 und höher zurück. Nur NFS. - NoRootSquash: Root-Rooting ist deaktiviert.- RootSquash: Anforderungen von UID/GID 0 werden der anonymen UID/GID zugeordnet.- AllSquash: Alle UIDs und GIDs werden dem anonymen Benutzer zugeordnet.Dieser Header wird nur für Freigaben zurückgegeben, nicht für Momentaufnahmen. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Version 2024-08-04 und höher. Gibt an, ob auf das virtuelle Snapshot-Verzeichnis beim Aktivieren von NFS zugegriffen werden soll. Dieser Header wird nur für Freigaben zurückgegeben, nicht für Momentaufnahmen. |
x-ms-client-request-id |
Kann verwendet werden, um Anfragen 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. |
x-ms-share-paid-bursting-enabled: <true;false> |
Version 2024-11-04 und höher. Wird nur für Premium-Dateifreigaben (Dateifreigaben innerhalb des FileStorage-Speicherkontotyps) zurückgegeben. Gibt an, ob kostenpflichtiges Bursting aktiviert ist. Dieser Header wird nur für Freigaben zurückgegeben, nicht für Momentaufnahmen. |
x-ms-share-paid-bursting-max-iops |
Version 2024-11-04 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben. Gibt den maximal bezahlten IOPS-Wert zurück, der für die Freigabe zulässig ist. Wird nur zurückgegeben, wenn x-ms-share-paid-bursting-enabled "true" ist.Dieser Header wird nur für Freigaben zurückgegeben, nicht für Momentaufnahmen. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Version 2024-11-04 und höher. Wird nur für Premium-Dateifreigaben zurückgegeben. Gibt den maximal bezahlten MiB/s zurück, der für die Aktie zulässig ist. Wird nur zurückgegeben, wenn x-ms-share-paid-bursting-enabled "true" ist.Dieser Header wird nur für Freigaben zurückgegeben, nicht für Momentaufnahmen. |
Antworttext
Nichts.
Beispielantwort
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
Ermächtigung
Nur der Kontobesitzer kann diesen Vorgang aufrufen.
Bemerkungen
Nichts.