Freigeben über

ShareDirectoryClient Klasse

  • Referenz

Ein Client für die Interaktion mit einem bestimmten Verzeichnis, obwohl er möglicherweise noch nicht vorhanden ist.

Bei Vorgängen, die sich auf ein bestimmtes Unterverzeichnis oder eine bestimmte Datei in dieser Freigabe beziehen, können die Clients für diese Entitäten auch mithilfe der get_subdirectory_client Funktionen und get_file_client abgerufen werden.

Weitere optionale Konfigurationen finden Sie hier.

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

Konstruktor

ShareDirectoryClient(account_url: str, share_name: str, directory_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. Verwenden Sie from_directory_url die Classmethod, um einen Client mit dem vollständigen URI für das Verzeichnis zu erstellen.

share_name
str
Erforderlich

Der Name der Freigabe für das Verzeichnis.

directory_path
str
Erforderlich

Der Verzeichnispfad für das Verzeichnis, mit dem interagiert werden soll. Wenn angegeben, überschreibt dieser Wert einen Verzeichniswert, der in der Verzeichnis-URL angegeben ist.

snapshot
str
Standardwert: None

Eine optionale Freigabe Momentaufnahme, für die der Betrieb ausgeführt werden soll. Dies kann die Momentaufnahme-ID-Zeichenfolge oder die von create_snapshotzurückgegebene Antwort sein.

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, ein instance einer AzureSasCredential- oder AzureNamedKeyCredential-Instanz von azure.core.credentials, ein freigegebener Zugriffsschlüssel für ein Konto oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Wenn der Ressourcen-URI bereits ein SAS-Token enthält, wird dies zugunsten expliziter Anmeldeinformationen 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:

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

allow_trailing_dot
bool

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

allow_source_trailing_dot
bool

Wenn true, wird der nachfolgende 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 geringeren 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. 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

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_directory

Erstellt ein neues Verzeichnis unter dem Verzeichnis, auf das vom Client verwiesen wird.
create_subdirectory

Erstellt ein neues Unterverzeichnis und gibt einen Client für die Interaktion mit dem Unterverzeichnis zurück.
delete_directory

Markiert das Verzeichnis zum Löschen. Das Verzeichnis wird später während der Garbage Collection gelöscht.
delete_file

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

Löscht ein Unterverzeichnis.
exists

Gibt True zurück, wenn ein Verzeichnis vorhanden ist, und gibt andernfalls False zurück.
from_connection_string

Erstellen Sie ShareDirectoryClient aus einer Verbindungszeichenfolge.
from_directory_url

Erstellen Sie einen ShareDirectoryClient aus einer Verzeichnis-URL.
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_client

Rufen Sie einen Client für die Interaktion mit einer bestimmten Datei ab.

Die Datei muss noch nicht vorhanden sein.
get_subdirectory_client

Rufen Sie einen Client ab, um mit einem bestimmten Unterverzeichnis zu interagieren.

Das Unterverzeichnis muss noch nicht vorhanden sein.
list_directories_and_files

Listet alle Verzeichnisse und Dateien unter dem Verzeichnis auf.
list_handles

Listen geöffnete Handles in einem Verzeichnis oder einer Datei unter dem Verzeichnis.
rename_directory

Benennen Sie das Quellverzeichnis um.

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

Erstellungszeit für das Verzeichnis.

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

Letzte Schreibzeit für die Datei.

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

Ändern Sie die Zeit für das Verzeichnis. 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.
set_directory_metadata

Legt die Metadaten für das 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 mit einem leeren Metadatendikt auf.
set_http_headers

Legt HTTP-Header für das Verzeichnis fest.
upload_file

Erstellt eine neue Datei im Verzeichnis und gibt einen ShareFileClient zurück, um mit der Datei zu interagieren.

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(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Parameter

recursive
bool
Erforderlich

Boolesch, der angibt, ob der Vorgang auf das vom Client angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und ihre Dateien angewendet werden soll. Der Standardwert ist FALSE.

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.

Gibt zurück

Die Anzahl geschlossener Handles (dies kann 0 sein, wenn der angegebene Handle nicht gefunden wurde) und die Anzahl der Handles konnte in einem Dict nicht geschlossen werden.

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

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.

Gibt zurück

Die Anzahl geschlossener Handles (dies kann 0 sein, wenn der angegebene Handle nicht gefunden wurde) und die Anzahl der Handles konnte in einem Dict nicht geschlossen werden.

Rückgabetyp

dict[str, int]

create_directory

Erstellt ein neues Verzeichnis unter dem Verzeichnis, auf das vom Client verwiesen wird.

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

Parameter

file_attributes
NTFSAttributes

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.

file_creation_time
str oder datetime

Erstellungszeit für das Verzeichnis. Standardwert: "now".

file_last_write_time
str oder datetime

Letzte Schreibzeit für das Verzeichnis. Standardwert: "now".

file_permission
str

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 ist <, andernfalls wird der Header 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 Dateiberechtigungen oder file-permission-key angegeben werden.

file_permission_key
str

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

file_change_time
str oder datetime

Ändern Sie die Zeit für das Verzeichnis. 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.

metadata
dict(str,str)

Name-Wert-Paare, die dem Verzeichnis als Metadaten zugeordnet sind.

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.

Gibt zurück

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

Rückgabetyp

dict(str, Any)

Beispiele

Erstellt ein Verzeichnis.


   my_directory.create_directory()

create_subdirectory

Erstellt ein neues Unterverzeichnis und gibt einen Client für die Interaktion mit dem Unterverzeichnis zurück.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Parameter

directory_name
str
Erforderlich

Der Name des Unterverzeichnisses.

metadata
dict(str,str)

Name-Wert-Paare, die dem Unterverzeichnis als Metadaten zugeordnet sind.

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.

Gibt zurück

ShareDirectoryClient

Rückgabetyp

ShareDirectoryClient

Beispiele

Erstellen Sie ein Unterverzeichnis.


   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

Markiert das Verzeichnis zum Löschen. Das Verzeichnis wird später während der Garbage Collection gelöscht.

delete_directory(**kwargs: Any) -> None

Parameter

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

None

Beispiele

Löscht ein Verzeichnis.


   my_directory.delete_directory()

delete_file

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

delete_file(file_name: str, **kwargs: Any | None) -> None

Parameter

file_name
str
Erforderlich

Der Name der zu löschenden Datei.

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

None

Beispiele

Löschen Sie eine Datei in einem Verzeichnis.


   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Löscht ein Unterverzeichnis.

delete_subdirectory(directory_name: str, **kwargs) -> None

Parameter

directory_name
str
Erforderlich

Der Name des Unterverzeichnisses.

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

None

Beispiele

Löschen Sie ein Unterverzeichnis.


   parent_dir.delete_subdirectory("subdir")

exists

Gibt True zurück, wenn ein Verzeichnis vorhanden ist, und gibt andernfalls False zurück.

exists(**kwargs: Any) -> bool

Parameter

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.

Gibt zurück

True, wenn das Verzeichnis vorhanden ist, andernfalls False.

Rückgabetyp

bool

from_connection_string

Erstellen Sie ShareDirectoryClient aus einer Verbindungszeichenfolge.

from_connection_string(conn_str: str, share_name: str, directory_path: str, 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.

directory_path
str
Erforderlich

Der Verzeichnispfad.

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, ein instance einer AzureSasCredential- oder AzureNamedKeyCredential-Instanz von azure.core.credentials, ein freigegebener Zugriffsschlüssel für ein Konto oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Wenn der Ressourcen-URI bereits ein SAS-Token enthält, wird dies zugunsten expliziter Anmeldeinformationen 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.
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/ .

Gibt zurück

Ein Verzeichnisclient.

Rückgabetyp

ShareDirectoryClient

from_directory_url

Erstellen Sie einen ShareDirectoryClient aus einer Verzeichnis-URL.

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

Parameter

directory_url
str
Erforderlich

Der vollständige URI für das Verzeichnis.

snapshot
str
Standardwert: None

Eine optionale Freigabe Momentaufnahme, für die der Betrieb ausgeführt werden soll. Dies kann die Momentaufnahme-ID-Zeichenfolge oder die von create_snapshotzurückgegebene Antwort sein.

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, ein instance einer AzureSasCredential- oder AzureNamedKeyCredential-Instanz von azure.core.credentials, ein freigegebener Zugriffsschlüssel für ein Konto oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Wenn der Ressourcen-URI bereits ein SAS-Token enthält, wird dies zugunsten expliziter Anmeldeinformationen 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.
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/ .

Gibt zurück

Ein Verzeichnisclient.

Rückgabetyp

ShareDirectoryClient

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(**kwargs: Any) -> DirectoryProperties

Parameter

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.

Gibt zurück

DirectoryProperties

Rückgabetyp

DirectoryProperties

get_file_client

Rufen Sie einen Client für die Interaktion mit einer bestimmten Datei ab.

Die Datei muss noch nicht vorhanden sein.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Parameter

file_name
str
Erforderlich

Der Name der Datei.

Gibt zurück

Ein Dateiclient.

Rückgabetyp

ShareFileClient

get_subdirectory_client

Rufen Sie einen Client ab, um mit einem bestimmten Unterverzeichnis zu interagieren.

Das Unterverzeichnis muss noch nicht vorhanden sein.

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parameter

directory_name
str
Erforderlich

Der Name des Unterverzeichnisses.

Gibt zurück

Ein Verzeichnisclient.

Rückgabetyp

ShareDirectoryClient

Beispiele

Ruft den Unterverzeichnisclient ab.


   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Listet alle Verzeichnisse und Dateien unter dem Verzeichnis auf.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Parameter

name_starts_with
str
Erforderlich

Filtert die Ergebnisse so, dass nur Entitäten zurückgegeben werden, deren Namen mit dem angegebenen Präfix beginnen.

include
list[str]

Schließen Sie diesen Parameter ein, um mindestens ein Dataset anzugeben, das in die Antwort eingeschlossen werden soll. Mögliche Str-Werte sind "Timestamps", "Etag", "Attributes", "PermissionKey".

Neu in Version 12.6.0.

Dieses Schlüsselwort (keyword) Argument wurde in der API-Version "2020-10-02" eingeführt.

include_extended_info
bool

Wenn dies auf true festgelegt ist, wird die Datei-ID in den aufgeführten Ergebnissen zurückgegeben.

Neu in Version 12.6.0.

Dieses Schlüsselwort (keyword) Argument wurde in der API-Version "2020-10-02" eingeführt.

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.

Gibt zurück

Eine automatische Auslagerung von Diktat-ähnlichen DirectoryProperties und FileProperties

Rückgabetyp

ItemPaged[DirectoryProperties <xref:and> FileProperties]

Beispiele

Listet Verzeichnisse und Dateien auf.


   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Listen geöffnete Handles in einem Verzeichnis oder einer Datei unter dem Verzeichnis.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Parameter

recursive
bool
Erforderlich

Boolesch, der angibt, ob der Vorgang auf das vom Client angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und ihre Dateien angewendet werden soll. Der Standardwert ist FALSE.

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.

Gibt zurück

Automatisches Paging von Handle

Rückgabetyp

ItemPaged[Handle]

rename_directory

Benennen Sie das Quellverzeichnis um.

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

Erstellungszeit für das Verzeichnis.

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

Letzte Schreibzeit für die Datei.

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

Ändern Sie die Zeit für das Verzeichnis. 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_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Parameter

metadata
Dict[str,str]

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

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 Verzeichnisclient.

Rückgabetyp

ShareDirectoryClient

set_directory_metadata

Legt die Metadaten für das 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 mit einem leeren Metadatendikt auf.

set_directory_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

metadata
dict(str, str)
Erforderlich

Name-Wert-Paare, die dem Verzeichnis als Metadaten zugeordnet sind.

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.

Gibt zurück

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

Rückgabetyp

dict(str, Any)

set_http_headers

Legt HTTP-Header für das Verzeichnis fest.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', 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

file_attributes
NTFSAttributes
Erforderlich

Die Dateisystemattribute für Dateien und Verzeichnisse. Wenn nicht festgelegt, gibt die Beibehaltung vorhandener Werte an. Hier sehen Sie ein Beispiel für den Var-Typ 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

Letzte Schreibzeit für die Datei Standardwert: Beibehalten.

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

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 Sie die Zeit für das Verzeichnis. 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.

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.

Gibt zurück

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

Rückgabetyp

dict(str, Any)

upload_file

Erstellt eine neue Datei im Verzeichnis und gibt einen ShareFileClient zurück, um mit der Datei zu interagieren.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Parameter

file_name
str
Erforderlich

Der Name der Datei.

data
Erforderlich

Inhalt der Datei.

length
int
Erforderlich

Die Länge der Datei in Byte. Geben Sie die maximale Größe von bis zu 1 TiB an.

metadata
dict(str,str)

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

content_settings
ContentSettings

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

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.

max_concurrency
int

Maximale Anzahl der zu verwendenden parallelen Verbindungen.

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

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.

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

ShareFileClient

Rückgabetyp

ShareFileClient

Beispiele

Laden Sie eine Datei in ein Verzeichnis hoch.


   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

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 sekundäre Endpunkt-URL, falls konfiguriert.

Wenn kein Wertfehler verfügbar ist, wird ein ValueError ausgelöst. Um einen sekundären Hostnamen explizit anzugeben, verwenden Sie das optionale secondary_hostname Schlüsselwort (keyword) Argument für die Instanziierung.

Ausnahmen

ValueError

secondary_hostname

Der Hostname des sekundären Endpunkts.

Falls nicht verfügbar, ist dies Keine. Um einen sekundären Hostnamen explizit anzugeben, 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 SAS-Token, falls verwendet.

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