Get File Properties

  • Artikel

Der Get File Properties Vorgang gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Der Inhalt der Datei wird nicht zurückgegeben.

Protokollverfügbarkeit

Aktiviertes Dateifreigabeprotokoll Verfügbar
SMB Ja
NFS Nein

Anforderung

Die Get File Properties-Anforderung kann wie folgt erstellt werden. Es wird empfohlen, HTTPS zu verwenden.

Methode Anforderungs-URI HTTP-Version
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile HTTP/1.1
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> HTTP/1.1

Ersetzen Sie die Pfadkomponenten, die im Anforderungs-URI angezeigt werden, wie folgt durch Ihre eigenen:

Pfadkomponente BESCHREIBUNG
myaccount Der Name Ihres Speicherkontos.
myshare Der Name der Dateifreigabe.
mydirectorypath Optional. Der Pfad zum übergeordneten Verzeichnis.
myfile Der Name der Datei.

Informationen zu Einschränkungen bei der Pfadbenennung finden Sie unter Namens- und Verweisfreigaben, Verzeichnisse, Dateien und Metadaten.

URI-Parameter

Die folgenden zusätzlichen Parameter können für den Anforderungs-URI angegeben werden:

Parameter BESCHREIBUNG
sharesnapshot Optional. Version 2017-04-17 und höher. Der sharesnapshot Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Freigabe Momentaufnahme angibt, die nach den Dateieigenschaften abzufragen ist.
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 Anforderungsheader 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-lease-id:<ID> Optional. Version 2019-02-02 und höher. Wenn der Header angegeben ist, wird der Vorgang nur ausgeführt, wenn die Lease der Datei derzeit aktiv ist und die in der Anforderung angegebene Lease-ID mit der Lease-ID der Datei übereinstimmt. Wenn er nicht übereinstimmt, schlägt der Vorgang mit status Code 412 (Vorbedingungsfehler) fehl.
x-ms-client-request-id Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Zeichenlimit von 1 Kibibyte (KiB) bereit, der in den Analyseprotokollen aufgezeichnet wird, wenn die Protokollierung von Azure Storage Analytics aktiviert ist. Es wird dringend empfohlen, diesen Header zu verwenden, wenn Sie clientseitige Aktivitäten mit Anforderungen korrelieren, die vom Server empfangen werden. Weitere Informationen finden Sie unter Überwachen Azure Blob Storage.
x-ms-file-request-intent Erforderlich, wenn Authorization der Header ein OAuth-Token angibt. Zulässiger Wert ist backup. Dieser Header gibt an, dass oder Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action gewährt werden soll, wenn sie in der RBAC-Richtlinie enthalten sind, die der Identität zugewiesen ist, die mithilfe des Authorization Headers autorisiert ist. Verfügbar für Version 2022-11-02 und höher.
x-ms-allow-trailing-dot: { <Boolean> } Optional. Version 2022-11-02 und höher. Der boolesche Wert gibt an, ob ein nachgestellter Punkt in der Anforderungs-URL gekürzt werden soll. Weitere Informationen finden Sie unter Benennen und Verweisen auf Freigaben, Verzeichnisse, Dateien und Metadaten.

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 Datei zurück. Das Datumsformat entspricht RFC 1123. Weitere Informationen finden Sie unter Darstellen von Datums-/Uhrzeitwerten in Headern. Jeder Vorgang, der die Datei oder deren Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung.
x-ms-meta-name:value Ein Satz von Name-Wert-Paaren, die dieser Datei als benutzerdefinierte Metadaten zugeordnet sind.
x-ms-type: <File> Der Rückgabetyp ist File. Für die zukünftige Verwendung reserviert.
Content-Length Dies ist die Größe der Datei in Byte. Dieser Header gibt den Wert des Headers zurück, der x-ms-content-length in der Datei gespeichert ist.
Content-Type Der Inhaltstyp, der für die Datei angegeben wird. Wenn kein Inhaltstyp angegeben ist, ist application/octet-streamder Standardinhaltstyp .
ETag Das ETag enthält einen Wert, den Sie verwenden können, um Vorgänge bedingt auszuführen. Der Wert wird in Anführungszeichen eingeschlossen.
Content-MD5 Wenn der Content-MD5-Header für die Datei festgelegt wurde, wird der Content-MD5-Antwortheader zurückgegeben, damit der Client die Integrität des Nachrichteninhalts überprüfen kann.
Content-Encoding Wenn zuvor der Content-Encoding-Anforderungsheader für die Datei festgelegt wurde, wird der Content-Encoding-Wert in diesem Header zurückgegeben.
Content-Language Wenn zuvor der Content-Language-Anforderungsheader für die Datei festgelegt wurde, wird der Content-Language-Wert in diesem Header zurückgegeben.
Cache-Control Wenn zuvor der Cache-Control-Anforderungsheader für die Datei festgelegt wurde, wird der Cache-Control-Wert in diesem Header zurückgegeben.
Content-Disposition Gibt den Wert zurück, der für den x-ms-content-disposition-Header angegeben worden war, und legt fest, wie die Antwort verarbeitet werden soll.

