FileService Klasse

Das SMB (Server Message Block)-Protokoll ist derzeit das bevorzugt für lokale Dateifreigaben verwendete Protokoll. Mit dem Microsoft Azure-Dateidienst können Kunden die Verfügbarkeit und Skalierbarkeit des Azure-IaaS-SMB (Cloud Infrastructure-as-a-Service) nutzen, ohne SMB-Clientanwendungen neu schreiben zu müssen.

Der Azure-Dateidienst bietet zudem eine attraktive Alternative zu herkömmlichen DAS (Direct Attached Storage)- und SAN (Storage Area Network)-Lösungen, deren Installation, Konfiguration und Ausführung häufig komplex und teuer ist.

Vererbung

StorageClient

FileService

Konstruktor

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

Parameter

Name	Beschreibung
account_name	str Der Name des Speicherkontos. Dies wird verwendet, um mit einem Kontoschlüssel signierte Anforderungen zu authentifizieren und den Speicherendpunkt zu erstellen. Es ist erforderlich, es sei denn, es wird eine Verbindungszeichenfolge angegeben. Standardwert: None
account_key	str Der Speicherkontoschlüssel. Dies wird für die Authentifizierung mit freigegebenem Schlüssel verwendet. Standardwert: None
sas_token	str Ein Shared Access Signature-Token, das anstelle des Kontoschlüssels zum Authentifizieren von Anforderungen verwendet werden soll. Wenn Kontoschlüssel und SAS-Token angegeben sind, wird der Kontoschlüssel zum Signieren verwendet. Standardwert: None
protocol	str Das Protokoll, das für Anforderungen verwendet werden soll. Standardmäßig wird https verwendet. Standardwert: https
endpoint_suffix	str Die Hostbasiskomponente der URL abzüglich des Kontonamens. Standardmäßig wird Azure (core.windows.net) verwendet. Überschreiben Sie dies, um die China-Cloud (core.chinacloudapi.cn) zu verwenden. Standardwert: core.windows.net
request_session	<xref:requests.Session> Das Sitzungsobjekt, das für HTTP-Anforderungen verwendet werden soll. Standardwert: None
connection_string	str Wenn angegeben, überschreibt dies alle anderen Parameter außer der Anforderungssitzung. Das Verbindungszeichenfolgenformat finden Sie unter http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ . Standardwert: None
socket_timeout	int Falls angegeben, überschreibt dies das Standardmäßige Sockettimeout. Das angegebene Timeout ist in Sekunden angegeben. Den Standardwert finden Sie unter DEFAULT_SOCKET_TIMEOUT in _constants.py. Standardwert: None

Variablen

Name	Beschreibung
MAX_SINGLE_GET_SIZE	int Die Größe des ersten Bereichs wird von get_file_to_*-Methoden ausgeführt, wenn max_connections größer als 1 ist. Wenn die Datei kleiner ist, werden weniger Daten zurückgegeben.
MAX_CHUNK_GET_SIZE	int Die Größe des nachfolgenden Bereichs wird von get_file_to_*-Methoden ausgeführt, wenn max_connections größer als 1 ist und die Datei größer als MAX_SINGLE_GET_SIZE ist. Wenn der Rest der Datei kleiner ist, werden weniger Daten zurückgegeben. Wenn dies auf größer als 4 MB festgelegt ist, löst content_validation bei Aktivierung einen Fehler aus. Wenn jedoch content_validation nicht gewünscht ist, kann eine Größe von mehr als 4 MB optimal sein. Es wird nicht empfohlen, dies unter 4 MB festzulegen.
MAX_RANGE_SIZE	int Die Größe der Bereiche, die von create_file_from_*-Methoden eingefügt werden. Kleinere Bereiche können eingefügt werden, wenn weniger Daten bereitgestellt werden. Die maximale Bereichsgröße, die vom Dienst unterstützt wird, beträgt 4 MB.

Methoden

