blob Paket

Pakete

aio

Klassen

AccessPolicy	Access Policy class used by the set and get access policy methods in each service. 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 in 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	ResourceTypes -Klasse, die mit generate_account_sas-Funktion und für die AccessPolicies verwendet werden soll, die mit set_*_acl verwendet wird. Es gibt zwei Sas-Typen, die zum Gewähren des Ressourcenzugriffs verwendet werden können. Eine besteht darin, Zugriff auf eine bestimmte Ressource (ressourcenspezifisch) zu gewähren. Eine andere besteht darin, zugriff auf den gesamten Dienst für ein bestimmtes Konto zu gewähren und bestimmte Vorgänge basierend auf den hier gefundenen Beständigkeiten zuzulassen.
ArrowDialect	-Feld eines Pfeilschemas. Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
BlobAnalyticsLogging	Azure Analytics-Protokollierungseinstellungen.
BlobBlock	BlockBlob Block-Klasse.
BlobClient	Ein Client, der mit einem bestimmten Blob interagiert, obwohl dieses Blob möglicherweise noch nicht vorhanden ist. Weitere optionale Konfigurationen finden Sie hier.
BlobLeaseClient	Erstellt einen neuen BlobLeaseClient. Dieser Client stellt Leasevorgänge für einen BlobClient oder ContainerClient bereit.
BlobPrefix	Eine Iterable von Blobeigenschaften. Wird von walk_blobs zurückgegeben, wenn ein Trennzeichen verwendet wird. Kann als virtuelles Blobverzeichnis betrachtet werden.
BlobProperties	Blobeigenschaften.
BlobQueryError	Der Fehler ist während des schnellen Abfragevorgangs aufgetreten.
BlobQueryReader	Ein Streamingobjekt zum Lesen von Abfrageergebnissen.
BlobSasPermissions	BlobSasPermissions-Klasse, die mit der generate_blob_sas Funktion verwendet werden soll.
BlobServiceClient	Ein Client für die Interaktion mit dem Blobdienst auf Kontoebene. Dieser Client bietet Vorgänge zum Abrufen und Konfigurieren der Kontoeigenschaften sowie zum Auflisten, Erstellen und Löschen von Containern innerhalb des Kontos. Bei Vorgängen im Zusammenhang mit einem bestimmten Container oder Blob können Clients für diese Entitäten auch mithilfe der get_client-Funktionen abgerufen werden. Weitere optionale Konfigurationen finden Sie hier.
ContainerClient	Ein Client, der mit einem bestimmten Container interagiert, obwohl dieser Container möglicherweise noch nicht vorhanden ist. Für Vorgänge, die sich auf ein bestimmtes Blob in diesem Container beziehen, kann ein Blobclient mithilfe der get_blob_client -Funktion abgerufen werden. Weitere optionale Konfigurationen finden Sie hier.
ContainerEncryptionScope	Die Standardkonfiguration des Verschlüsselungsbereichs für einen Container. Dieser Bereich wird implizit für alle zukünftigen Schreibvorgänge innerhalb des Containers verwendet, kann aber pro Blobvorgang überschrieben werden. Neu in Version 12.2.0.
ContainerProperties	Eigenschaftenklasse des Blobcontainers. Zurückgegebene ContainerProperties Instanzen machen diese Werte über eine Wörterbuchschnittstelle verfügbar, z. B. container_props["last_modified"]. Darüber hinaus ist der Containername als container_props["name"]verfügbar.
ContainerSasPermissions	ContainerSasPermissions-Klasse, die mit der generate_container_sas -Funktion und für die accessPolicies verwendet werden soll, die mit set_container_access_policyverwendet wird.
ContentSettings	Die Inhaltseinstellungen eines Blobs.
CopyProperties	Blobkopiereigenschaften. Diese Eigenschaften sind Keine , wenn dieses Blob noch nie das Ziel in einem Kopierblobvorgang war oder wenn dieses Blob nach einem abgeschlossenen Vorgang zum Kopieren von Blobs geändert wurde, z. B. mithilfe von Set Blob Properties, Upload Blob oder Commit Block List.
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 Den Versionen 2018-06-17 und höher können Sie den Schlüssel verwalten, der zum Verschlüsseln von Blobinhalten und Anwendungsmetadaten pro Blob 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 ein Blob wird der bereitgestellte Schlüssel verwendet, um Ihre Daten zu verschlüsseln, bevor sie auf den Datenträger geschrieben werden. Ein SHA-256-Hash des Verschlüsselungsschlüssels wird zusammen mit dem Blobinhalt geschrieben und verwendet, um zu überprüfen, ob alle nachfolgenden Vorgänge für das Blob denselben Verschlüsselungsschlüssel verwenden. Dieser Hash kann nicht verwendet werden, um den Verschlüsselungsschlüssel abzurufen oder den Inhalt des Blobs zu entschlüsseln. Beim Lesen eines Blobs 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.
DelimitedJsonDialect	Definiert die JSON-Serialisierung für die Eingabe oder Ausgabe für eine Blobdatenabfrage. Schlüsselwort (keyword) str-Trennzeichen: Das Zeilentrennzeichen, Standardwert ist ' '
DelimitedTextDialect	Definiert die Csv-Serialisierung (Eingabe- oder Ausgabetrennzeichen) für eine Blobabfrageanforderung.
ExponentialRetry	Exponentielle Wiederholung. Erstellt ein Exponentielles Wiederholungsobjekt. Die initial_backoff wird für den ersten Wiederholungsversuch verwendet. Nachfolgende Wiederholungsversuche werden nach initial_backoff + increment_power^retry_count Sekunden wiederholt.
FilteredBlob	Blobinformationen aus einem Api-Aufruf der Filterblobs-Api.
ImmutabilityPolicy	Optionale Parameter zum Festlegen der Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion. Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.
LeaseProperties	Blobleasingeigenschaften.
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 für Blobs gruppiert sind.
ObjectReplicationPolicy	Richtlinien-ID und Regel-IDs, die auf ein Blob angewendet werden.
ObjectReplicationRule	Richtlinien-ID und Regel-IDs, die auf ein Blob angewendet werden.
PageRange	Seitenbereich für Seitenblob.
PartialBatchErrorException	Bei Batchvorgängen tritt ein Teilfehler auf.
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, das aus Azure Storage heruntergeladen werden soll.
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
BlobImmutabilityPolicyMode	Gibt den Unveränderlichkeitsrichtlinienmodus an, der für das Blob festgelegt werden soll. "Mutable" kann nur vom Dienst zurückgegeben werden, und legen Sie nicht auf "Änderbar" fest.
BlobType
BlockState	Blockblobblocktypen.
PremiumPageBlobTier	Gibt die Seitenblobebene an, auf die das Blob festgelegt werden soll. Dies gilt nur für Seitenblobs in Storage Premium-Konten. Ausführliche Informationen zu den entsprechenden IOPS und dem Durchsatz pro PageBlobTier finden Sie unter: https://docs.microsoft.com/en-us/azure/storage/storage-premium-storage#scalability-and-performance-targets
PublicAccess	Gibt an, ob öffentlicher Zugriff auf Daten im Container zulässig ist, und gibt die Zugriffsebene an.
QuickQueryDialect	Gibt den Schnellabfrage-Eingabe-/Ausgabedialekt an.
RehydratePriority	Wenn sich ein Objekt im Status "Rehydrate Pending" befindet, wird dieser Header mit der Priorität rehydrieren zurückgegeben. Gültige Werte sind High und Standard.
SequenceNumberAction	Sequenznummernaktionen.
StandardBlobTier	Gibt die Blobebene an, auf die das Blob festgelegt werden soll. Dies gilt nur für Blockblobs in Standardspeicherkonten.
StorageErrorCode

