filedatalake Paket

Pakete

aio

Klassen

AccessControlChangeCounters	AccessControlChangeCounters enthält die Anzahl von Vorgängen, die Access Control Listen rekursiv ändern.
AccessControlChangeFailure	Stellt einen Eintrag dar, bei dem Access Control Liste nicht aktualisiert werden konnte.
AccessControlChangeResult	AccessControlChangeResult enthält Das Ergebnis von Vorgängen, die Access Control Listen rekursiv ändern.
AccessControlChanges	AccessControlChanges enthält Batch- und kumulative Anzahl von Vorgängen, die Access Control Listen rekursiv ändern. Darüber hinaus werden Pfadeinträge verfügbar gemacht, die während des Fortschritts dieser Vorgänge nicht aktualisiert werden konnten.
AccessPolicy	Zugriffsrichtlinienklasse, die von den Methoden der Gruppe verwendet wird, und Abrufen von Zugriffsrichtlinienmethoden in jedem Dienst. Eine gespeicherte Zugriffsrichtlinie kann die Startzeit, die Ablaufzeit und die Berechtigungen für die SAS angeben, denen sie zugeordnet ist. Je nachdem, wie Sie den Zugriff auf Ihre Ressource steuern möchten, können Sie alle diese Parameter in der gespeicherten Zugriffsrichtlinie angeben und sie aus der URL für die Shared Access Signature weglassen. Auf diese Weise können Sie das Verhalten der zugeordneten Signatur jederzeit ändern sowie aufheben. Oder Sie können einen oder mehrere der Zugriffsrichtlinienparameter in der gespeicherten Zugriffsrichtlinie und die anderen Zugriffsrichtlinienparameter in der URL angeben. Schließlich können Sie alle Parameter in der URL angeben. In diesem Fall können Sie die gespeicherte Zugriffsrichtlinie verwenden, um die Signatur aufzuheben, aber nicht um ihr Verhalten zu ändern. Die SAS und die gespeicherte Zugriffsrichtlinie müssen zusammen alle Felder enthalten, die zum Authentifizieren der Signatur erforderlich sind. Wenn eines der Pflichtfelder fehlt, schlägt die Anforderung fehl. Wenn ein Feld sowohl in der SAS-URL als auch in der gespeicherten Zugriffsrichtlinie angegeben ist, schlägt die Anforderung mit dem Statuscode 400 (Ungültige Anforderung) fehl.
AccountSasPermissions
AnalyticsLogging	Azure Analytics-Protokollierungseinstellungen.
ArrowDialect	Feld eines Pfeilschemas. Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.
ContentSettings	Die Inhaltseinstellungen einer Datei oder eines Verzeichnisses.
CorsRule	CORS ist eine HTTP-Funktion, die einer Webanwendung in einer Domäne den Zugriff auf Ressourcen in einer anderen Domäne ermöglicht. Webbrowser implementieren eine als same-origin-Richtlinie bekannte Sicherheitseinschränkung, die verhindert, dass eine Website APIs in einer anderen Domäne aufruft. CORS ist eine sichere Methode, um einer Domäne (der Ursprungsdomäne) den Aufruf von APIs in einer anderen Domäne zu ermöglichen.
CustomerProvidedEncryptionKey	Alle Daten in Azure Storage werden im Ruhezustand mit einem Verschlüsselungsschlüssel auf Kontoebene verschlüsselt. In Versionen 2021-06-08 und höher können Sie den Schlüssel verwalten, der zum Verschlüsseln von Dateiinhalten und Anwendungsmetadaten pro Datei verwendet wird, indem Sie einen AES-256-Verschlüsselungsschlüssel in Anforderungen an den Speicherdienst bereitstellen. Wenn Sie einen vom Kunden bereitgestellten Schlüssel verwenden, verwaltet Oder speichert Azure Storage Ihren Schlüssel nicht. Beim Schreiben von Daten in eine Datei wird der bereitgestellte Schlüssel verwendet, um Ihre Daten vor dem Schreiben auf den Datenträger zu verschlüsseln. Ein SHA-256-Hash des Verschlüsselungsschlüssels wird neben dem Dateiinhalt geschrieben und verwendet, um zu überprüfen, ob alle nachfolgenden Vorgänge für die Datei denselben Verschlüsselungsschlüssel verwenden. Dieser Hash kann nicht verwendet werden, um den Verschlüsselungsschlüssel abzurufen oder den Inhalt der Datei zu entschlüsseln. Beim Lesen einer Datei wird der bereitgestellte Schlüssel verwendet, um Ihre Daten nach dem Lesen vom Datenträger zu entschlüsseln. In beiden Fällen wird der bereitgestellte Verschlüsselungsschlüssel sicher verworfen, sobald der Verschlüsselungs- oder Entschlüsselungsprozess abgeschlossen ist.
DataLakeDirectoryClient	Ein Client für die Interaktion mit dem DataLake-Verzeichnis, auch wenn das Verzeichnis möglicherweise noch nicht vorhanden ist. Bei Vorgängen, die sich auf ein bestimmtes Unterverzeichnis oder eine bestimmte Datei unter dem Verzeichnis beziehen, kann ein Verzeichnisclient oder Dateiclient mithilfe der get_sub_directory_client -Funktionen oder get_file_client abgerufen werden.
DataLakeFileClient	Ein Client für die Interaktion mit der DataLake-Datei, auch wenn die Datei möglicherweise noch nicht vorhanden ist.
DataLakeFileQueryError	Der Fehler ist während des Schnellabfragevorgangs aufgetreten.
DataLakeLeaseClient	Erstellt einen neuen DataLakeLeaseClient. Dieser Client bietet Leasevorgänge für einen FileSystemClient, DataLakeDirectoryClient oder DataLakeFileClient.
DataLakeServiceClient	Ein Client für die Interaktion mit dem DataLake-Dienst auf Kontoebene. Dieser Client bietet Vorgänge zum Abrufen und Konfigurieren der Kontoeigenschaften sowie zum Auflisten, Erstellen und Löschen von Dateisystemen innerhalb des Kontos. Bei Vorgängen, die sich auf ein bestimmtes Dateisystem, verzeichnis oder eine bestimmte Datei beziehen, können Clients für diese Entitäten auch mithilfe der get_client-Funktionen abgerufen werden.
DeletedPathProperties	Eigenschaften, die für einen gelöschten Pfad aufgefüllt werden.
DelimitedJsonDialect	Definiert die JSON-Serialisierung für die Eingabe oder Ausgabe für eine Datalake-Abfrage. Schlüsselwort (keyword) str-Trennzeichen: Das Zeilentrennzeichen, der Standardwert ist ' '
DelimitedTextDialect	Definiert die ein- oder ausgabedetrennte Serialisierung (CSV) für eine Datalake-Abfrageanforderung. Schlüsselwort (keyword) Str-Trennzeichen: Spaltentrennzeichen, standardmäßig ",". Schlüsselwort (keyword) str quotechar: Feldzitat, standardmäßig """. Schlüsselwort (keyword) str lineterminator: Datensatztrennzeichen, standardmäßig auf ' '. Schlüsselwort (keyword) str escapechar: Escapezeichen, standardmäßig leer. Schlüsselwort (keyword) bool has_header: Gibt an, ob die Blobdaten Header in der ersten Zeile enthalten. Der Standardwert ist False, was bedeutet, dass die Daten einschließlich der ersten Zeile zurückgegeben werden. Wenn sie auf True festgelegt ist, werden die Daten ohne die erste Zeile zurückgegeben.
DirectoryProperties
DirectorySasPermissions	DirectorySasPermissions-Klasse, die mit der generate_directory_sas Funktion verwendet werden soll.
EncryptionScopeOptions	Die Standardkonfiguration des Verschlüsselungsbereichs für ein Dateisystem. Dieser Bereich wird implizit für alle zukünftigen Schreibvorgänge im Dateisystem verwendet, kann aber pro Blobvorgang überschrieben werden. Neu in Version 12.9.0.
ExponentialRetry	Exponentielle Wiederholung. Erstellt ein Exponential-Wiederholungsobjekt. Die initial_backoff wird für den ersten Wiederholungsversuch verwendet. Nachfolgende Wiederholungsversuche werden nach initial_backoff + increment_power^retry_count Sekunden erneut ausgeführt.
FileProperties
FileSasPermissions	FileSasPermissions-Klasse, die mit der generate_file_sas Funktion verwendet werden soll.
FileSystemClient	Ein Client für die Interaktion mit einem bestimmten Dateisystem, auch wenn dieses Dateisystem möglicherweise noch nicht vorhanden ist. Für Vorgänge, die sich auf ein bestimmtes Verzeichnis oder eine bestimmte Datei innerhalb dieses Dateisystems beziehen, kann ein Verzeichnisclient oder Dateiclient mithilfe der get_directory_client -Funktionen oder get_file_client abgerufen werden.
FileSystemProperties	Eigenschaftsklasse des Dateisystems. Zurückgegebene FileSystemProperties Instanzen machen diese Werte über eine Wörterbuchschnittstelle verfügbar, z. B.: file_system_props["last_modified"]. Darüber hinaus ist der Dateisystemname als file_system_props["name"]verfügbar.
FileSystemPropertiesPaged	Eine Iterable von Dateisystemeigenschaften.
FileSystemSasPermissions	FileSystemSasPermissions-Klasse, die mit der generate_file_system_sas Funktion verwendet werden soll.
LeaseProperties	DataLake-Leaseeigenschaften.
LinearRetry	Linearer Wiederholungsversuch. Erstellt ein Linear-Wiederholungsobjekt.
LocationMode	Gibt den Speicherort an, an den die Anforderung gesendet werden soll. Dieser Modus gilt nur für RA-GRS-Konten, die sekundären Lesezugriff ermöglichen. Alle anderen Kontotypen müssen PRIMARY verwenden.
Metrics	Eine Zusammenfassung der Anforderungsstatistiken, die nach API in Stunden- oder Minutenaggregaten gruppiert sind.
PathProperties	Pfadeigenschaften, die von get_paths API aufgeführt sind.
ResourceTypes	Gibt die Ressourcentypen an, auf die mit der Konto-SAS zugegriffen werden kann.
RetentionPolicy	Die Aufbewahrungsrichtlinie, die bestimmt, wie lange die zugeordneten Daten beibehalten werden sollen.
StaticWebsite	Die Eigenschaften, mit denen ein Konto eine statische Website hosten kann.
StorageStreamDownloader	Ein Streamingobjekt zum Herunterladen aus Azure Storage.
UserDelegationKey	Stellt einen Benutzerdelegierungsschlüssel dar, der dem Benutzer von Azure Storage basierend auf dem Azure Active Directory-Zugriffstoken bereitgestellt wird. Die Felder werden als einfache Zeichenfolgen gespeichert, da der Benutzer nicht mit diesem Objekt interagieren muss. um eine Identifizierungs-SAS zu generieren, kann der Benutzer sie einfach an die richtige API übergeben.

Enumerationen

ArrowType
PublicAccess	Gibt an, ob auf Daten im Dateisystem öffentlich zugegriffen werden kann und wie viel Zugriff möglich ist.
QuickQueryDialect	Gibt den Schnellabfrage-Eingabe-/Ausgabedialekt an.
StorageErrorCode

Functions

generate_account_sas

Generiert eine Shared Access Signature für den DataLake-Dienst.

Verwenden Sie die zurückgegebene Signatur als Anmeldeinformationsparameter von DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient oder DataLakeFileClient.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> str

Parameter

account_name

str

Erforderlich

Der Name des Speicherkontos, der zum Generieren der Shared Access Signature verwendet wird.

account_key

str

Erforderlich

Der Zugriffsschlüssel zum Generieren der Freigegebenen Zugriffssignatur.

resource_types

str oder ResourceTypes

Erforderlich

Gibt die Ressourcentypen an, auf die mit der Konto-SAS zugegriffen werden kann.

permission

str oder AccountSasPermissions

Erforderlich

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.

expiry

datetime oder str

Erforderlich

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert immer Werte in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start

datetime oder str

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert immer Werte in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

ip

str

Gibt eine IP-Adresse oder einen Bereich von IP-Adressen an, von denen Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IP-Adresse oder dem Adressbereich übereinstimmt, die im SAS-Token angegeben sind, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise ip=168.1.5.65 oder ip=168.1.5.60-168.1.5.70 für die SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol

str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, damit alle Schreibvorgänge vom Dienst verschlüsselt werden.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

generate_directory_sas

Generiert eine Shared Access Signature für ein Verzeichnis.

Verwenden Sie die zurückgegebene Signatur mit dem credential-Parameter eines beliebigen DataLakeServiceClient-, FileSystemClient-, DataLakeDirectoryClient- oder DataLakeFileClient-Elements.

generate_directory_sas(account_name: str, file_system_name: str, directory_name: str, credential: str | UserDelegationKey, permission: DirectorySasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parameter

account_name

str

Erforderlich

Der Speicherkontoname, der zum Generieren der Shared Access Signature verwendet wird.

file_system_name

str

Erforderlich

Der Name des Dateisystems.

directory_name

str

Erforderlich

Der Name des Verzeichnisses.

credential

str oder UserDelegationKey

Erforderlich

Anmeldeinformationen können entweder Kontoschlüssel oder Benutzerdelegierungsschlüssel sein. Wenn der Kontoschlüssel als Anmeldeinformationen verwendet wird, sollte der Anmeldeinformationstyp str sein. Anstelle eines Kontoschlüssels könnte der Benutzer auch einen Benutzerdelegierungsschlüssel übergeben. Ein Benutzerdelegierungsschlüssel kann vom Dienst abgerufen werden, indem sie sich mit einer AAD-Identität authentifiziert. Dies kann erreicht werden, indem Sie aufrufen get_user_delegation_key. Wenn vorhanden, wird die SAS stattdessen mit dem Benutzerdelegierungsschlüssel signiert.

permission

str oder DirectorySasPermissions

Standardwert: None

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Berechtigungen müssen racwdlmeop sortiert werden. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.

expiry

datetime oder str

Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start

datetime oder str

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

ip

str

Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise ip=168.1.5.65 oder ip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol

str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

cache_control

str

Antwortheaderwert für Cache-Control, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_disposition

str

Antwortheaderwert für Content-Disposition, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_encoding

str

Antwortheaderwert für Content-Encoding, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_language

str

Antwortheaderwert für Content-Language, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_type

str

Antwortheaderwert für Content-Type, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

preauthorized_agent_object_id

str

Die AAD-Objekt-ID eines Benutzers, von dem angenommen wird, dass er vom Besitzer des Benutzerdelegierungsschlüssels autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, aber keine zusätzliche Berechtigungsprüfung für die Agentobjekt-ID durchgeführt wird.

agent_object_id

str

Die AAD-Objekt-ID eines Benutzers wird angenommen, dass der Besitzer des Benutzerdelegierungsschlüssels nicht autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, und der Dienst führt eine zusätzliche POSIX-ACL-Überprüfung durch, um zu ermitteln, ob dieser Benutzer zum Ausführen des angeforderten Vorgangs autorisiert ist.

correlation_id

str

Die Korrelations-ID zum Korrelieren der Speicherüberwachungsprotokolle mit den Überwachungsprotokollen, die vom Prinzipal verwendet werden, der die SAS generiert und verteilt.

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, damit alle Schreibvorgänge vom Dienst verschlüsselt werden.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

generate_file_sas

Generiert eine Shared Access Signature für eine Datei.

Verwenden Sie die zurückgegebene Signatur mit dem credential-Parameter von BDataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient oder DataLakeFileClient.

generate_file_sas(account_name: str, file_system_name: str, directory_name: str, file_name: str, credential: str | UserDelegationKey, permission: FileSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parameter

account_name

str

Erforderlich

Der Speicherkontoname, der zum Generieren der Shared Access Signature verwendet wird.

file_system_name

str

Erforderlich

Der Name des Dateisystems.

directory_name

str

Erforderlich

Der Name des Verzeichnisses.

file_name

str

Erforderlich

Der Name der Datei.

credential

str oder UserDelegationKey

Erforderlich

Anmeldeinformationen können entweder Kontoschlüssel oder Benutzerdelegierungsschlüssel sein. Wenn der Kontoschlüssel als Anmeldeinformationen verwendet wird, sollte der Anmeldeinformationstyp str sein. Anstelle eines Kontoschlüssels könnte der Benutzer auch einen Benutzerdelegierungsschlüssel übergeben. Ein Benutzerdelegierungsschlüssel kann vom Dienst abgerufen werden, indem sie sich mit einer AAD-Identität authentifiziert. Dies kann erreicht werden, indem Sie aufrufen get_user_delegation_key. Wenn vorhanden, wird die SAS stattdessen mit dem Benutzerdelegierungsschlüssel signiert.

permission

str oder FileSasPermissions

Standardwert: None

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Berechtigungen müssen racwdlmeop sortiert werden. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.

expiry

datetime oder str

Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start

datetime oder str

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

ip

str

Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise ip=168.1.5.65 oder ip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol

str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

cache_control

str

Antwortheaderwert für Cache-Control, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_disposition

str

Antwortheaderwert für Content-Disposition, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_encoding

str

Antwortheaderwert für Content-Encoding, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_language

str

Antwortheaderwert für Content-Language, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_type

str

Antwortheaderwert für Content-Type, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

preauthorized_agent_object_id

str

Die AAD-Objekt-ID eines Benutzers, von dem angenommen wird, dass er vom Besitzer des Benutzerdelegierungsschlüssels autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, aber keine zusätzliche Berechtigungsprüfung für die Agentobjekt-ID durchgeführt wird.

agent_object_id

str

Die AAD-Objekt-ID eines Benutzers wird angenommen, dass der Besitzer des Benutzerdelegierungsschlüssels nicht autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, und der Dienst führt eine zusätzliche POSIX-ACL-Überprüfung durch, um zu ermitteln, ob dieser Benutzer zum Ausführen des angeforderten Vorgangs autorisiert ist.

correlation_id

str

Die Korrelations-ID zum Korrelieren der Speicherüberwachungsprotokolle mit den Überwachungsprotokollen, die vom Prinzipal verwendet werden, der die SAS generiert und verteilt. Dies kann nur beim Generieren einer SAS mit Delegierungsschlüssel verwendet werden.

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, damit alle Schreibvorgänge vom Dienst verschlüsselt werden.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

generate_file_system_sas

Generiert eine Shared Access Signature für ein Dateisystem.

Verwenden Sie die zurückgegebene Signatur mit dem credential-Parameter eines beliebigen DataLakeServiceClient-, FileSystemClient-, DataLakeDirectoryClient- oder DataLakeFileClient-Elements.

generate_file_system_sas(account_name: str, file_system_name: str, credential: str | UserDelegationKey, permission: FileSystemSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parameter

account_name

str

Erforderlich

Der Speicherkontoname, der zum Generieren der Shared Access Signature verwendet wird.

file_system_name

str

Erforderlich

Der Name des Dateisystems.

credential

str oder UserDelegationKey

Erforderlich

Anmeldeinformationen können entweder Kontoschlüssel oder Benutzerdelegierungsschlüssel sein. Wenn der Kontoschlüssel als Anmeldeinformationen verwendet wird, sollte der Anmeldeinformationstyp str sein. Anstelle eines Kontoschlüssels könnte der Benutzer auch einen Benutzerdelegierungsschlüssel übergeben. Ein Benutzerdelegierungsschlüssel kann vom Dienst abgerufen werden, indem sie sich mit einer AAD-Identität authentifiziert. Dies kann erreicht werden, indem Sie aufrufen get_user_delegation_key. Wenn vorhanden, wird die SAS stattdessen mit dem Benutzerdelegierungsschlüssel signiert.

permission

str oder FileSystemSasPermissions

Standardwert: None

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Berechtigungen müssen racwdlmeop sortiert werden. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.

expiry

datetime oder str

Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird eine ID angegeben, die auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start

datetime oder str

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

ip

str

Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise ip=168.1.5.65 oder ip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol

str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

cache_control

str

Antwortheaderwert für Cache-Control, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_disposition

str

Antwortheaderwert für Content-Disposition, wenn mithilfe dieser Shared Access Signature auf die Ressource zugegriffen wird.

content_encoding

str

Antwortheaderwert für Content-Encoding, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_language

str

Antwortheaderwert für Content-Language, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

content_type

str

Antwortheaderwert für Content-Type, wenn auf die Ressource mithilfe dieser Shared Access Signature zugegriffen wird.

preauthorized_agent_object_id

str

Die AAD-Objekt-ID eines Benutzers, von dem angenommen wird, dass er vom Besitzer des Benutzerdelegierungsschlüssels autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, aber keine zusätzliche Berechtigungsprüfung für die Agentobjekt-ID durchgeführt wird.

agent_object_id

str

Die AAD-Objekt-ID eines Benutzers wird angenommen, dass der Besitzer des Benutzerdelegierungsschlüssels nicht autorisiert ist, um die vom SAS-Token gewährte Aktion auszuführen. Der Dienst überprüft das SAS-Token und stellt sicher, dass der Besitzer des Benutzerdelegierungsschlüssels über die erforderlichen Berechtigungen verfügt, bevor er Zugriff gewährt, und der Dienst führt eine zusätzliche POSIX-ACL-Überprüfung durch, um zu ermitteln, ob dieser Benutzer zum Ausführen des angeforderten Vorgangs autorisiert ist.

correlation_id

str

Die Korrelations-ID zum Korrelieren der Speicherüberwachungsprotokolle mit den Überwachungsprotokollen, die vom Prinzipal verwendet werden, der die SAS generiert und verteilt.

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, damit alle Schreibvorgänge vom Dienst verschlüsselt werden.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str