abort_copy_file	Bricht einen ausstehenden copy_file-Vorgang ab, und belässt eine Zieldatei mit null Länge und vollständigen Metadaten.
clear_range	Löscht den angegebenen Bereich und gibt den im Speicher verwendeten Speicherplatz für diesen Bereich frei.
close_handles	Gibt einen Generator zurück, um geöffnete Handles in einem Verzeichnis oder einer Datei unter der angegebenen Freigabe zu schließen. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Handles geschlossen wurden. Die zurückgegebenen Werte stellen die Anzahl der Handles dar, die in jeder Transaktion geschlossen wurden.
copy_file	Kopiert eine Datei asynchron. Dieser Vorgang gibt ein Objekt mit den Eigenschaften des Kopiervorgangs zurück, einschließlich einer Kopier-ID, die Sie zum Überprüfen oder Abbrechen des Kopiervorgangs verwenden können. Der Dateidienst kopiert Dateien auf best-effort-Basis. Wenn die Zieldatei vorhanden ist, wird sie überschrieben. Die Zieldatei kann nicht geändert werden, während der Kopiervorgang ausgeführt wird.
create_directory	Erstellt ein neues Verzeichnis unter dem angegebenen Freigabe- oder übergeordneten Verzeichnis. Wenn das Verzeichnis mit demselben Namen bereits vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client geschluckt. Um die Ausnahme verfügbar zu machen, geben Sie true für fail_on_exists an.
create_file	Erstellt eine neue Datei. Unter create_file_from_* finden Sie allgemeine Funktionen, die das Erstellen und Hochladen großer Dateien mit automatischen Blöcken und Statusbenachrichtigungen behandeln.
create_file_from_bytes	Erstellt eine neue Datei aus einem Bytearray oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.
create_file_from_path	Erstellt eine neue Azure-Datei aus einem lokalen Dateipfad oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.
create_file_from_stream	Erstellt eine neue Datei aus einer Datei/einem Stream oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.
create_file_from_text	Erstellt eine neue Datei aus str/unicode oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.
create_permission_for_share	Erstellen Sie eine Berechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden. Wenn eine "Berechtigung" bereits vorhanden ist, gibt sie den Schlüssel zurück, andernfalls erstellt sie eine neue Berechtigung auf Freigabeebene und gibt ihren Schlüssel zurück. :gibt einen Dateiberechtigungsschlüssel zurück :rtype str
create_share	Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn die Freigabe mit demselben Namen bereits vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client geschluckt. Um die Ausnahme verfügbar zu machen, geben Sie true für fail_on_exists an.
delete_directory	Löscht das angegebene leere Verzeichnis. Beachten Sie, dass das Verzeichnis leer sein muss, es kann sonst nicht gelöscht werden. Der Versuch, verzeichnisse zu löschen, die nicht leer sind, schlägt fehl. Wenn das Verzeichnis nicht vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client verschluckt. Geben Sie true für fail_not_exist an, um die Ausnahme verfügbar zu machen.
delete_file	Markiert die angegebene Datei zum Löschen. Die Datei wird später während der Garbage Collection gelöscht.
delete_share	Markiert die angegebene Freigabe zum Löschen. Wenn die Freigabe nicht vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client verschluckt. Geben Sie true für fail_not_exist an, um die Ausnahme verfügbar zu machen.
exists	Gibt einen booleschen Wert zurück, der angibt, ob die Freigabe vorhanden ist, wenn nur der Freigabename angegeben wird. Wenn directory_name angegeben ist, wird ein boolescher Wert zurückgegeben, der angibt, ob das Verzeichnis vorhanden ist. Wenn auch file_name angegeben ist, wird ein boolescher Wert zurückgegeben, der angibt, ob die Datei vorhanden ist.
generate_account_shared_access_signature	Generiert eine Shared Access Signature für den Dateidienst. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token des FileService.Use the returned signature with the sas_token parameter of the FileService.
generate_file_shared_access_signature	Generiert eine Shared Access Signature für die Datei. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token von FileService.
generate_share_shared_access_signature	Generiert eine Shared Access Signature für die Freigabe. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token von FileService.
get_directory_metadata	Gibt alle benutzerdefinierten Metadaten für das angegebene Verzeichnis zurück.
get_directory_properties	Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für das angegebene Verzeichnis zurück. Die zurückgegebenen Daten enthalten nicht die Dateiliste des Verzeichnisses.
get_file_metadata	Gibt alle benutzerdefinierten Metadaten für die angegebene Datei zurück.
get_file_properties	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Gibt einen instance von File mit FileProperties und einem Metadatendict zurück.
get_file_service_properties	Ruft die Eigenschaften des Dateidiensts eines Speicherkontos ab, einschließlich Azure Storage Analytics.
get_file_to_bytes	Lädt eine Datei als Bytearray mit automatischen Block- und Statusbenachrichtigungen herunter. Gibt eine instance von File mit Eigenschaften, Metadaten und Inhalten zurück.
get_file_to_path	Lädt eine Datei in einen Dateipfad mit automatischen Blöcken und Statusbenachrichtigungen herunter. Gibt eine instance datei mit Eigenschaften und Metadaten zurück.
get_file_to_stream	Lädt eine Datei mit automatischen Block- und Statusbenachrichtigungen in einen Stream herunter. Gibt eine instance von File mit Eigenschaften und Metadaten zurück.
get_file_to_text	Lädt eine Datei als Unicode-Text mit automatischen Block- und Statusbenachrichtigungen herunter. Gibt eine instance von File mit Eigenschaften, Metadaten und Inhalten zurück.
get_permission_for_share	Erstellen Sie eine Berechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden. Wenn bereits eine "Berechtigung" vorhanden ist, gibt sie den Schlüssel zurück, andernfalls erstellt sie eine neue Berechtigung auf Freigabeebene und gibt ihren Schlüssel zurück. :returns a file permission(a portable SDDL) :rtype str
get_share_acl	Ruft die Berechtigungen für die angegebene Freigabe ab.
get_share_metadata	Gibt alle benutzerdefinierten Metadaten für die angegebene Freigabe zurück.
get_share_properties	Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Freigabe zurück. Die zurückgegebenen Daten enthalten nicht die Liste der Dateien oder Verzeichnisse der Freigaben.
get_share_stats	Ruft die ungefähre Größe der auf der Freigabe gespeicherten Daten ab, aufgerundet auf das nächste Gigabyte. Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich neu erstellten Dateien enthält.
get_share_stats_in_bytes	Ruft die ungefähre Größe der auf der Freigabe gespeicherten Daten in Bytes ab. Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich neu erstellten Dateien enthält.
list_directories_and_files	Gibt einen Generator zurück, um die Verzeichnisse und Dateien unter der angegebenen Freigabe aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Verzeichnisse und Dateien zurückgegeben wurden oder num_results erreicht wurde. Wenn num_results angegeben ist und die Freigabe über mehr als diese Anzahl von Dateien und Verzeichnissen verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.
list_handles	Gibt einen Generator zurück, um geöffnete Handles in einem Verzeichnis oder einer Datei unter der angegebenen Freigabe aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Handles zurückgegeben wurden oder num_results erreicht wurde. Wenn num_results angegeben ist und die Freigabe über mehr als diese Anzahl von Dateien und Verzeichnissen verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.
list_ranges	Ruft die gültigen Bereiche für eine Datei ab.
list_shares	Gibt einen Generator zurück, um die Freigaben unter dem angegebenen Konto aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Freigaben zurückgegeben wurden oder num_results erreicht wurde. Wenn num_results angegeben ist und das Konto über mehr als diese Anzahl von Freigaben verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.
make_file_url	Erstellt die URL für den Zugriff auf eine Datei.
resize_file	Ändert die Größe einer Datei in die angegebene Größe. Wenn der angegebene Byte-Wert kleiner als die aktuelle Größe der Datei ist, werden alle Bereiche über dem angegebenen Byte-Wert gelöscht.
set_directory_metadata	Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für das angegebene Verzeichnis fest. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die dem Verzeichnis zugeordnet sind. Um alle Metadaten aus dem Verzeichnis zu entfernen, rufen Sie diesen Vorgang ohne Metadatendikt auf.
set_directory_properties
set_file_metadata	Legt benutzerdefinierte Metadaten für die angegebene Datei als mindestens ein Name-Wert-Paar fest.
set_file_properties	Legt Systemeigenschaften für die Datei fest. Wenn eine Eigenschaft für die content_settings festgelegt ist, werden alle Eigenschaften überschrieben.
set_file_service_properties	Legt die Eigenschaften des Dateidiensts eines Speicherkontos fest, einschließlich Azure Storage Analytics. Wenn ein Element (ex HourMetrics) als None belassen wird, werden die vorhandenen Einstellungen für diese Funktionalität im Dienst beibehalten.
set_share_acl	Legt die Berechtigungen für die angegebenen Freigabe- oder gespeicherten Zugriffsrichtlinien fest, die mit Shared Access Signatures verwendet werden können.
set_share_metadata	Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Freigabe fest. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die an die Freigabe angefügt sind. Um alle Metadaten aus der Freigabe zu entfernen, rufen Sie diesen Vorgang ohne Metadatenedikt auf.
set_share_properties	Legt vom Dienst definierte Eigenschaften für die angegebene Freigabe fest.
snapshot_share	Erstellt eine Momentaufnahme einer vorhandenen Freigabe unter dem angegebenen Konto.
update_range	Schreibt die vom Anforderungstext angegebenen Bytes in den angegebenen Bereich.
update_range_from_file_url	Schreibt die Bytes von einem Azure-Dateiendpunkt in den angegebenen Bereich eines anderen Azure-Dateiendpunkts.

abort_copy_file

Bricht einen ausstehenden copy_file-Vorgang ab, und belässt eine Zieldatei mit null Länge und vollständigen Metadaten.

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der Zielfreigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der Zieldatei.
copy_id Erforderlich	str Kopierbezeichner, der im copy.id des ursprünglichen copy_file-Vorgangs angegeben wurde.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

clear_range

Löscht den angegebenen Bereich und gibt den im Speicher verwendeten Speicherplatz für diesen Bereich frei.

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
start_range Erforderlich	int Start des Bytebereichs, der zum Löschen eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
end_range Erforderlich	int Ende des Bytebereichs, der zum Löschen eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

close_handles