Das Content-Disposition Antwortheaderfeld enthält zusätzliche Informationen zur Verarbeitung der Antwortnutzlast, und Sie können es verwenden, um zusätzliche Metadaten anzufügen. Wenn sie beispielsweise auf attachmentfestgelegt ist, Content-Disposition gibt an, dass der Benutzer-Agent die Antwort nicht anzeigen soll, sondern stattdessen ein Fenster Speichern unter anzeigen sollte.
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 für API-Vorgänge.
x-ms-version Gibt die Dienstversion an, die zum Ausführen der Anforderung verwendet wurde.
Date Ein UTC-Datums-/Uhrzeitwert, der vom Dienst generiert wird, der den Zeitpunkt angibt, zu dem die Antwort initiiert wurde.
x-ms-copy-completion-time:<datetime> Version 2015-02-21 und höher. Die Abschlusszeit des letzten versuchten Kopiervorgangs, bei dem diese Datei die Zieldatei war. Dieser Wert kann die Zeit eines abgeschlossenen, abgebrochenen oder fehlgeschlagenen Kopierversuchs angeben. Dieser Header wird nicht angezeigt, wenn eine Kopie aussteht, wenn diese Datei noch nie das Ziel eines Kopiervorgangs war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang mit Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-copy-status-description: <error string> Version 2015-02-21 und höher. Wird nur angezeigt, wenn x-ms-copy-statusfehler oderausstehend ist. Es beschreibt die Ursache für schwerwiegende oder nicht schwerwiegende Fehler beim Kopiervorgang. Dieser Header wird nicht angezeigt, wenn eine Kopie aussteht, wenn diese Datei noch nie das Ziel eines Kopiervorgangs war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang mit Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-copy-id: <id> Version 2015-02-21 und höher. Der Zeichenfolgenbezeichner für den letzten versuchten Dateikopiervorgang , bei dem diese Datei die Zieldatei war. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Vorgang zum Kopieren von Datei mithilfe von Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-copy-progress: <bytes copied/bytes total> Version 2015-02-21 und höher. Enthält die Anzahl der kopierten Bytes und die Gesamtbytes in der Quelle beim letzten Versuchten Dateikopiervorgang , wobei diese Datei die Zieldatei war. Kann zwischen 0 und der Anzahl der Content-Length kopierten Bytes anzeigen. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Vorgang zum Kopieren von Datei mithilfe von Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-copy-source: url Version 2015-02-21 und höher. Eine URL mit bis zu 2 KB Zeichen, die die Quelldatei angibt, die beim letzten Versuchten Dateikopiervorgang verwendet wurde, wobei diese Datei die Zieldatei war. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Vorgang zum Kopieren von Datei mithilfe von Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> Version 2015-02-21 und höher. Der Zustand des Kopiervorgangs, der von x-ms-copy-ididentifiziert wird, mit den folgenden Werten:

- Erfolg: Der Kopiervorgang wurde erfolgreich abgeschlossen.
- Ausstehende: Der Kopiervorgang wird ausgeführt. Überprüfen Sie x-ms-copy-status-description , ob zeitweilige, nicht schwerwiegende Fehler den Kopierfortschritt beeinträchtigen, aber keinen Fehler verursachen.
- Abgebrochen: Das Kopieren wurde durch Abbrechen der Kopierdatei beendet.
- Fehlgeschlagen: Fehler beim Kopieren. Fehlerdetails finden Sie in x-ms-copy-status-description.

Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Vorgang zum Kopieren von Datei mithilfe von Dateieigenschaften festlegen oder Datei erstellen geändert wurde.
x-ms-server-encrypted: true/false Version 2017-04-17 und höher. Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten vollständig mit dem angegebenen Algorithmus verschlüsselt werden. Der Wert wird auf false festgelegt, wenn die Datei unverschlüsselt ist oder nur Teile der Datei- oder Anwendungsmetadaten verschlüsselt sind.
x-ms-file-permission-key Version 2019-02-02 und höher. Der Schlüssel der Berechtigung der Datei.
x-ms-file-attributes Version 2019-02-02 und höher. Die Dateisystemattribute der Datei. Weitere Informationen finden Sie in der Liste der verfügbaren Attribute.
x-ms-file-creation-time Version 2019-02-02 und höher. Der UTC-Wert für Datum/Uhrzeit, der die Eigenschaft zur Erstellungszeit für eine Datei darstellt.
x-ms-file-last-write-time Version 2019-02-02 und höher. Der UTC-Wert für Datum/Uhrzeit, der die Eigenschaft zum letzten Schreibvorgang für die Datei darstellt.
x-ms-file-change-time Version 2019-02-02 und höher. Der UTC-Wert für Datum/Uhrzeit, der die Änderungszeiteigenschaft für die Datei darstellt.
x-ms-file-file-id Version 2019-02-02 und höher. Die Datei-ID der Datei.
x-ms-file-parent-id Version 2019-02-02 und höher. Die ID der übergeordneten Datei.
x-ms-lease-duration:infinite Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt an, dass die Lease unendlich lange ist.
x-ms-lease-state:<available;leased;broken> Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt den Leasestatus der Datei an.
x-ms-lease-status:<locked;unlocked> Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt die Lease-status der Datei an.
x-ms-client-request-id Kann zur Problembehandlung von Anforderungen und 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

Keine.

Beispiel für eine Antwort

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
x-ms-type: File  
x-ms-meta-m1: v1  
x-ms-meta-m2: v2  
Content-Length: 11  
Content-Type: text/plain; charset=UTF-8  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-version: 2019-02-02  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6  
x-ms-copy-source: <url>  
x-ms-copy-status: success  
x-ms-copy-progress: 11/11  
x-ms-copy-completion-time: <date>  
x-ms-lease-duration: infinite   
x-ms-lease-state: leased 
x-ms-lease-status: locked

Authorization

Dieser Vorgang kann nur vom Kontobesitzer aufgerufen werden.

Weitere Informationen

Vorgänge für Azure Files