Functions

download_blob_from_url

Laden Sie den Inhalt eines Blobs in eine lokale Datei oder einen lokalen Stream herunter.

download_blob_from_url(blob_url: str, output: str, credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> None

Parameter

blob_url

str

Erforderlich

Der vollständige URI für das Blob. Dies kann auch ein SAS-Token enthalten.

output

str oder <xref:<xref:writable stream.>>

Erforderlich

Wo die Daten heruntergeladen werden sollen. Dies kann entweder ein Dateipfad sein, in den geschrieben werden soll, oder ein geöffnetes E/A-Handle, in das geschrieben werden soll.

credential

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Blob-URL bereits über ein SAS-Token verfügt oder das Blob öffentlich ist. 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.

overwrite

bool

Gibt an, ob die lokale Datei überschrieben werden soll, wenn sie bereits vorhanden ist. Der Standardwert ist False . In diesem Fall wird ein ValueError ausgelöst, wenn die Datei bereits vorhanden ist. Wenn sie auf True festgelegt ist, wird versucht, in die vorhandene Datei zu schreiben. Wenn ein Streamhandle übergeben wird, wird dieser Wert ignoriert.

max_concurrency

int

Die Anzahl der parallelen Verbindungen, mit denen heruntergeladen werden soll.

offset

int

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

length

int

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

validate_content

bool

Wenn true, berechnet ein MD5-Hash für jeden Block des Blobs. 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 dem BLOB gespeichert wird. Beachten Sie außerdem, dass bei Aktivierung der speichereffiziente Uploadalgorithmus nicht verwendet wird, da für die Berechnung des MD5-Hashs das Puffern ganzer Blöcke erforderlich ist. Dadurch wird der Zweck des speichereffizienten Algorithmus verfehlt.

Rückgabetyp

None

generate_account_sas

Generiert eine Shared Access Signature für den Blobdienst.

Verwenden Sie die zurückgegebene Signatur mit dem Anmeldeinformationsparameter eines beliebigen BlobServiceClients, ContainerClients oder BlobClients.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, start: datetime | str | None = None, ip: str | None = 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 Kontoschlüssel, auch als freigegebener Schlüssel oder Zugriffsschlüssel bezeichnet, um die Shared Access Signature zu generieren.

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

Standardwert: None

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

Standardwert: None

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 für eine anforderung zulässige Protokoll an. Der Standardwert ist https.

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, die ausgeführt wird, damit alle Schreibvorgänge dienstverschlüsselt werden.

Gibt zurück

Ein SAS-Token (Shared Access Signature).

Rückgabetyp

str

generate_blob_sas

Generiert eine Shared Access Signature für ein Blob.

Verwenden Sie die zurückgegebene Signatur mit dem Anmeldeinformationsparameter eines beliebigen BlobServiceClients, ContainerClients oder BlobClients.

generate_blob_sas(account_name: str, container_name: str, blob_name: str, snapshot: str | None = None, account_key: str | None = None, user_delegation_key: UserDelegationKey | None = None, permission: BlobSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> Any

Parameter

account_name

str

Erforderlich

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

container_name

str

Erforderlich

Der Name des Containers,

blob_name

str

Erforderlich

Der Name des Blobs.

snapshot

str

Standardwert: None

Eine optionale Blob-Momentaufnahme-ID.

account_key

str

Standardwert: None

Der Kontoschlüssel, auch als freigegebener Schlüssel oder Zugriffsschlüssel bezeichnet, um die Shared Access Signature zu generieren. Es müssen account_key oder user_delegation_key angegeben werden.

user_delegation_key

UserDelegationKey

Standardwert: None

Anstelle eines freigegebenen Kontoschlüssels könnte der Benutzer 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 BlobSasPermissions

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 racwdxytmei angeordnet sein. 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 immer Werte in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start

datetime oder str

Standardwert: None

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.

policy_id

str

Standardwert: None

Ein eindeutiger Wert mit einer Länge von bis zu 64 Zeichen, der mit einer gespeicherten Zugriffsrichtlinie korreliert. Verwenden set_container_access_policySie zum Erstellen einer gespeicherten Zugriffsrichtlinie .

ip

str

Standardwert: None

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.

version_id

str

Eine optionale Blobversions-ID. Dieser Parameter gilt nur für Speicherkonten mit Aktivierter Versionskontrolle. Beachten Sie, dass der Abfrageparameter "versionid" nicht in der Ausgabe-SAS enthalten ist. Geben Sie daher den Parameter "version_id" für alle APIs an, wenn Sie die Ausgabe-SAS verwenden, um mit einer bestimmten Version zu arbeiten.

Neu in Version 12.4.0: Dieses Schlüsselwort (keyword) Argument wurde in der API-Version "2019-12-12" eingeführt.

protocol

str

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

cache_control

str

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

content_disposition

str

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

content_encoding

str

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

content_language

str

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

content_type

str

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

encryption_scope

str

Gibt den Verschlüsselungsbereich für eine Anforderung an, die ausgeführt wird, damit alle Schreibvorgänge dienstverschlüsselt werden.

correlation_id

str

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

Gibt zurück

Ein SAS-Token (Shared Access Signature).

Rückgabetyp

str

generate_container_sas

Generiert eine Shared Access Signature für einen Container.

Verwenden Sie die zurückgegebene Signatur mit dem credential-Parameter eines beliebigen BlobServiceClient-, ContainerClient- oder BlobClient-Elements.

generate_container_sas(account_name: str, container_name: str, account_key: str | None = None, user_delegation_key: UserDelegationKey | None = None, permission: ContainerSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> Any

Parameter

account_name

str

Erforderlich

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

container_name

str

Erforderlich

Der Name des Containers,

account_key

str

Standardwert: None

Der Kontoschlüssel, auch als freigegebener Schlüssel oder Zugriffsschlüssel bezeichnet, um die Shared Access Signature zu generieren. Es müssen account_key oder user_delegation_key angegeben werden.

user_delegation_key

UserDelegationKey

Standardwert: None

Anstelle eines freigegebenen Kontoschlüssels könnte der Benutzer 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 ContainerSasPermissions

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

Standardwert: None

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.

policy_id

str

Standardwert: None

Ein eindeutiger Wert mit einer Länge von bis zu 64 Zeichen, der mit einer gespeicherten Zugriffsrichtlinie korreliert. Verwenden Sie set_container_access_policyzum Erstellen einer gespeicherten Zugriffsrichtlinie .

ip

str

Standardwert: None

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.

encryption_scope

str

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

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.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

upload_blob_to_url

Hochladen von Daten in eine angegebene URL

Die Daten werden als Blockblob hochgeladen.

upload_blob_to_url(blob_url: str, data: Union[Iterable[AnyStr], IO[AnyStr]], credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> Dict[str, Any]

Parameter

blob_url

str

Erforderlich

Der vollständige URI für das Blob. Dies kann auch ein SAS-Token enthalten.

data

bytes oder str oder Iterable

Erforderlich

Die hochzuladenden Daten. Dies können Bytes, Text, ein iterierbares oder ein dateiähnliches Objekt sein.

credential

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Blob-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.

overwrite

bool

Gibt an, ob das hochzuladende Blob die aktuellen Daten überschreiben soll. Bei True überschreibt upload_blob_to_url alle vorhandenen Daten. Wenn dieser Wert auf False festgelegt ist, schlägt der Vorgang mit einem ResourceExistsError-Element fehl.

max_concurrency

int

Die Anzahl der parallelen Verbindungen, mit denen heruntergeladen werden soll.

length

int

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

metadata

dict(str,str)

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

validate_content

bool

Wenn true, berechnet einen MD5-Hash für jeden Block des Blobs. 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 mit dem BLOB 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.

encoding

str

Codierung, die verwendet werden soll, wenn Text als Eingabe bereitgestellt wird. Der Standardwert ist UTF-8.

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag und letzte Änderung)

Rückgabetyp

dict(str, Any)