Gibt einen Generator zurück, um geöffnete Handles in einem Verzeichnis oder einer Datei unter der angegebenen Freigabe zu schließen. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Handles geschlossen wurden. Die zurückgegebenen Werte stellen die Anzahl der Handles dar, die in jeder Transaktion geschlossen wurden.

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name	str Der Pfad zum Verzeichnis. Standardwert: None
file_name	str Der Name der vorhandenen Datei. Standardwert: None
recursive	bool Boolean, der angibt, ob der Vorgang auf das im URI angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und ihre Dateien angewendet werden soll. Standardwert: None
handle_id	str Erforderlich. Gibt die Handle-ID an, die für die zu schließende Datei oder das Verzeichnis geöffnet wird. Astrix ('*') ist ein Platzhalter, der alle Handles angibt. Standardwert: None
marker	str Ein undurchsichtiges Fortsetzungstoken. Dieser Wert kann aus dem next_marker Feld eines vorherigen Generatorobjekts abgerufen werden, wenn es nicht abgeschlossen ist, schließende Handles zu schließen. Wenn angegeben, beginnt dieser Generator mit dem Schließen von Handles an dem Punkt, an dem der vorherige Generator angehalten wurde. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

copy_file

Kopiert eine Datei asynchron. Dieser Vorgang gibt ein Objekt mit den Eigenschaften des Kopiervorgangs zurück, einschließlich einer Kopier-ID, die Sie zum Überprüfen oder Abbrechen des Kopiervorgangs verwenden können. Der Dateidienst kopiert Dateien auf best-effort-Basis.

Wenn die Zieldatei vorhanden ist, wird sie überschrieben. Die Zieldatei kann nicht geändert werden, während der Kopiervorgang ausgeführt wird.

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der Zielfreigabe. Die Freigabe muss vorhanden sein.
directory_name Erforderlich	str Name des Zielverzeichnisses. Das Verzeichnis muss vorhanden sein.
file_name Erforderlich	str Name der Zieldatei. Wenn die Zieldatei vorhanden ist, wird sie überschrieben. Andernfalls wird sie erstellt.
copy_source Erforderlich	str Eine URL mit einer Länge von bis zu 2 KB, die eine Azure-Datei oder ein Azure-Blob angibt. Der Wert sollte so URL-codiert sein, wie er in einem Anforderungs-URI verwendet wird. Wenn sich die Quelle in einem anderen Konto befindet, muss die Quelle entweder öffentlich sein oder über eine Shared Access Signature authentifiziert werden. Wenn die Quelle öffentlich ist, ist keine Authentifizierung erforderlich. Beispiele: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Wenn keine Name-Wert-Paare angegeben werden, kopiert der Vorgang die Metadaten aus dem Quellblob oder der Quelldatei in die Zieldatei. Wenn mindestens ein Name-Wert-Paar angegeben wird, wird die Zieldatei mit den angegebenen Metadaten erstellt, und die Metadaten werden nicht aus dem Quellblob oder der Quelldatei kopiert. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
CopyProperties	Kopiervorgangseigenschaften wie status, Quelle und ID.

create_directory

Erstellt ein neues Verzeichnis unter dem angegebenen Freigabe- oder übergeordneten Verzeichnis. Wenn das Verzeichnis mit demselben Namen bereits vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client geschluckt. Um die Ausnahme verfügbar zu machen, geben Sie true für fail_on_exists an.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Name des zu erstellenden Verzeichnisses, einschließlich des Pfads zum übergeordneten Verzeichnis.
metadata	dict(str, str)<xref::> Ein Diktat mit name_value Paaren, die der Freigabe als Metadaten zugeordnet werden sollen. Beispiel:{'Category':'test'} Standardwert: None
fail_on_exist	bool Geben Sie an, ob eine Ausnahme ausgelöst werden soll, wenn das Verzeichnis vorhanden ist. Der Standardwert ist gleich „False“. Standardwert: False
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
bool	True, wenn das Verzeichnis erstellt wird, False, wenn das Verzeichnis bereits vorhanden ist.

create_file

Erstellt eine neue Datei.

Unter create_file_from_* finden Sie allgemeine Funktionen, die das Erstellen und Hochladen großer Dateien mit automatischen Blöcken und Statusbenachrichtigungen behandeln.

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der zu erstellenden oder zu aktualisierenden Datei.
content_length Erforderlich	int Die Länge der Datei in Byte.
content_settings	ContentSettings ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Standardwert: None
metadata	dict(str, str) Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Standardwert: None
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

create_file_from_bytes

Erstellt eine neue Datei aus einem Bytearray oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der zu erstellenden oder zu aktualisierenden Datei.
file Erforderlich	str Inhalt der Datei als Array von Bytes.
index	int Starten Sie den Index im Bytearray. Standardwert: 0
count	int Anzahl der hochzuladenden Bytes. Legen Sie auf Keinen oder negativen Wert fest, um alle Bytes ab dem Index hochzuladen. Standardwert: None
content_settings	ContentSettings ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Standardwert: None
metadata	dict(str, str) Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Standardwert: None
validate_content	bool Wenn true, wird ein MD5-Hash für jeden Bereich der Datei berechnet. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie nützlich für die Erkennung von Bitflips im Kabel, wenn die Verwendung von http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit der Datei gespeichert wird. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und total die Größe der Datei ist, oder Keine, wenn die Gesamtgröße unbekannt ist. Standardwert: None
max_connections	int Maximale Anzahl der zu verwendenden parallelen Verbindungen. Standardwert: 2
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe des Azure-Diensts tätigen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None

create_file_from_path

Erstellt eine neue Azure-Datei aus einem lokalen Dateipfad oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der zu erstellenden oder zu aktualisierenden Datei.
local_file_path Erforderlich	str Pfad der lokalen Datei, die als Dateiinhalt hochgeladen werden soll.
content_settings	ContentSettings ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Standardwert: None
metadata	dict(str, str) Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Standardwert: None
validate_content	bool Wenn true, wird ein MD5-Hash für jeden Bereich der Datei berechnet. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie nützlich für die Erkennung von Bitflips im Kabel, wenn die Verwendung von http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit der Datei gespeichert wird. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und total die Größe der Datei ist, oder Keine, wenn die Gesamtgröße unbekannt ist. Standardwert: None
max_connections	int Maximale Anzahl der zu verwendenden parallelen Verbindungen. Standardwert: 2
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe des Azure-Diensts tätigen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None

create_file_from_stream

Erstellt eine neue Datei aus einer Datei/einem Stream oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der zu erstellenden oder zu aktualisierenden Datei.
stream Erforderlich	IOBase Datei/Stream zum Hochladen als Dateiinhalt geöffnet.
count Erforderlich	int Anzahl der Bytes, die aus dem Stream gelesen werden sollen. Dies ist erforderlich, eine Datei kann nicht erstellt werden, wenn die Anzahl unbekannt ist.
content_settings	ContentSettings ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Standardwert: None
metadata	dict(str, str) Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Standardwert: None
validate_content	bool Wenn true, wird ein MD5-Hash für jeden Bereich der Datei berechnet. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie nützlich für die Erkennung von Bitflips im Kabel, wenn die Verwendung von http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit der Datei gespeichert wird. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und total die Größe der Datei ist, oder Keine, wenn die Gesamtgröße unbekannt ist. Standardwert: None
max_connections	int Maximale Anzahl der zu verwendenden parallelen Verbindungen. Beachten Sie, dass für den parallelen Upload der Datenstrom suchbar ist. Standardwert: 2
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe des Azure-Diensts tätigen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None

