ShareClient Klasse

Referenz

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

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

Weitere optionale Konfigurationen finden Sie hier.

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

ShareClient

Konstruktor

ShareClient(account_url: str, share_name: 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 Freigabe zu erstellen, verwenden Sie die from_share_url -Klassenmethode.

share_name: str

Erforderlich

Der Name der Freigabe, mit der interagiert werden soll.

snapshot: str

Standardwert: None

Eine optionale Freigabe Momentaufnahme, mit der betrieben 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.

Methoden

acquire_lease	Fordert eine neue Lease an. Wenn die Freigabe nicht über eine aktive Lease verfügt, erstellt der Freigabedienst eine Lease für die Freigabe und gibt eine neue Lease zurück. Neu in Version 12.5.0.
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.
create_directory	Erstellt ein Verzeichnis in der Freigabe und gibt einen Client für die Interaktion mit dem Verzeichnis zurück.
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 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.
create_share	Erstellt eine neue Freigabe unter dem Konto. Wenn bereits eine Freigabe mit demselben Namen vorhanden ist, schlägt der Vorgang fehl.
create_snapshot	Erstellt eine Momentaufnahme der Freigabe. Ein Momentaufnahme ist eine schreibgeschützte Version einer Freigabe, die zu einem bestimmten Zeitpunkt erstellt wird. Sie kann gelesen, kopiert oder gelöscht werden, aber nicht geändert werden. Momentaufnahmen bieten eine Möglichkeit, eine Freigabe so zu sichern, wie sie zu einem bestimmten Zeitpunkt angezeigt wird. Ein Momentaufnahme einer Freigabe hat den gleichen Namen wie die Basisfreigabe, von der die Momentaufnahme genommen wird, wobei ein DateTime-Wert angefügt ist, der den Zeitpunkt angibt, zu dem die Momentaufnahme genommen wurde.
delete_directory	Markiert das Verzeichnis zum Löschen. Das Verzeichnis wird später während der Garbage Collection gelöscht.
delete_share	Markiert die angegebene Freigabe zum Löschen. Die Freigabe wird später während der Garbage Collection gelöscht.
from_connection_string	Erstellen Sie ShareClient aus einer Verbindungszeichenfolge.
from_share_url
get_directory_client	Rufen Sie einen Client für die Interaktion mit dem angegebenen Verzeichnis ab. Das Verzeichnis muss noch nicht vorhanden sein.
get_file_client	Rufen Sie einen Client für die Interaktion mit der angegebenen Datei ab. Die Datei muss noch nicht vorhanden sein.
get_permission_for_share	Rufen Sie eine Berechtigung (eine Sicherheitsbeschreibung) für einen bestimmten Schlüssel ab. Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden.
get_share_access_policy	Ruft die Berechtigungen für die Freigabe ab. Die Berechtigungen geben an, ob auf Dateien in einer Freigabe öffentlich zugegriffen werden kann.
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 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	Listet die Verzeichnisse und Dateien unter der Freigabe auf.
set_share_access_policy	Legt die Berechtigungen für die Freigabe oder gespeicherte Zugriffsrichtlinien fest, die mit Shared Access Signatures verwendet werden können. Die Berechtigungen geben an, ob auf Dateien in einer Freigabe öffentlich zugegriffen werden kann.
set_share_metadata	Legt die Metadaten für die 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 die Freigabeeigenschaften fest. Neu in Version 12.4.0.
set_share_quota	Legt das Kontingent für die Freigabe fest.

acquire_lease

Fordert eine neue Lease an.

Wenn die Freigabe nicht über eine aktive Lease verfügt, erstellt der Freigabedienst eine Lease für die Freigabe und gibt eine neue Lease zurück.

Neu in Version 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parameter

lease_duration: int

Gibt die Dauer der Lease in Sekunden oder als minus eins (-1) für eine nie ablaufende Lease an. Die Dauer einer nicht unendlichen Lease kann zwischen 15 und 60 Sekunden liegen. Eine Leasedauer kann nicht mithilfe von Verlängerung oder Änderung geändert werden. Der Standardwert ist -1 (unbegrenzte Lease).

lease_id: str

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

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.

Gibt zurück

Ein ShareLeaseClient-Objekt.

Rückgabetyp

ShareLeaseClient

Beispiele

Erwerb eines Leasingverhältnisses für eine Aktie.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

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()

create_directory

Erstellt ein Verzeichnis in der Freigabe und gibt einen Client für die Interaktion mit dem Verzeichnis zurück.

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

Parameter

directory_name: str

Erforderlich

Der Name des Verzeichnisses.

metadata

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

timeout: int

Gibt zurück

ShareDirectoryClient

Rückgabetyp

ShareDirectoryClient

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.

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

Parameter

file_permission: str

Erforderlich

Dateiberechtigung, eine portable SDDL

timeout: int

Gibt zurück

Ein Dateiberechtigungsschlüssel

Rückgabetyp

str

Erstellt eine neue Freigabe unter dem Konto. Wenn bereits eine Freigabe mit demselben Namen vorhanden ist, schlägt der Vorgang fehl.

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

Parameter

metadata: dict(str,str)

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

quota: int

Das zuzuweisende Kontingent.

access_tier

Gibt die Zugriffsebene der Freigabe an. Mögliche Werte: "TransactionOptimized", "Hot", "Cool"

timeout: int

protocols: str oder ShareProtocols

Protokolle, die für die Freigabe aktiviert werden sollen. Für die Freigabe kann nur ein Protokoll aktiviert werden.

root_squash: str oder ShareRootSquash

Stamm squashen, die für die Freigabe festgelegt werden soll. Nur gültig für NFS-Freigaben. Mögliche Werte sind: "NoRootSquash", "RootSquash", "AllSquash".

Gibt zurück

Freigabeupdate-Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

Dict[str, Any]

Beispiele

Erstellt eine Dateifreigabe.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

Erstellt eine Momentaufnahme der Freigabe.

Ein Momentaufnahme ist eine schreibgeschützte Version einer Freigabe, die zu einem bestimmten Zeitpunkt erstellt wird. Sie kann gelesen, kopiert oder gelöscht werden, aber nicht geändert werden. Momentaufnahmen bieten eine Möglichkeit, eine Freigabe so zu sichern, wie sie zu einem bestimmten Zeitpunkt angezeigt wird.

Ein Momentaufnahme einer Freigabe hat den gleichen Namen wie die Basisfreigabe, von der die Momentaufnahme genommen wird, wobei ein DateTime-Wert angefügt ist, der den Zeitpunkt angibt, zu dem die Momentaufnahme genommen wurde.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

Parameter

metadata: dict(str,str)

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

timeout: int

Gibt zurück

Freigabeupdate-Eigenschaftsdict (Momentaufnahme-ID, Etag und letzte Änderung).

Rückgabetyp

dict[str, Any]

Beispiele

Erstellt eine Momentaufnahme der Dateifreigabe.


   share.create_snapshot()

delete_directory

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

delete_directory(directory_name: str, **kwargs: Any) -> None

Parameter

directory_name: str

Erforderlich

Der Name des Verzeichnisses.

timeout: int

Rückgabetyp

None

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

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

Parameter

delete_snapshots: bool

Erforderlich

Gibt an, ob Momentaufnahmen gelöscht werden sollen.

lease

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

Neu in Version 12.5.0.

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

timeout: int

Beispiele

Löscht die Freigabe und alle Momentaufnahmen.


   share.delete_share(delete_snapshots=True)

from_connection_string

Erstellen Sie ShareClient aus einer Verbindungszeichenfolge.

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

Eine Verbindungszeichenfolge für ein Azure Storage-Konto.

share_name: str

Erforderlich

Der Name der Freigabe.

snapshot: str

Standardwert: None

Die optionale Freigabe Momentaufnahme, mit der betrieben 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.

Gibt zurück

Ein Freigabeclient.

Rückgabetyp

ShareClient

Beispiele

Ruft den Freigabeclient aus der Verbindungszeichenfolge ab.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

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

Parameter

share_url: str

Erforderlich

Der vollständige URI für die Freigabe.

snapshot: str

Standardwert: None

Eine optionale Freigabe Momentaufnahme, mit der betrieben 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.

Gibt zurück

Ein Freigabeclient.

Rückgabetyp

ShareClient

get_directory_client

Rufen Sie einen Client für die Interaktion mit dem angegebenen Verzeichnis ab. Das Verzeichnis muss noch nicht vorhanden sein.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

Parameter

directory_path: str

Standardwert: None

Pfad zum angegebenen Verzeichnis.

Gibt zurück

Ein Verzeichnisclient.

Rückgabetyp

ShareDirectoryClient

get_file_client

Rufen Sie einen Client für die Interaktion mit der angegebenen Datei ab. Die Datei muss noch nicht vorhanden sein.

get_file_client(file_path: str) -> ShareFileClient

Parameter

file_path: str

Erforderlich

Pfad zur angegebenen Datei.

Gibt zurück

Ein Dateiclient.

Rückgabetyp

ShareFileClient

Rufen Sie eine Berechtigung (eine Sicherheitsbeschreibung) für einen bestimmten Schlüssel ab.

Diese "Berechtigung" kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

Parameter

permission_key: str

Erforderlich

Schlüssel der abzurufenden Dateiberechtigung

timeout: int

Gibt zurück

Eine Dateiberechtigung (eine portable SDDL)

Rückgabetyp

str

Ruft die Berechtigungen für die Freigabe ab. Die Berechtigungen geben an, ob auf Dateien in einer Freigabe öffentlich zugegriffen werden kann.

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

Parameter

timeout: int

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Zugreifen auf Richtlinieninformationen in einem Diktat.

Rückgabetyp

dict[str, Any]

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

Parameter

timeout: int

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Die Freigabeeigenschaften.

Rückgabetyp

ShareProperties

Beispiele

Ruft die Freigabeeigenschaften ab.


   properties = share.get_share_properties()

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

Parameter

timeout: int

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Die ungefähre Größe der in der Freigabe gespeicherten Daten (in Bytes).

Rückgabetyp

int

list_directories_and_files

Listet die Verzeichnisse und Dateien unter der Freigabe auf.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

Parameter

directory_name: str

Erforderlich

Name eines Verzeichnisses.

name_starts_with: str

Erforderlich

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

marker: str

Erforderlich

Ein undurchsichtiges Fortsetzungstoken. Dieser Wert kann aus dem next_marker Feld eines vorherigen Generatorobjekts abgerufen werden. Wenn angegeben, beginnt dieser Generator mit der Rückgabe von Ergebnissen ab diesem Punkt.

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

Iterable[Dict[str,str]]

Beispiele

Listet Verzeichnisse und Dateien in der Freigabe auf.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

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

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

Legt die Berechtigungen für die Freigabe oder gespeicherte Zugriffsrichtlinien fest, die mit Shared Access Signatures verwendet werden können. Die Berechtigungen geben an, ob auf Dateien in einer Freigabe öffentlich zugegriffen werden kann.

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

Parameter

signed_identifiers: dict(str, AccessPolicy)

Erforderlich

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.

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.

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Share-updated property dict (Etag und zuletzt geändert).

Rückgabetyp

dict(str, Any)

Legt die Metadaten für die 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(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

metadata: dict(str, str)

Erforderlich

Name-Wert-Paare, die der Freigabe 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.

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Share-updated property dict (Etag und zuletzt geändert).

Rückgabetyp

dict(str, Any)

Beispiele

Legt die Freigabemetadaten fest.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

Legt die Freigabeeigenschaften fest.

Neu in Version 12.4.0.

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

Parameter

access_tier: str oder <xref:azure.storage.fileshare.models.ShareAccessTier>

Gibt die Zugriffsebene der Freigabe an. Mögliche Werte: "TransactionOptimized", "Hot" und "Cool"

quota: int

Gibt die maximale Größe der Freigabe in Gigabyte an. Muss größer als 0 und kleiner als oder gleich 5 TB sein.

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.

root_squash: str oder ShareRootSquash

Stamm squashen, die für die Freigabe festgelegt werden sollen. Nur gültig für NFS-Freigaben. Mögliche Werte sind: "NoRootSquash", "RootSquash", "AllSquash".

lease

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

Gibt zurück

Share-updated property dict (Etag und zuletzt geändert).

Rückgabetyp

dict(str, Any)

Beispiele

Legt die Freigabeeigenschaften fest.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

Legt das Kontingent für die Freigabe fest.

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

Parameter

quota: int

Erforderlich

Gibt die maximale Größe der Freigabe in Gigabyte an. Muss größer als 0 und kleiner als oder gleich 5 TB sein.

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.

lease

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

Neu in Version 12.5.0.

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

Gibt zurück

Share-updated property dict (Etag und zuletzt geändert).

Rückgabetyp

dict(str, Any)

Beispiele

Legt das Freigabekontingent fest.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

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

Share via

ShareClient Klasse

Konstruktor

Parameter

Methoden

acquire_lease

Parameter

Gibt zurück

Rückgabetyp

Beispiele

close

create_directory

Parameter

Gibt zurück

Rückgabetyp

create_permission_for_share

Parameter

Gibt zurück

Rückgabetyp

create_share

Parameter

Gibt zurück

Rückgabetyp

Beispiele

create_snapshot

Parameter

Gibt zurück

Rückgabetyp

Beispiele

delete_directory

Parameter

Rückgabetyp

delete_share

Parameter

Beispiele

from_connection_string

Parameter

Gibt zurück

Rückgabetyp

Beispiele

from_share_url

Parameter

Gibt zurück

Rückgabetyp

get_directory_client

Parameter

Gibt zurück

Rückgabetyp

get_file_client

Parameter

Gibt zurück

Rückgabetyp

get_permission_for_share

Parameter

Gibt zurück

Rückgabetyp

get_share_access_policy

Parameter

Gibt zurück

Rückgabetyp

get_share_properties

Parameter

Gibt zurück

Rückgabetyp

Beispiele

get_share_stats

Parameter

Gibt zurück

Rückgabetyp

list_directories_and_files

Parameter

Gibt zurück

Rückgabetyp

Beispiele

set_share_access_policy

Parameter

Gibt zurück

Rückgabetyp

set_share_metadata

Parameter