ShareFileClient Klasse

Referenz

Ein Client für die Interaktion mit einer bestimmten Datei, obwohl diese Datei möglicherweise noch nicht vorhanden ist.

Weitere optionale Konfigurationen finden Sie hier.

Vererbung: azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin

ShareFileClient

Konstruktor

ShareFileClient(account_url: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

Parameter

account_url: str

Erforderlich

Der URI für das Speicherkonto. Um einen Client mit dem vollständigen URI für die Datei zu erstellen, verwenden Sie die from_file_url -Klassenmethode.

share_name: str

Erforderlich

Der Name der Freigabe für die Datei.

file_path: str

Erforderlich

Der Dateipfad zu der Datei, mit der interagiert werden soll. Wenn angegeben, überschreibt dieser Wert einen Dateiwert, der in der Datei-URL angegeben ist.

snapshot: str

Standardwert: None

Eine optionale Datei Momentaufnahme, mit der ausgeführt werden soll. Dies kann die Momentaufnahme ID-Zeichenfolge oder die antwort sein, die von create_snapshotzurückgegeben wird.

credential

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt. Der Wert kann eine SAS-Tokenzeichenfolge, eine instance eines AzureSasCredential- oder AzureNamedKeyCredential-Elements von azure.core.credentials, ein kontofreigaber Zugriffsschlüssel oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Wenn der Ressourcen-URI bereits ein SAS-Token enthält, wird dies zugunsten einer expliziten Anmeldeinformation ignoriert.

außer im Fall von AzureSasCredential, bei dem die in Konflikt stehenden SAS-Token einen ValueError auslösen. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

token_intent: Literal['backup']

Erforderlich, wenn TokenCredential für die Authentifizierung verwendet wird und für andere Authentifizierungsformen ignoriert wird. Gibt die Absicht für alle Anforderungen an, wenn die TokenCredential-Authentifizierung verwendet wird. Mögliche Werte:

Backup: Gibt an, dass Anforderungen für Vorgänge vom Sicherungs-/Administratortyp vorgesehen sind. Dies bedeutet, dass alle Datei-/Verzeichnis-ACLs umgangen und vollständige Berechtigungen erteilt werden. Der Benutzer muss außerdem über die erforderliche RBAC-Berechtigung verfügen.

allow_trailing_dot: bool

Wenn true, wird der nachgestellte Punkt nicht vom Ziel-URI gekürzt.

allow_source_trailing_dot: bool

Wenn true, wird der nachgestellte Punkt nicht vom Quell-URI gekürzt.

api_version: str

Die Speicher-API-Version, die für Anforderungen verwendet werden soll. Der Standardwert ist die neueste Dienstversion, die mit dem aktuellen SDK kompatibel ist. Die Einstellung auf eine ältere Version kann zu einer verringerten Featurekompatibilität führen.

Neu in Version 12.1.0.

secondary_hostname: str

Der Hostname des sekundären Endpunkts.

max_range_size: int

Die maximale Bereichsgröße, die für einen Dateiupload verwendet wird. Der Standardwert ist 4*1024*1024.

audience: str

Die Zielgruppe, die beim Anfordern von Token für die Azure Active Directory-Authentifizierung verwendet werden soll. Wirkt sich nur aus, wenn Anmeldeinformationen vom Typ TokenCredential sind. Der Wert kann (Standard) oder https:/.file.core.windows.net sein https://storage.azure.com/ .

Methoden

abort_copy	Abbrechen eines laufenden Kopiervorgangs. Dadurch bleibt eine Zieldatei mit der Länge 0 (null) und vollständigen Metadaten erhalten. Dadurch wird ein Fehler ausgelöst, wenn der Kopiervorgang bereits beendet wurde.
acquire_lease	Fordert eine neue Lease an. Wenn die Datei keine aktive Lease aufweist, erstellt der Dateidienst eine Lease für das Blob und gibt eine neue Lease zurück.
clear_range	Löscht den angegebenen Bereich und gibt den Speicherplatz frei, der im Speicher für diesen Bereich verwendet wird.
close	Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.
close_all_handles	Schließen Sie alle geöffneten Dateihandles. Dieser Vorgang wird blockiert, bis der Dienst alle geöffneten Handles geschlossen hat.
close_handle	Schließen Sie ein geöffnetes Dateihandle.
create_file	Erstellt eine neue Datei. Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird.
delete_file	Markiert die angegebene Datei zum Löschen. Die Datei wird später während der Garbage Collection gelöscht.
download_file	Lädt eine Datei in den StorageStreamDownloader herunter. Die readall()-Methode muss verwendet werden, um den gesamten Inhalt zu lesen, oder readinto() muss verwendet werden, um die Datei in einen Stream herunterzuladen. Die Verwendung von chunks() gibt einen Iterator zurück, der es dem Benutzer ermöglicht, den Inhalt in Blöcken zu durchlaufen.
from_connection_string	Erstellen Sie ShareFileClient aus einer Verbindungszeichenfolge.
from_file_url	Ein Client, der mit einer bestimmten Datei interagiert, obwohl diese Datei möglicherweise noch nicht vorhanden ist.
get_file_properties	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück.
get_ranges	Gibt die Liste der gültigen Seitenbereiche für eine Datei oder Momentaufnahme einer Datei zurück.
get_ranges_diff	Gibt die Liste der gültigen Seitenbereiche für eine Datei oder Momentaufnahme einer Datei zurück. Neu in Version 12.6.0.
list_handles	Listet Handles für die Datei auf.
rename_file	Benennen Sie die Quelldatei um. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes oder str :Schlüsselwort (keyword) file_creation_time: Erstellungszeit für die Datei. :p aramtype file_creation_time:~datetime.datetime oder str :Schlüsselwort (keyword) file_last_write_time: Zeitpunkt des letzten Schreibvorgangs für die Datei. :p aramtype file_last_write_time:~datetime.datetime oder str :Schlüsselwort (keyword) file_change_time: Ändern der Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt. Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.
resize_file	Ändert die Größe einer Datei in die angegebene Größe.
set_file_metadata	Legt benutzerdefinierte Metadaten für die angegebene Datei als mindestens ein Name-Wert-Paar fest. 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 Metadatendict auf.
set_http_headers	Legt HTTP-Header für die Datei fest.
start_copy_from_url	Initiiert das Kopieren von Daten aus einer Quell-URL in die Datei, auf die vom Client verwiesen wird. Die status dieses Kopiervorgangs finden Sie mithilfe der get_properties-Methode.
upload_file	Lädt eine neue Datei hoch. param data: Inhalt der Datei. param int length: Länge der Datei in Bytes. Geben Sie die maximale Größe von bis zu 1 TiB an. param file_attributes: Die Dateisystemattribute für Dateien und Verzeichnisse. Wenn nicht festgelegt, lautet der Standardwert "None", und die Attribute werden auf "Archiv" festgelegt. Hier sehen Sie ein Beispiel für den Var-Typ str: 'Temporary\|Archiv". file_attributes Wert beachtet die Groß-/Kleinschreibung nicht. geben Sie file_attributes ein: str oder ~azure.storage.fileshare.NTFSAttributes param file_creation_time: Erstellungszeit für die Datei Standardwert: Jetzt. geben Sie file_creation_time ein: str oder ~datetime.datetime param file_last_write_time: Letzte Schreibzeit für die Datei Standardwert: Jetzt. geben Sie file_last_write_time ein: str oder ~datetime.datetime param file_permission: Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden. Dieser Header kann verwendet werden, wenn die Berechtigungsgröße = 8 KB beträgt <, andernfalls wird der Header x-ms-file-permission-key verwendet. Standardwert: Erben. Wenn SDDL als Eingabe angegeben wird, muss es besitzer, gruppe und dacl haben. Hinweis: Es sollte nur eine der x-ms-file-permission oder x-ms-file-permission-key angegeben werden. geben Sie file_permission ein: str param permission_key: Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der x-ms-file-permission oder x-ms-file-permission-key angegeben werden. typ permission_key: str
upload_range	Laden Sie einen Bytesbereich in eine Datei hoch.
upload_range_from_url	Schreibt die Bytes von einem Azure-Dateiendpunkt in den angegebenen Bereich eines anderen Azure-Dateiendpunkts.

abort_copy

Abbrechen eines laufenden Kopiervorgangs.

Dadurch bleibt eine Zieldatei mit der Länge 0 (null) und vollständigen Metadaten erhalten. Dadurch wird ein Fehler ausgelöst, wenn der Kopiervorgang bereits beendet wurde.

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

Parameter

copy_id: str oder FileProperties

Erforderlich

Der abzubrechende Kopiervorgang. Dies kann entweder eine ID oder eine instance von FileProperties sein.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

None

acquire_lease

Fordert eine neue Lease an.

Wenn die Datei keine aktive Lease aufweist, erstellt der Dateidienst eine Lease für das Blob und gibt eine neue Lease zurück.

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

Parameter

lease_id: str

Erforderlich

Vorgeschlagene Lease-ID in einem GUID-Zeichenfolgenformat. Der Dateidienst gibt 400 (Ungültige Anforderung) zurück, wenn die vorgeschlagene Lease-ID nicht das richtige Format aufweist.

timeout: int

Gibt zurück

Ein ShareLeaseClient-Objekt.

Rückgabetyp

ShareLeaseClient

Beispiele

Erwerben einer Lease für eine Datei.


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

Löscht den angegebenen Bereich und gibt den Speicherplatz frei, der im Speicher für diesen Bereich verwendet wird.

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

Parameter

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Löschen eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Löschen eines Abschnitts der Datei verwendet werden sollen. Der Bereich kann bis zu 4 MB groß sein.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Dateiupdate:Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

Dict[str, Any]

close

Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.

close()

close_all_handles

Schließen Sie alle geöffneten Dateihandles.

Dieser Vorgang wird blockiert, bis der Dienst alle geöffneten Handles geschlossen hat.

close_all_handles(**kwargs: Any) -> Dict[str, int]

Parameter

timeout: int

Gibt zurück

Die Anzahl der abgeschlossenen Handles (dies kann 0 sein, wenn das angegebene Handle nicht gefunden wurde) und die Anzahl der Handles, die in einem Diktat nicht geschlossen werden konnten.

Rückgabetyp

dict[str, int]

close_handle

Schließen Sie ein geöffnetes Dateihandle.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

Parameter

handle: str oder Handle

Erforderlich

Ein bestimmtes zu schließende Handle.

timeout: int

Gibt zurück

Die Anzahl der abgeschlossenen Handles (dies kann 0 sein, wenn das angegebene Handle nicht gefunden wurde) und die Anzahl der Handles, die in einem Diktat nicht geschlossen werden konnten.

Rückgabetyp

dict[str, int]

create_file

Erstellt eine neue Datei.

Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird.

create_file(size: int, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parameter

size: int

Erforderlich

Gibt die maximale Größe für die Datei an, bis zu 1 TB.

file_attributes: NTFSAttributes

Erforderlich

Die Dateisystemattribute für Dateien und Verzeichnisse. Wenn dieser Wert nicht festgelegt ist, lautet der Standardwert "None", und die Attribute werden auf "Archiv" festgelegt. Hier ist ein Beispiel für den Vartyp str: 'Temporary|Archiv". file_attributes Wert wird die Groß-/Kleinschreibung nicht beachtet.

file_creation_time: str oder datetime

Erforderlich

Erstellungszeit für die Datei Standardwert: Jetzt.

file_last_write_time: str oder datetime

Erforderlich

Zeitpunkt des letzten Schreibvorgangs für die Datei Standardwert: Jetzt.

file_permission: str

Erforderlich

Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden. Dieser Header kann verwendet werden, wenn die Berechtigungsgröße = 8 KB beträgt <, andernfalls wird der x-ms-file-permission-key-Header verwendet. Standardwert: Erben. Wenn SDDL als Eingabe angegeben ist, muss sie über besitzer, group und dacl verfügen. Hinweis: Es sollte nur eine der x-ms-file-permission- oder x-ms-file-permission-key angegeben werden.

permission_key: str

Erforderlich

Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der x-ms-file-permission- oder x-ms-file-permission-key angegeben werden.

file_change_time: str oder datetime

Ändern der Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

content_settings: ContentSettings

ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Wird verwendet, um Inhaltstyp, Codierung, Sprache, Disposition, md5 und Cachesteuerung festzulegen.

metadata: dict(str,str)

Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Dateiupdate:Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

Beispiele

Erstellen Sie eine Datei.


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

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

delete_file(**kwargs: Any) -> None

Parameter

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Rückgabetyp

None

Beispiele

Löschen Sie eine Datei.


   my_file.delete_file()

download_file

Lädt eine Datei in den StorageStreamDownloader herunter. Die readall()-Methode muss verwendet werden, um den gesamten Inhalt zu lesen, oder readinto() muss verwendet werden, um die Datei in einen Stream herunterzuladen. Die Verwendung von chunks() gibt einen Iterator zurück, der es dem Benutzer ermöglicht, den Inhalt in Blöcken zu durchlaufen.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Parameter

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Herunterladen eines Abschnitts der Datei verwendet werden soll. Muss festgelegt werden, wenn die Länge angegeben wird.

length: int

Erforderlich

Anzahl der Bytes, die aus dem Stream gelesen werden sollen. Dies ist optional, sollte aber für eine optimale Leistung bereitgestellt werden.

max_concurrency: int

Maximale Anzahl der zu verwendenden parallelen Verbindungen.

validate_content: bool

Wenn true, berechnet einen MD5-Hash für jeden Blöcke der Datei. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. 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 dieser MD5-Hash nicht in der Datei gespeichert wird. Beachten Sie auch, dass der speichereffiziente Uploadalgorithmus bei Aktivierter nicht verwendet wird, da das Berechnen des MD5-Hashs das Puffern ganzer Blöcke erfordert und dies den Zweck des speichereffizienten Algorithmus verfehlt.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

progress_hook: Callable[[int, int], None]

Ein Rückruf zum Nachverfolgen des Fortschritts eines downloads mit langer Ausführungsdauer. Die Signatur ist function(current: int, total: int), wobei current die Anzahl der bisher übertragenen Bytes und gesamt die Gesamtgröße des Downloads ist.

timeout: int

Gibt zurück

Ein Streamingobjekt (StorageStreamDownloader)

Rückgabetyp

<xref:azure.storage.fileshare.StorageStreamDownloader>

Beispiele

Laden Sie eine Datei herunter.


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

Erstellen Sie ShareFileClient aus einer Verbindungszeichenfolge.

from_connection_string(conn_str: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameter

conn_str: str

Erforderlich

Ein Verbindungszeichenfolge zu einem Azure Storage-Konto.

share_name: str

Erforderlich

Der Name der Freigabe.

file_path: str

Erforderlich

Der Dateipfad.

snapshot: str

Standardwert: None

Eine optionale Datei Momentaufnahme, mit der ausgeführt werden soll. Dies kann die Momentaufnahme ID-Zeichenfolge oder die antwort sein, die von create_snapshotzurückgegeben wird.

credential

Standardwert: None

außer im Fall von AzureSasCredential, bei dem die in Konflikt stehenden SAS-Token einen ValueError auslösen. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

audience: str

Gibt zurück

Ein Dateiclient.

Rückgabetyp

ShareFileClient

Beispiele

Erstellt den Dateiclient mit Verbindungszeichenfolge.


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

Ein Client, der mit einer bestimmten Datei interagiert, obwohl diese Datei möglicherweise noch nicht vorhanden ist.

from_file_url(file_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameter

file_url: str

Erforderlich

Der vollständige URI für die Datei.

snapshot: str

Standardwert: None

Eine optionale Datei Momentaufnahme, mit der ausgeführt werden soll. Dies kann die Momentaufnahme ID-Zeichenfolge oder die antwort sein, die von create_snapshotzurückgegeben wird.

credential

Standardwert: None

außer im Fall von AzureSasCredential, bei dem die in Konflikt stehenden SAS-Token einen ValueError auslösen. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

audience: str

Gibt zurück

Ein Dateiclient.

Rückgabetyp

ShareFileClient

get_file_properties

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück.

get_file_properties(**kwargs: Any) -> FileProperties

Parameter

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Fileproperties

Rückgabetyp

FileProperties

get_ranges

Gibt die Liste der gültigen Seitenbereiche für eine Datei oder Momentaufnahme einer Datei zurück.

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

Parameter

offset: int

Erforderlich

Gibt den Startoffset von Bytes an, über die Bereiche abgerufen werden sollen.

length: int

Erforderlich

Anzahl der Bytes, die verwendet werden sollen, über die Bereiche abgerufen werden sollen.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Eine Liste gültiger Bereiche.

Rückgabetyp

List[dict[str, int]]

get_ranges_diff

Gibt die Liste der gültigen Seitenbereiche für eine Datei oder Momentaufnahme einer Datei zurück.

Neu in Version 12.6.0.

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parameter

offset: int

Erforderlich

Gibt den Startoffset von Bytes an, über die Bereiche abgerufen werden sollen.

length: int

Erforderlich

Anzahl der Bytes, die verwendet werden sollen, über die Bereiche abgerufen werden sollen.

previous_sharesnapshot: str

Erforderlich

Der parameter Momentaufnahme diff, der einen undurchsichtigen DateTime-Wert enthält, der eine vorherige Datei angibt, Momentaufnahme mit einem neueren Momentaufnahme oder der aktuellen Datei verglichen werden soll.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

timeout: int

Gibt zurück

Ein Tupel aus zwei Listen von Dateibereichen als Wörterbücher mit den Schlüsseln "start" und "end". Das erste Element sind gefüllte Dateibereiche, das 2. Element ist gelöschte Dateibereiche.

Rückgabetyp

tuple(list(dict(str, str), list(dict(str, str))

list_handles

Listet Handles für die Datei auf.

list_handles(**kwargs: Any) -> ItemPaged[Handle]

Parameter

timeout: int

Gibt zurück

Eine automatische Paging-Iterierung von Handle

Rückgabetyp

ItemPaged[Handle]

rename_file

Benennen Sie die Quelldatei um.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes oder str :Schlüsselwort (keyword) file_creation_time:

Erstellungszeit für die Datei.

:p aramtype file_creation_time:~datetime.datetime oder str :Schlüsselwort (keyword) file_last_write_time:

Zeitpunkt des letzten Schreibvorgangs für die Datei.

:p aramtype file_last_write_time:~datetime.datetime oder str :Schlüsselwort (keyword) file_change_time:

Ändern der Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

rename_file(new_name: str, **kwargs: Any) -> ShareFileClient

Parameter

content_type: str

Der Inhaltstyp der neuen Datei.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

metadata: Dict[str,str]

Ein Name-Wert-Paar, das einem Dateispeicherobjekt zugeordnet werden soll.

source_lease: ShareLeaseClient oder str

Erforderlich, wenn die Quelldatei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

destination_lease: ShareLeaseClient oder str

Erforderlich, wenn die Zieldatei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Gibt zurück

Der neue Dateiclient.

Rückgabetyp

ShareFileClient

resize_file

Ändert die Größe einer Datei in die angegebene Größe.

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

Parameter

size: int

Erforderlich

Größe, in die die Größe der Datei geändert werden soll (in Bytes)

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Dateiupdate:Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

Dict[str, Any]

set_file_metadata

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

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 Metadatendict auf.

set_file_metadata(metadata: Dict[str, Any] | None = None, **kwargs: Any) -> Dict[str, Any]

Parameter

metadata: dict(str, str)

Erforderlich

Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Dateiupdate:Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

set_http_headers

Legt HTTP-Header für die Datei fest.

set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parameter

content_settings: ContentSettings

Erforderlich

ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Wird verwendet, um Inhaltstyp, Codierung, Sprache, Disposition, md5 und Cachesteuerung festzulegen.

file_attributes: NTFSAttributes

Erforderlich

Die Dateisystemattribute für Dateien und Verzeichnisse. Wenn nicht festgelegt, gibt die Beibehaltung vorhandener Werte an. Hier ist ein Beispiel für den Vartyp str: 'Temporary|Archiv'

file_creation_time: str oder datetime

Erforderlich

Erstellungszeit für die Datei Standardwert: Beibehalten.

file_last_write_time: str oder datetime

Erforderlich

Zeitpunkt des letzten Schreibvorgangs für die Datei Standardwert: Beibehalten.

file_permission: str

Erforderlich

permission_key: str

Erforderlich

Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der x-ms-file-permission- oder x-ms-file-permission-key angegeben werden.

file_change_time: str oder datetime

Ändern der Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Gibt zurück

Dateiupdate:Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

start_copy_from_url

Initiiert das Kopieren von Daten aus einer Quell-URL in die Datei, auf die vom Client verwiesen wird.

Die status dieses Kopiervorgangs finden Sie mithilfe der get_properties-Methode.

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

Parameter

source_url: str

Erforderlich

Gibt die URL der Quelldatei an.

file_permission: str

Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden. Dieser Wert kann auf "source" festgelegt werden, um die Sicherheitsbeschreibung aus der Quelldatei zu kopieren. Andernfalls wird dieser Wert verwendet, um den Quellwert zu überschreiben. Wenn nicht festgelegt, wird der Berechtigungswert vom übergeordneten Verzeichnis der Zieldatei geerbt. Diese Einstellung kann verwendet werden, wenn die Berechtigungsgröße = 8 KB beträgt <, andernfalls wird permission_key verwendet. Wenn SDDL als Eingabe angegeben wird, muss es besitzer, gruppe und dacl haben. Hinweis: Es sollte nur eine der file_permission oder permission_key angegeben werden.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

permission_key: str

Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Dieser Wert kann auf "source" festgelegt werden, um die Sicherheitsbeschreibung aus der Quelldatei zu kopieren. Andernfalls wird dieser Wert verwendet, um den Quellwert zu überschreiben. Wenn nicht festgelegt, wird der Berechtigungswert vom übergeordneten Verzeichnis der Zieldatei geerbt. Hinweis: Es sollte nur eine der file_permission oder permission_key angegeben werden.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

file_attributes: NTFSAttributes

Dieser Wert kann auf "source" festgelegt werden, um Dateiattribute aus der Quelldatei in die Zieldatei zu kopieren, oder um alle Attribute zu löschen, kann er auf "None" festgelegt werden. Andernfalls kann er auf eine Liste von Attributen festgelegt werden, die für die Zieldatei festgelegt werden sollen. Wenn dies nicht festgelegt ist, lautet der Standardwert "Archiv".

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

file_creation_time: str oder datetime

Dieser Wert kann auf "source" festgelegt werden, um die Erstellungszeit aus der Quelldatei in die Zieldatei zu kopieren, oder auf datetime, die als Erstellungszeit für die Zieldatei festgelegt werden soll. Dies kann auch eine Zeichenfolge im ISO 8601-Format sein. Wenn dies nicht festgelegt ist, wird die Erstellungszeit auf den Datumszeitwert der Erstellung (oder beim Überschreiben) der Zieldatei durch das Kopiermodul festgelegt.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

file_last_write_time: str oder datetime

Dieser Wert kann auf "source" festgelegt werden, um die letzte Schreibzeit aus der Quelldatei in die Zieldatei zu kopieren, oder ein datetime-Wert, der als letzte Schreibzeit für die Zieldatei festgelegt werden soll. Dies kann auch eine Zeichenfolge im ISO 8601-Format sein. Wenn dies nicht festgelegt ist, ist der Wert die letzte Schreibzeit der Datei durch das Kopiermodul.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

file_change_time: str oder datetime

Ändern Sie die Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt.

Neu in Version 12.9.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

ignore_read_only: bool

Gibt die Option an, die Zieldatei zu überschreiben, wenn sie bereits vorhanden ist und schreibgeschütztes Attribut festgelegt ist.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

set_archive_attribute: bool

Gibt die Option an, das Archivattribute für die Zieldatei festzulegen. True bedeutet, dass das Archiv-Attribut trotz Attributüberschreibungen oder des Quelldateizustands für die Zieldatei festgelegt wird.

Neu in Version 12.1.0: Dieser Parameter wurde in der API-Version "2019-07-07" eingeführt.

metadata

Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

dict(str, Any)

Beispiele

Kopieren einer Datei aus einer URL


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Lädt eine neue Datei hoch.

param data: Inhalt der Datei.

param int length: Länge der Datei in Bytes. Geben Sie die maximale Größe von bis zu 1 TiB an.

param file_attributes: Die Dateisystemattribute für Dateien und Verzeichnisse. Wenn nicht festgelegt, lautet der Standardwert "None", und die Attribute werden auf "Archiv" festgelegt. Hier sehen Sie ein Beispiel für den Var-Typ str: 'Temporary|Archiv". file_attributes Wert beachtet die Groß-/Kleinschreibung nicht.

geben Sie file_attributes ein: str oder ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Erstellungszeit für die Datei Standardwert: Jetzt.

geben Sie file_creation_time ein: str oder ~datetime.datetime

param file_last_write_time: Letzte Schreibzeit für die Datei Standardwert: Jetzt.

geben Sie file_last_write_time ein: str oder ~datetime.datetime

param file_permission: Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden. Dieser Header kann verwendet werden, wenn die Berechtigungsgröße = 8 KB beträgt <, andernfalls wird der Header x-ms-file-permission-key verwendet. Standardwert: Erben. Wenn SDDL als Eingabe angegeben wird, muss es besitzer, gruppe und dacl haben. Hinweis: Es sollte nur eine der x-ms-file-permission oder x-ms-file-permission-key angegeben werden.

geben Sie file_permission ein: str

param permission_key: Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der x-ms-file-permission oder x-ms-file-permission-key angegeben werden.

typ permission_key: str

upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]

Parameter

file_change_time

Ändern Sie die Zeit für die Datei. Wenn nicht angegeben, wird die Änderungszeit auf das aktuelle Datum/die aktuelle Uhrzeit festgelegt.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

paramtype file_change_time: str oder ~datetime.datetime

Schlüsselwort (keyword) dict(str,str)-Metadaten: Name-Wert-Paare, die der Datei als Metadaten zugeordnet sind.

Schlüsselwort (keyword) ~azure.storage.fileshare.ContentSettings content_settings: ContentSettings-Objekt, das zum Festlegen von Dateieigenschaften verwendet wird. Wird zum Festlegen von Inhaltstyp, Codierung, Sprache, Disposition, md5 und Cachesteuerung verwendet.

Schlüsselwort (keyword) bool validate_content: Wenn true, berechnet ein MD5-Hash für jeden Bereich der Datei. 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.

Schlüsselwort (keyword) int max_concurrency: Maximale Anzahl der zu verwendenden parallelen Verbindungen.

Schlüsselwort (keyword) Lease: Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

paramtype lease: ~azure.storage.fileshare.ShareLeaseClient or str

Schlüsselwort (keyword) progress_hook: Ein Rückruf, um den Fortschritt eines lange ausgeführten Uploads nachzuverfolgen. Die Signatur ist function(current: int, total: Optional[int]), wobei current die Anzahl der bisher übertragenen Bytes ist, und total ist die Größe des Blobs oder None, wenn die Größe unbekannt ist.

paramtype progress_hook: Callable[[int, Optional[int]], None]

Schlüsselwort (keyword) int-Timeout: Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Schlüsselwort (keyword) str-Codierung: Standardmäßig ist UTF-8.

returns: Datei-aktualisierte Eigenschaftsdikt (Etag und zuletzt geändert).

rtype: dict(str, Any)

Beispiel:Hochladen einer Datei.


   with open(SOURCE_FILE, "rb") as source:
       my_file.upload_file(source)

upload_range

Laden Sie einen Bytesbereich in eine Datei hoch.

upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]

Parameter

data: bytes

Erforderlich

Die hochzuladenden Daten.

offset: int

Erforderlich

Start des Bytebereichs, der zum Hochladen eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Hochladen eines Abschnitts der Datei verwendet werden sollen. Der Bereich kann bis zu 4 MB groß sein.

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.

file_last_write_mode: Literal["preserve", "now"]

Wenn die Letzte Schreibzeit der Datei beibehalten oder überschrieben werden soll. Mögliche Werte sind "beibehalten" oder "jetzt". Wenn dies nicht angegeben ist, wird die Letzte Schreibzeit der Datei in das aktuelle Datum/die aktuelle Uhrzeit geändert.

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

encoding: str

Standardmäßig wird UTF-8 verwendet.

Gibt zurück

Datei-aktualisierte Eigenschaftsdikt (Etag und zuletzt geändert).

Rückgabetyp

Dict[str, Any]

upload_range_from_url

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

upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]

Parameter

offset: int

Erforderlich

Start des Bytebereichs, der zum Aktualisieren eines Abschnitts der Datei verwendet werden soll. Der Bereich kann bis zu 4 MB groß sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Aktualisieren eines Abschnitts der Datei verwendet werden sollen. Der Bereich kann bis zu 4 MB groß sein.

source_url: str

Erforderlich

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/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset: int

Erforderlich

Dies gibt den Beginn des Bytesbereichs (einschließlich) an, der aus der Kopierquelle entnommen werden muss. Der Dienst liest die gleiche Anzahl von Bytes wie der Zielbereich (Längenoffset).

source_if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen bedingten Header an, um das BLOB nur dann zu kopieren, wenn das Quell-BLOB seit dem angegebenen Datum bzw. der angegebenen Uhrzeit geändert wurde.

source_if_unmodified_since: datetime

source_etag: str

Der ETag-Quellwert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

source_match_condition: MatchConditions

Die quellgleiche Bedingung, die für das etag verwendet werden soll.

file_last_write_mode: Literal["preserve", "now"]

Neu in Version 12.8.0: Dieser Parameter wurde in der API-Version "2021-06-08" eingeführt.

lease: ShareLeaseClient oder str

Erforderlich, wenn die Datei über eine aktive Lease verfügt. Der Wert kann ein ShareLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

Neu in Version 12.1.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

source_authorization: str

Authentifizieren Sie sich als Dienstprinzipal mithilfe eines geheimen Clientschlüssels für den Zugriff auf ein Quellblob. Stellen Sie sicher, dass "Bearer" das Präfix der source_authorization Zeichenfolge ist.

Attribute

api_version

Die Version der Speicher-API, die für Anforderungen verwendet wird.

location_mode

Der Standortmodus, den der Client derzeit verwendet.

Standardmäßig ist dies "primär". Zu den Optionen gehören "primär" und "sekundär".

primary_endpoint

Die vollständige URL des primären Endpunkts.

primary_hostname

Der Hostname des primären Endpunkts.

secondary_endpoint

Die vollständige url des sekundären Endpunkts, falls konfiguriert.

Wenn nicht verfügbar, wird ein ValueError ausgelöst. Wenn Sie einen sekundären Hostnamen explizit angeben möchten, verwenden Sie das optionale secondary_hostname Schlüsselwort (keyword) Argument für die Instanziierung.

Ausnahmen

ValueError

secondary_hostname

Der Hostname des sekundären Endpunkts.

Wenn nicht verfügbar, lautet dies Keine. Wenn Sie einen sekundären Hostnamen explizit angeben möchten, verwenden Sie das optionale secondary_hostname Schlüsselwort (keyword) Argument für die Instanziierung.

url

Die vollständige Endpunkt-URL für diese Entität, einschließlich des SAS-Tokens, falls verwendet.

Dies kann abhängig vom aktuellen location_modeentweder der primäre Endpunkt oder der sekundäre Endpunkt sein. :returns: Die vollständige Endpunkt-URL für diese Entität, einschließlich des SAS-Tokens, falls verwendet. :rtype: str

Freigeben über

ShareFileClient Klasse

Konstruktor

Parameter

Methoden

abort_copy

Parameter

Rückgabetyp

acquire_lease

Parameter

Gibt zurück

Rückgabetyp

Beispiele

clear_range

Parameter

Gibt zurück

Rückgabetyp

close

close_all_handles

Parameter

Gibt zurück

Rückgabetyp

close_handle

Parameter

Gibt zurück

Rückgabetyp

create_file

Parameter

Gibt zurück

Rückgabetyp

Beispiele

delete_file

Parameter

Rückgabetyp

Beispiele

download_file

Parameter

Gibt zurück

Rückgabetyp

Beispiele

from_connection_string

Parameter

Gibt zurück

Rückgabetyp

Beispiele

from_file_url

Parameter

Gibt zurück

Rückgabetyp

get_file_properties

Parameter

Gibt zurück

Rückgabetyp

get_ranges

Parameter

Gibt zurück

Rückgabetyp

get_ranges_diff

Parameter

Gibt zurück

Rückgabetyp

list_handles

Parameter

Gibt zurück

Rückgabetyp

rename_file

Parameter

Gibt zurück

Rückgabetyp

resize_file

Parameter

Gibt zurück

Rückgabetyp

set_file_metadata

Parameter

Gibt zurück

Rückgabetyp

set_http_headers

Parameter

Gibt zurück