create_file_from_text

Erstellt eine neue Datei aus str/unicode oder aktualisiert den Inhalt einer vorhandenen Datei mit automatischen Blöcken und Statusbenachrichtigungen.

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der zu erstellenden oder zu aktualisierenden Datei.
text Erforderlich	str Text, der in die Datei hochgeladen werden soll.
encoding	str Python-Codierung, die zum Konvertieren des Texts in Bytes verwendet werden soll. Standardwert: utf-8
content_settings	ContentSettings ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Standardwert: None
metadata	dict(str, str) Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind. Standardwert: None
validate_content	bool Wenn true, wird ein MD5-Hash für jeden Bereich der Datei berechnet. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie nützlich für die Erkennung von Bitflips im Kabel, wenn die Verwendung von http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit der Datei gespeichert wird. Standardwert: False
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe des Azure-Diensts tätigen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None

create_permission_for_share

Erstellen Sie eine Berechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden. Wenn eine "Berechtigung" bereits vorhanden ist, gibt sie den Schlüssel zurück, andernfalls erstellt sie eine neue Berechtigung auf Freigabeebene und gibt ihren Schlüssel zurück.

:gibt einen Dateiberechtigungsschlüssel zurück :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	Name der Freigabe.
file_permission Erforderlich	Dateiberechtigung, eine portable SDDL
timeout	Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

create_share

Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn die Freigabe mit demselben Namen bereits vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client geschluckt. Um die Ausnahme verfügbar zu machen, geben Sie true für fail_on_exists an.

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der zu erstellenden Freigabe.
metadata	dict(str, str) Ein Diktat mit name_value Paaren, die der Freigabe als Metadaten zugeordnet werden sollen. Beispiel:{'Category':'test'} Standardwert: None
quota	int Gibt die maximale Größe der Freigabe in Gigabyte an. Muss größer als 0 und kleiner gleich 5 TB (5120) sein. Standardwert: None
fail_on_exist	bool Geben Sie an, ob eine Ausnahme ausgelöst werden soll, wenn die Freigabe vorhanden ist. Der Standardwert ist gleich „False“. Standardwert: False
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
bool	True, wenn freigabe erstellt wird, False, wenn die Freigabe bereits vorhanden ist.

delete_directory

Löscht das angegebene leere Verzeichnis. Beachten Sie, dass das Verzeichnis leer sein muss, es kann sonst nicht gelöscht werden. Der Versuch, verzeichnisse zu löschen, die nicht leer sind, schlägt fehl.

Wenn das Verzeichnis nicht vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client verschluckt. Geben Sie true für fail_not_exist an, um die Ausnahme verfügbar zu machen.

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Name des zu löschenden Verzeichnisses, einschließlich des Pfads zum übergeordneten Verzeichnis.
fail_not_exist	bool Geben Sie an, ob eine Ausnahme ausgelöst werden soll, wenn das Verzeichnis nicht vorhanden ist. Standardwert: False
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
bool	True, wenn das Verzeichnis gelöscht wird, andernfalls False.

delete_file

Markiert die angegebene Datei zum Löschen. Die Datei wird später während der Garbage Collection gelöscht.

delete_file(share_name, directory_name, file_name, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

delete_share

Markiert die angegebene Freigabe zum Löschen. Wenn die Freigabe nicht vorhanden ist, schlägt der Vorgang für den Dienst fehl. Standardmäßig wird die Ausnahme vom Client verschluckt. Geben Sie true für fail_not_exist an, um die Ausnahme verfügbar zu machen.

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der zu löschenden Freigabe.
fail_not_exist	bool Geben Sie an, ob eine Ausnahme ausgelöst werden soll, wenn die Freigabe nicht vorhanden ist. Der Standardwert ist gleich „False“. Standardwert: False
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Geben Sie dieses Argument an, um nur eine bestimmte Momentaufnahme zu löschen. delete_snapshots muss Keine sein, wenn dies angegeben ist. Standardwert: None
delete_snapshots	DeleteSnapshot Um eine Freigabe mit Momentaufnahmen zu löschen, muss dies als DeleteSnapshot.Include angegeben werden. Standardwert: None

Gibt zurück

Typ	Beschreibung
bool	True, wenn die Freigabe gelöscht wird, ist keine False-Freigabe vorhanden.

exists

Gibt einen booleschen Wert zurück, der angibt, ob die Freigabe vorhanden ist, wenn nur der Freigabename angegeben wird. Wenn directory_name angegeben ist, wird ein boolescher Wert zurückgegeben, der angibt, ob das Verzeichnis vorhanden ist. Wenn auch file_name angegeben ist, wird ein boolescher Wert zurückgegeben, der angibt, ob die Datei vorhanden ist.

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name einer Freigabe.
directory_name	str Der Pfad zu einem Verzeichnis. Standardwert: None
file_name	str Name einer Datei. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
bool	Ein boolescher Wert, der angibt, ob die Ressource vorhanden ist.

generate_account_shared_access_signature

Generiert eine Shared Access Signature für den Dateidienst. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token des FileService.Use the returned signature with the sas_token parameter of the FileService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parameter

Name	Beschreibung
resource_types Erforderlich	<xref:ResourceTypes> Gibt die Ressourcentypen an, auf die mit der Konto-SAS zugegriffen werden kann.
permission Erforderlich	<xref:AccountPermissions> Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.
expiry Erforderlich	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.
start	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Standardwert: None
ip	str Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise sip=168.1.5.65 oder sip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt. Standardwert: None
protocol	str Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Mögliche Werte sind https und HTTP (https, http) oder nur HTTPS (https). Der Standardwert ist https,http. Beachten Sie, dass HTTP allein kein zulässiger Wert ist. Standardwert: None

Gibt zurück

Typ	Beschreibung
str	Ein Sas-Token (Shared Access Signature).

generate_file_shared_access_signature

Generiert eine Shared Access Signature für die Datei. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token von FileService.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der Freigabe.
directory_name	str Name des Verzeichnisses. SAS-Token können nicht für Verzeichnisse erstellt werden, daher sollte dieser Parameter nur vorhanden sein, wenn file_name bereitgestellt wird. Standardwert: None
file_name	str Name der Datei. Standardwert: None
permission	FilePermissions Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Berechtigungen müssen nach Lese-, Erstellungs-, Schreib-, Lösch- und Listenberechtigungen sortiert werden. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Standardwert: None
expiry	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Standardwert: None
start	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Standardwert: None
id	str Ein eindeutiger Wert mit einer Länge von bis zu 64 Zeichen, der mit einer gespeicherten Zugriffsrichtlinie korreliert. Verwenden Sie set_file_service_properties, um eine gespeicherte Zugriffsrichtlinie zu erstellen. Standardwert: None
ip	str Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise sip=168.1.5.65 oder sip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt. Standardwert: None
protocol	str Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Mögliche Werte sind https und HTTP (https, http) oder nur HTTPS (https). Der Standardwert ist https,http. Beachten Sie, dass HTTP allein kein zulässiger Wert ist. Standardwert: None
cache_control	str Antwortheaderwert für Cache-Control, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird. Standardwert: None
content_disposition	str Antwortheaderwert für Content-Disposition, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird. Standardwert: None
content_encoding	str Antwortheaderwert für Content-Encoding, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None
content_language	str Antwortheaderwert für Content-Language, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None
content_type	str Antwortheaderwert für Content-Type, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None

Gibt zurück

Typ	Beschreibung
str	Ein Sas-Token (Shared Access Signature).

generate_share_shared_access_signature

Generiert eine Shared Access Signature für die Freigabe. Verwenden Sie die zurückgegebene Signatur mit dem parameter sas_token von FileService.

generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der Freigabe.
permission	SharePermissions Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Berechtigungen müssen nach Lese-, Erstellungs-, Schreib-, Lösch- und Listenberechtigungen sortiert werden. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Standardwert: None
expiry	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Standardwert: None
start	datetime oder str Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Standardwert: None
id	str Ein eindeutiger Wert mit einer Länge von bis zu 64 Zeichen, der mit einer gespeicherten Zugriffsrichtlinie korreliert. Verwenden Sie set_share_aclzum Erstellen einer gespeicherten Zugriffsrichtlinie . Standardwert: None
ip	str Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise sip=168.1.5.65 oder sip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt. Standardwert: None
protocol	str Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Mögliche Werte sind https und HTTP (https, http) oder nur HTTPS (https). Der Standardwert ist https,http. Beachten Sie, dass HTTP allein kein zulässiger Wert ist. Standardwert: None
cache_control	str Antwortheaderwert für Cache-Control, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird. Standardwert: None
content_disposition	str Antwortheaderwert für Content-Disposition, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird. Standardwert: None
content_encoding	str Antwortheaderwert für Content-Encoding, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None
content_language	str Antwortheaderwert für Content-Language, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None
content_type	str Antwortheaderwert für Content-Type, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird. Standardwert: None

Gibt zurück

Typ	Beschreibung
str	Ein Sas-Token (Shared Access Signature).

get_directory_metadata

Gibt alle benutzerdefinierten Metadaten für das angegebene Verzeichnis zurück.

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
dict(str, str)	Ein Wörterbuch, das den Namen der Verzeichnismetadaten und Wertepaare darstellt.

get_directory_properties

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für das angegebene Verzeichnis zurück. Die zurückgegebenen Daten enthalten nicht die Dateiliste des Verzeichnisses.

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zu einem vorhandenen Verzeichnis.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
Directory	-Eigenschaften für das angegebene Verzeichnis in einem Verzeichnisobjekt.

get_file_metadata

Gibt alle benutzerdefinierten Metadaten für die angegebene Datei zurück.

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
dict(str, str)	Ein Wörterbuch, das den Namen der Dateimetadaten und Wertepaare darstellt.

get_file_properties

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Gibt einen instance von File mit FileProperties und einem Metadatendict zurück.

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
File	ein Dateiobjekt, das Eigenschaften und Metadaten enthält.

get_file_service_properties

Ruft die Eigenschaften des Dateidiensts eines Speicherkontos ab, einschließlich Azure Storage Analytics.

get_file_service_properties(timeout=None)

Parameter

Name	Beschreibung
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
ServiceProperties	Die Dateidiensteigenschaften.

get_file_to_bytes

Lädt eine Datei als Bytearray mit automatischen Block- und Statusbenachrichtigungen herunter. Gibt eine instance von File mit Eigenschaften, Metadaten und Inhalten zurück.

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
start_range	int Anfang des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn kein end_range angegeben wird, werden alle Bytes nach dem start_range heruntergeladen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
end_range	int Ende des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn end_range gegeben ist, muss start_range angegeben werden. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
validate_content	bool Wenn dieser Wert auf TRUE festgelegt ist, wird ein MD5-Hash für jeden abgerufenen Teil der Datei überprüft. Dies ist in erster Linie hilfreich für die Erkennung von Bitflips im Netzwerk, wenn http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass der Dienst nur transaktionale MD5s für Blöcke mit einer Größe von 4 MB oder weniger zurückgibt, sodass die erste Get-Anforderung die Größe selbst aufweist. MAX_CHUNK_GET_SIZE statt sich selbst. MAX_SINGLE_GET_SIZE. Wenn sich selbst. MAX_CHUNK_GET_SIZE auf größer als 4 MB festgelegt wurde, wird ein Fehler ausgelöst. Da das Berechnen des MD5 Verarbeitungszeit in Anspruch nimmt und aufgrund der geringeren Blockgröße mehr Anforderungen ausgeführt werden müssen, kann die Latenz etwas erhöht werden. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und die Gesamtgröße der Datei entspricht, sofern bekannt. Standardwert: None
max_connections	int Wenn dieser Wert auf 2 oder höher festgelegt ist, erfolgt ein erster Get für das erste Selbst. MAX_SINGLE_GET_SIZE Bytes der Datei. Wenn dies die gesamte Datei ist, gibt die Methode an diesem Punkt zurück. Andernfalls werden die verbleibenden Daten parallel heruntergeladen, wobei die Anzahl der Threads gleich max_connections wird. Jeder Block ist selbst groß. MAX_CHUNK_GET_SIZE. Wenn dieser Wert auf 1 festgelegt ist, wird eine einzelne große Get-Anforderung ausgeführt. Dies wird im Allgemeinen nicht empfohlen, ist aber verfügbar, wenn nur sehr wenige Threads verwendet werden sollen, Netzwerkanforderungen sehr teuer sind oder ein nicht suchbarer Stream den parallelen Download verhindert. Dies kann auch hilfreich sein, wenn die Datei gleichzeitig geändert wird, um die Unteilbarkeit zu erzwingen, oder wenn erwartet wird, dass viele Dateien leer sind, da eine zusätzliche Anforderung für leere Dateien erforderlich ist, wenn max_connections größer als 1 ist. Standardwert: 2
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe an den Azure-Dienst ausführen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
File	Eine Datei mit Eigenschaften, Inhalten und Metadaten.

get_file_to_path

Lädt eine Datei in einen Dateipfad mit automatischen Blöcken und Statusbenachrichtigungen herunter. Gibt eine instance datei mit Eigenschaften und Metadaten zurück.

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
file_path Erforderlich	str Pfad der Datei, in die geschrieben werden soll.
open_mode	str Modus, der beim Öffnen der Datei verwendet werden soll. Beachten Sie, dass die Angabe von append only open_mode den parallelen Download verhindert. Daher muss max_connections auf 1 festgelegt werden, wenn diese open_mode verwendet wird. Standardwert: wb
start_range	int Anfang des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn kein end_range angegeben wird, werden alle Bytes nach dem start_range heruntergeladen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
end_range	int Ende des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn end_range gegeben ist, muss start_range angegeben werden. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
validate_content	bool Wenn dieser Wert auf TRUE festgelegt ist, wird ein MD5-Hash für jeden abgerufenen Teil der Datei überprüft. Dies ist in erster Linie hilfreich für die Erkennung von Bitflips im Netzwerk, wenn http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass der Dienst nur transaktionale MD5s für Blöcke mit einer Größe von 4 MB oder weniger zurückgibt, sodass die erste Get-Anforderung die Größe selbst aufweist. MAX_CHUNK_GET_SIZE statt sich selbst. MAX_SINGLE_GET_SIZE. Wenn sich selbst. MAX_CHUNK_GET_SIZE auf größer als 4 MB festgelegt wurde, wird ein Fehler ausgelöst. Da das Berechnen des MD5 Verarbeitungszeit in Anspruch nimmt und aufgrund der geringeren Blockgröße mehr Anforderungen ausgeführt werden müssen, kann die Latenz etwas erhöht werden. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und die Gesamtgröße der Datei entspricht, sofern bekannt. Standardwert: None
max_connections	int Wenn dieser Wert auf 2 oder höher festgelegt ist, erfolgt ein erster Get für das erste Selbst. MAX_SINGLE_GET_SIZE Bytes der Datei. Wenn dies die gesamte Datei ist, gibt die Methode an diesem Punkt zurück. Andernfalls werden die verbleibenden Daten parallel heruntergeladen, wobei die Anzahl der Threads gleich max_connections wird. Jeder Block ist selbst groß. MAX_CHUNK_GET_SIZE. Wenn dieser Wert auf 1 festgelegt ist, wird eine einzelne große Get-Anforderung ausgeführt. Dies wird im Allgemeinen nicht empfohlen, ist aber verfügbar, wenn nur sehr wenige Threads verwendet werden sollen, Netzwerkanforderungen sehr teuer sind oder ein nicht suchbarer Stream den parallelen Download verhindert. Dies kann auch hilfreich sein, wenn die Datei gleichzeitig geändert wird, um die Unteilbarkeit zu erzwingen, oder wenn erwartet wird, dass viele Dateien leer sind, da eine zusätzliche Anforderung für leere Dateien erforderlich ist, wenn max_connections größer als 1 ist. Standardwert: 2
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe an den Azure-Dienst ausführen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
File	Eine Datei mit Eigenschaften und Metadaten.

get_file_to_stream

Lädt eine Datei mit automatischen Block- und Statusbenachrichtigungen in einen Stream herunter. Gibt eine instance von File mit Eigenschaften und Metadaten zurück.

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
stream Erforderlich	IOBase Geöffnete Datei/Datenstrom zum Schreiben.
start_range	int Anfang des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn kein end_range angegeben wird, werden alle Bytes nach dem start_range heruntergeladen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
end_range	int Ende des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn end_range gegeben ist, muss start_range angegeben werden. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
validate_content	bool Wenn dieser Wert auf TRUE festgelegt ist, wird ein MD5-Hash für jeden abgerufenen Teil der Datei überprüft. Dies ist in erster Linie hilfreich für die Erkennung von Bitflips im Netzwerk, wenn http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass der Dienst nur transaktionale MD5s für Blöcke mit einer Größe von 4 MB oder weniger zurückgibt, sodass die erste Get-Anforderung die Größe selbst aufweist. MAX_CHUNK_GET_SIZE statt sich selbst. MAX_SINGLE_GET_SIZE. Wenn sich selbst. MAX_CHUNK_GET_SIZE auf größer als 4 MB festgelegt wurde, wird ein Fehler ausgelöst. Da das Berechnen des MD5 Verarbeitungszeit in Anspruch nimmt und aufgrund der geringeren Blockgröße mehr Anforderungen ausgeführt werden müssen, kann die Latenz etwas erhöht werden. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und die Gesamtgröße der Datei entspricht, sofern bekannt. Standardwert: None
max_connections	int Wenn dieser Wert auf 2 oder höher festgelegt ist, erfolgt ein erster Get für das erste Selbst. MAX_SINGLE_GET_SIZE Bytes der Datei. Wenn dies die gesamte Datei ist, gibt die Methode an diesem Punkt zurück. Andernfalls werden die verbleibenden Daten parallel heruntergeladen, wobei die Anzahl der Threads gleich max_connections wird. Jeder Block ist selbst groß. MAX_CHUNK_GET_SIZE. Wenn dieser Wert auf 1 festgelegt ist, wird eine einzelne große Get-Anforderung ausgeführt. Dies wird im Allgemeinen nicht empfohlen, ist aber verfügbar, wenn nur sehr wenige Threads verwendet werden sollen, Netzwerkanforderungen sehr teuer sind oder ein nicht suchbarer Stream den parallelen Download verhindert. Dies kann auch hilfreich sein, wenn die Datei gleichzeitig geändert wird, um die Unteilbarkeit zu erzwingen, oder wenn erwartet wird, dass viele Dateien leer sind, da eine zusätzliche Anforderung für leere Dateien erforderlich ist, wenn max_connections größer als 1 ist. Standardwert: 2
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe an den Azure-Dienst ausführen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
File	Eine Datei mit Eigenschaften und Metadaten.

get_file_to_text

Lädt eine Datei als Unicode-Text mit automatischen Block- und Statusbenachrichtigungen herunter. Gibt eine instance von File mit Eigenschaften, Metadaten und Inhalten zurück.

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
encoding	str Python-Codierung, die beim Decodieren der Dateidaten verwendet werden soll. Standardwert: utf-8
start_range	int Anfang des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn kein end_range angegeben wird, werden alle Bytes nach dem start_range heruntergeladen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
end_range	int Ende des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Wenn end_range gegeben ist, muss start_range angegeben werden. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
validate_content	bool Wenn dieser Wert auf TRUE festgelegt ist, wird ein MD5-Hash für jeden abgerufenen Teil der Datei überprüft. Dies ist in erster Linie hilfreich für die Erkennung von Bitflips im Netzwerk, wenn http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass der Dienst nur transaktionale MD5s für Blöcke mit einer Größe von 4 MB oder weniger zurückgibt, sodass die erste Get-Anforderung die Größe selbst aufweist. MAX_CHUNK_GET_SIZE statt sich selbst. MAX_SINGLE_GET_SIZE. Wenn sich selbst. MAX_CHUNK_GET_SIZE auf größer als 4 MB festgelegt wurde, wird ein Fehler ausgelöst. Da das Berechnen des MD5 Verarbeitungszeit in Anspruch nimmt und aufgrund der geringeren Blockgröße mehr Anforderungen ausgeführt werden müssen, kann die Latenz etwas erhöht werden. Standardwert: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rückruf für den Fortschritt mit der Signaturfunktion (current, total), wobei current die Anzahl der bisher übertragenen Bytes und die Gesamtgröße der Datei entspricht, sofern bekannt. Standardwert: None
max_connections	int Wenn dieser Wert auf 2 oder höher festgelegt ist, erfolgt ein erster Get für das erste Selbst. MAX_SINGLE_GET_SIZE Bytes der Datei. Wenn dies die gesamte Datei ist, gibt die Methode an diesem Punkt zurück. Andernfalls werden die verbleibenden Daten parallel heruntergeladen, wobei die Anzahl der Threads gleich max_connections wird. Jeder Block ist selbst groß. MAX_CHUNK_GET_SIZE. Wenn dieser Wert auf 1 festgelegt ist, wird eine einzelne große Get-Anforderung ausgeführt. Dies wird im Allgemeinen nicht empfohlen, ist aber verfügbar, wenn nur sehr wenige Threads verwendet werden sollen, Netzwerkanforderungen sehr teuer sind oder ein nicht suchbarer Stream den parallelen Download verhindert. Dies kann auch hilfreich sein, wenn die Datei gleichzeitig geändert wird, um die Unteilbarkeit zu erzwingen, oder wenn erwartet wird, dass viele Dateien leer sind, da eine zusätzliche Anforderung für leere Dateien erforderlich ist, wenn max_connections größer als 1 ist. Standardwert: 2
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Diese Methode kann mehrere Aufrufe an den Azure-Dienst ausführen, und das Timeout gilt für jeden Aufruf einzeln. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
File	Eine Datei mit Eigenschaften, Inhalten und Metadaten.

get_permission_for_share

Erstellen Sie eine Berechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden. Wenn bereits eine "Berechtigung" vorhanden ist, gibt sie den Schlüssel zurück, andernfalls erstellt sie eine neue Berechtigung auf Freigabeebene und gibt ihren Schlüssel zurück.

:returns a file permission(a portable SDDL) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	Name der Freigabe.
file_permission_key Erforderlich	Schlüssel der abzurufenden Dateiberechtigung
timeout	Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

get_share_acl

Ruft die Berechtigungen für die angegebene Freigabe ab.

get_share_acl(share_name, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
dict(str, AccessPolicy)	Ein Wörterbuch mit Zugriffsrichtlinien, die der Freigabe zugeordnet sind.

get_share_metadata

Gibt alle benutzerdefinierten Metadaten für die angegebene Freigabe zurück.

get_share_metadata(share_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
dict(str, str)	Ein Wörterbuch, das den Namen und die Wertepaare der Freigabemetadaten darstellt.

get_share_properties

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Freigabe zurück. Die zurückgegebenen Daten enthalten nicht die Liste der Dateien oder Verzeichnisse der Freigaben.

get_share_properties(share_name, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
Share	Eine Freigabe, die Eigenschaften und Metadaten verfügbar macht.

get_share_stats

Ruft die ungefähre Größe der auf der Freigabe gespeicherten Daten ab, aufgerundet auf das nächste Gigabyte.

Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich neu erstellten Dateien enthält.

get_share_stats(share_name, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
int	die ungefähre Größe der in der Freigabe gespeicherten Daten.

get_share_stats_in_bytes

Ruft die ungefähre Größe der auf der Freigabe gespeicherten Daten in Bytes ab.

Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich neu erstellten Dateien enthält.

get_share_stats_in_bytes(share_name, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
int	die ungefähre Größe der in der Freigabe gespeicherten Daten.

list_directories_and_files

Gibt einen Generator zurück, um die Verzeichnisse und Dateien unter der angegebenen Freigabe aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Verzeichnisse und Dateien zurückgegeben wurden oder num_results erreicht wurde.

Wenn num_results angegeben ist und die Freigabe über mehr als diese Anzahl von Dateien und Verzeichnissen verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name	str Der Pfad zum Verzeichnis. Standardwert: None
num_results	int Gibt die maximale Anzahl von Dateien an, die zurückgegeben werden sollen, einschließlich aller Verzeichniselemente. Wenn die Anforderung nicht num_results oder einen Wert größer als 5.000 angibt, gibt der Server bis zu 5.000 Elemente zurück. Das Festlegen num_results auf einen Wert kleiner oder gleich 0 führt zum Fehlerantwortcode 400 (Ungültige Anforderung). Standardwert: None
marker	str Ein undurchsichtiges Fortsetzungstoken. Dieser Wert kann aus dem next_marker Feld eines vorherigen Generatorobjekts abgerufen werden, wenn num_results angegeben wurde und der Generator die Aufzählung der Ergebnisse abgeschlossen hat. Wenn angegeben, beginnt dieser Generator mit der Rückgabe von Ergebnissen an dem Punkt, an dem der vorherige Generator angehalten wurde. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
prefix	str Listen Sie nur die Dateien und/oder Verzeichnisse mit dem angegebenen Präfix auf. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

list_handles

Gibt einen Generator zurück, um geöffnete Handles in einem Verzeichnis oder einer Datei unter der angegebenen Freigabe aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Handles zurückgegeben wurden oder num_results erreicht wurde.

Wenn num_results angegeben ist und die Freigabe über mehr als diese Anzahl von Dateien und Verzeichnissen verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name	str Der Pfad zum Verzeichnis. Standardwert: None
file_name	str Der Name der vorhandenen Datei. Standardwert: None
recursive	bool Boolean, der angibt, ob der Vorgang auf das im URI angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und ihre Dateien angewendet werden soll. Standardwert: None
max_results	int Gibt die maximale Anzahl von Handles an, die für Dateien und/oder Verzeichnisse verwendet werden, die zurückgegeben werden sollen. Wenn die Anforderung nicht max_results oder einen Wert größer als 5.000 angibt, gibt der Server bis zu 5.000 Elemente zurück. Das Festlegen max_results auf einen Wert kleiner oder gleich 0 führt zu Fehlerantwortcode 400 (Ungültige Anforderung). Standardwert: None
marker	str Ein undurchsichtiges Fortsetzungstoken. Dieser Wert kann aus dem next_marker Feld eines vorherigen Generatorobjekts abgerufen werden, wenn max_results angegeben wurde und der Generator die Aufzählung der Ergebnisse abgeschlossen hat. Wenn angegeben, beginnt dieser Generator mit der Rückgabe von Ergebnissen an dem Punkt, an dem der vorherige Generator angehalten wurde. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

list_ranges

Ruft die gültigen Bereiche für eine Datei ab.

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
start_range	int Gibt den Startoffset von Bytes an, über die Bereiche aufgelistet werden sollen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
end_range	int Gibt den Endoffset von Bytes an, über den Bereiche aufgelistet werden sollen. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
snapshot	str Eine Zeichenfolge, die ggf. die Momentaufnahme Version darstellt. Standardwert: None

Gibt zurück

Typ	Beschreibung
<xref:a> list <xref:of> FileRange	Eine Liste gültiger Bereiche

list_shares

Gibt einen Generator zurück, um die Freigaben unter dem angegebenen Konto aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Freigaben zurückgegeben wurden oder num_results erreicht wurde.

Wenn num_results angegeben ist und das Konto über mehr als diese Anzahl von Freigaben verfügt, verfügt der Generator nach Abschluss über ein aufgefülltes next_marker Feld. Dieser Marker kann verwendet werden, um einen neuen Generator zu erstellen, wenn weitere Ergebnisse gewünscht werden.

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

Parameter

Name	Beschreibung
prefix	str Filtert die Ergebnisse so, dass nur Freigaben zurückgegeben werden, deren Namen mit dem angegebenen Präfix beginnen. Standardwert: None
num_results	int Gibt die maximale zurückzugebende Anzahl von Freigaben an. Standardwert: None
include_metadata	bool Gibt an, dass Freigabemetadaten in der Antwort zurückgegeben werden. Standardwert: False
marker	str Ein undurchsichtiges Fortsetzungstoken. Dieser Wert kann aus dem next_marker Feld eines vorherigen Generatorobjekts abgerufen werden, wenn num_results angegeben wurde und der Generator die Aufzählung der Ergebnisse abgeschlossen hat. Wenn angegeben, beginnt dieser Generator mit der Rückgabe von Ergebnissen an dem Punkt, an dem der vorherige Generator angehalten wurde. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None
include_snapshots	bool Gibt an, dass Freigabemomentaufnahmen in der Antwort zurückgegeben werden. Standardwert: False

make_file_url

Erstellt die URL für den Zugriff auf eine Datei.

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Name der Datei.
protocol	str Zu verwendende Protokoll: "http" oder "https". Wenn nicht angegeben, verwendet das Protokoll, das bei der Initialisierung von FileService angegeben wurde. Standardwert: None
sas_token	str Mit generate_shared_access_signature erstelltes Shared Access Signature-Token. Standardwert: None

Gibt zurück

Typ	Beschreibung
str	Dateizugriffs-URL.

resize_file

Ändert die Größe einer Datei in die angegebene Größe. Wenn der angegebene Byte-Wert kleiner als die aktuelle Größe der Datei ist, werden alle Bereiche über dem angegebenen Byte-Wert gelöscht.

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
content_length Erforderlich	int Die Länge, in die die Dateigröße geändert werden soll.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_directory_metadata

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für das angegebene Verzeichnis fest. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die dem Verzeichnis zugeordnet sind. Um alle Metadaten aus dem Verzeichnis zu entfernen, rufen Sie diesen Vorgang ohne Metadatendikt auf.

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
metadata	dict(str, str)<xref:./> Ein Diktat, das Name-Wert-Paare enthält, die dem Verzeichnis als Metadaten zugeordnet werden sollen. Beispiel: {'category':'test'} Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	Name der Freigabe
directory_name Erforderlich	Name des Verzeichnisses
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_file_metadata

Legt benutzerdefinierte Metadaten für die angegebene Datei als mindestens ein Name-Wert-Paar fest.

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
metadata	dict(str, str) Dict, das Name- und Wertpaare enthält. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die an die Datei angefügt sind. Um alle Metadaten aus der Datei zu entfernen, rufen Sie diesen Vorgang ohne Metadatenheader auf. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_file_properties

Legt Systemeigenschaften für die Datei fest. Wenn eine Eigenschaft für die content_settings festgelegt ist, werden alle Eigenschaften überschrieben.

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
content_settings Erforderlich	ContentSettings ContentSettings-Objekt, das zum Festlegen der Dateieigenschaften verwendet wird.
file_permission	str Dateiberechtigung, eine portable SDDL Standardwert: None
smb_properties	SMBProperties Legt die SMB-bezogenen Dateieigenschaften fest.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_file_service_properties

Legt die Eigenschaften des Dateidiensts eines Speicherkontos fest, einschließlich Azure Storage Analytics. Wenn ein Element (ex HourMetrics) als None belassen wird, werden die vorhandenen Einstellungen für diese Funktionalität im Dienst beibehalten.

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Parameter

Name	Beschreibung
hour_metrics	<xref:Metrics> Die Einstellungen für Stundenmetriken bieten eine Zusammenfassung der Anforderungsstatistiken, die nach API gruppiert sind, in Stündchenaggregaten für Dateien. Standardwert: None
minute_metrics	<xref:Metrics> Die Minutenmetrikeneinstellungen bieten Anforderungsstatistiken für jede Minute für Dateien. Standardwert: None
cors	list(CorsRule) Sie können bis zu fünf CorsRule-Elemente in die Liste aufnehmen. Wenn eine leere Liste angegeben wird, werden alle CORS-Regeln gelöscht, und CORS wird für den Dienst deaktiviert. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_share_acl

Legt die Berechtigungen für die angegebenen Freigabe- oder gespeicherten Zugriffsrichtlinien fest, die mit Shared Access Signatures verwendet werden können.

set_share_acl(share_name, signed_identifiers=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
signed_identifiers	dict(str, AccessPolicy) Ein Wörterbuch mit Zugriffsrichtlinien, die der Freigabe zugeordnet werden sollen. Das Wörterbuch kann bis zu 5 Elemente enthalten. Ein leeres Wörterbuch löscht die Zugriffsrichtlinien, die für den Dienst festgelegt sind. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_share_metadata

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Freigabe fest. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die an die Freigabe angefügt sind. Um alle Metadaten aus der Freigabe zu entfernen, rufen Sie diesen Vorgang ohne Metadatenedikt auf.

set_share_metadata(share_name, metadata=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
metadata	dict(str, str) Ein Diktat, das Name-Wert-Paare enthält, die der Freigabe als Metadaten zugeordnet werden sollen. Beispiel: {'category':'test'} Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

set_share_properties

Legt vom Dienst definierte Eigenschaften für die angegebene Freigabe fest.

set_share_properties(share_name, quota, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
quota Erforderlich	int Gibt die maximale Größe der Freigabe in Gigabyte an. Muss größer als 0 und kleiner als oder gleich 5 TB (5120 GB) sein.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

snapshot_share

Erstellt eine Momentaufnahme einer vorhandenen Freigabe unter dem angegebenen Konto.

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Der Name der Freigabe, von der eine Momentaufnahme erstellt werden soll.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Ein Diktat mit name_value Paaren, die der Freigabe als Metadaten zugeordnet werden sollen. Beispiel:{'Category':'test'} Standardwert: None
quota	int Gibt die maximale Größe der Freigabe in Gigabyte an. Muss größer als 0 und kleiner gleich 5 TB (5120) sein. Standardwert: None
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Gibt zurück

Typ	Beschreibung
Share	Momentaufnahme Eigenschaften

update_range

Schreibt die vom Anforderungstext angegebenen Bytes in den angegebenen Bereich.

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
data Erforderlich	bytes Inhalt des Bereichs.
start_range Erforderlich	int Start des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
end_range Erforderlich	int Ende des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
validate_content	bool Wenn true, wird ein MD5-Hash des Seiteninhalts berechnet. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie nützlich für die Erkennung von Bitflips im Kabel, wenn die Verwendung von http anstelle von https als https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit der Datei gespeichert wird. Standardwert: False
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

update_range_from_file_url

Schreibt die Bytes von einem Azure-Dateiendpunkt in den angegebenen Bereich eines anderen Azure-Dateiendpunkts.

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

Parameter

Name	Beschreibung
share_name Erforderlich	str Name der vorhandenen Freigabe.
directory_name Erforderlich	str Der Pfad zum Verzeichnis.
file_name Erforderlich	str Der Name der vorhandenen Datei.
start_range Erforderlich	int Start des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
end_range Erforderlich	int Ende des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
source Erforderlich	str Eine URL mit einer Länge von bis zu 2 KB, die eine Azure-Datei oder ein Azure-Blob angibt. Der Wert sollte so URL-codiert sein, wie er in einem Anforderungs-URI verwendet wird. Wenn sich die Quelle in einem anderen Konto befindet, muss die Quelle entweder öffentlich sein oder über eine Shared Access Signature authentifiziert werden. Wenn die Quelle öffentlich ist, ist keine Authentifizierung erforderlich. Beispiele: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Erforderlich	int Start des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein. Die start_range und end_range params sind inklusive. Beispiel: start_range=0, end_range=511 lädt die ersten 512 Bytes der Datei herunter.
timeout	int Der timeout-Parameter wird in Sekunden angegeben. Standardwert: None

Attribute

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432