azure.storage.blob.BlobClient class

Abbrechen eines laufenden Kopiervorgangs.

Dadurch bleibt ein Zielblob mit der Länge null und den vollständigen Metadaten erhalten. Dadurch wird ein Fehler ausgelöst, wenn der Kopiervorgang bereits beendet wurde.

abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None

Parameter

copy_id: str oder BlobProperties

Erforderlich

Der abzubrechende Kopiervorgang. Dies kann entweder eine ID-Zeichenfolge oder eine instance von BlobProperties sein.

Rückgabetyp

None

Fordert eine neue Lease an.

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

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> BlobLeaseClient

Parameter

lease_duration: int

Erforderlich

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 mit Verlängerung oder Änderung geändert werden. Der Standardwert ist -1 (unendliche Lease).

lease_id: str

Erforderlich

Vorgeschlagene Lease-ID in einem GUID-Zeichenfolgenformat. Der Blobdienst gibt 400 (ungültige Anforderung) zurück, wenn die vorgeschlagene Lease-ID nicht im richtigen Format vorliegt.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

Gibt zurück

Ein BlobLeaseClient-Objekt.

Rückgabetyp

BlobLeaseClient

Committ einen neuen Datenblock an das Ende des vorhandenen Anfügeblobs.

append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parameter

data: bytes oder str oder Iterable

Erforderlich

Inhalt des Blocks. Dies kann Bytes, Text, ein iterierbares oder ein dateiähnliches Objekt sein.

length: int

Erforderlich

Größe des Blocks in Bytes.

validate_content: bool

Wenn true, berechnet einen MD5-Hash des Blockinhalts. 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 http anstelle von https verwendet wird, da https (der Standardwert) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird.

maxsize_condition: int

Optionaler bedingter Header. Die maximale Länge in Bytes, die für das Anfügeblob zulässig ist. Wenn der Vorgang Block anfügen dazu führt, dass das Blob diesen Grenzwert überschreitet oder die Blobgröße bereits größer als der in diesem Header angegebene Wert ist, schlägt die Anforderung mit dem Fehler MaxBlobSizeConditionNotMet (HTTP-status Code 412 – Vorbedingung fehlgeschlagen) fehl.

appendpos_condition: int

Optionaler bedingter Header, der nur für den Vorgang "Block anfügen" verwendet wird. Eine Zahl, die den zu vergleichenden Byteoffset angibt. Der Anfügeblock ist nur erfolgreich, wenn die Anfügeposition gleich dieser Zahl ist. Ist dies nicht der Fall, schlägt die Anforderung mit dem Fehler AppendPositionConditionNotMet (HTTP status Code 412 – Vorbedingung fehlgeschlagen) fehl.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

encoding: str

Standardmäßig wird UTF-8 verwendet.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag, zuletzt geändert, Offset anfügen, Anzahl der zugesagten Blocken).

Rückgabetyp

dict(str, Any)

Erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem der Inhalt aus einer Quell-URL gelesen wird.

append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parameter

copy_source_url: str

Erforderlich

Die URL der Quelldaten. Es kann auf ein beliebiges Azure-Blob oder eine Beliebige Datei verweisen, die entweder öffentlich ist oder eine freigegebene Zugriffssignatur angefügt ist.

source_offset: int

Erforderlich

Dies gibt den Beginn des Bytebereichs (einschließlich) an, der aus der Kopierquelle entnommen werden muss.

source_length: int

Erforderlich

Dies gibt das Ende des Bytesbereichs an, der aus der Kopierquelle entnommen werden muss.

source_content_md5: bytearray

Falls angegeben, berechnet der Dienst den MD5-Hash des Blockinhalts und vergleicht mit diesem Wert.

maxsize_condition: int

Optionaler bedingter Header. Die maximale Länge in Bytes, die für das Anfügeblob zulässig ist. Wenn der Vorgang Block anfügen dazu führt, dass das Blob diesen Grenzwert überschreitet oder die Blobgröße bereits größer als der in diesem Header angegebene Wert ist, schlägt die Anforderung mit dem Fehler MaxBlobSizeConditionNotMet (HTTP-status Code 412 – Vorbedingung fehlgeschlagen) fehl.

appendpos_condition: int

Optionaler bedingter Header, der nur für den Vorgang "Block anfügen" verwendet wird. Eine Zahl, die den zu vergleichenden Byteoffset angibt. Der Anfügeblock ist nur erfolgreich, wenn die Anfügeposition gleich dieser Zahl ist. Ist dies nicht der Fall, schlägt die Anforderung mit dem Fehler AppendPositionConditionNotMet (HTTP status Code 412 – Vorbedingung fehlgeschlagen) fehl.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Ziel-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

source_if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit der angegebenen Zeit geändert wurde.

source_if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

source_etag: str

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

source_match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

source_authorization: str

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

Löscht einen Seitenbereich.

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

Parameter

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Schreiben in einen Abschnitt des Blobs verwendet werden soll. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modul von 512 und die Länge ein Modul von 512 sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Schreiben in einen Abschnitt des Blobs verwendet werden sollen. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modul von 512 und die Länge ein Modul von 512 sein.

lease: BlobLeaseClient oder str

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

if_sequence_number_lte: int

Wenn die Sequenznummer des Blobs kleiner oder gleich dem angegebenen Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_lt: int

Wenn die Sequenznummer des Blobs kleiner als der angegebene Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_eq: int

Wenn die Sequenznummer des Blobs dem angegebenen Wert entspricht, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Blob-aktualisierte Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

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

Der Vorgang Commit-Blockliste schreibt ein Blob, indem die Liste der Block-IDs angegeben wird, aus denen das Blob besteht.

commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parameter

block_list: list

Erforderlich

Liste der Blockblobs.

content_settings: ContentSettings

Erforderlich

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

metadata: dict[str, str]

Erforderlich

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

tags: dict(str, str)

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), Pluszeichen (+), Minuszeichen (-), Punkt (.), Solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

Neu in Version 12.4.0.

lease: BlobLeaseClient oder str

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

immutability_policy: ImmutabilityPolicy

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

legal_hold: bool

Gibt an, ob für das Blob ein gesetzlicher Aufbewahrungsspeicher festgelegt werden soll.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

validate_content: bool

Wenn true, berechnet einen MD5-Hash des Seiteninhalts. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie für die Erkennung von Bitflips im Netzwerk nützlich, wenn http anstelle von https verwendet wird, da https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL where-Klausel für Blobtags an, die nur für Zielblobs mit einem übereinstimmenden Wert verwendet werden soll.

Neu in Version 12.4.0.

standard_blob_tier: StandardBlobTier

Ein Standard-Blobebenenwert, auf den das Blob festgelegt werden soll. Für diese Version der Bibliothek gilt dies nur für Blockblobs in Standardspeicherkonten.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

Erstellt ein neues Anfügeblob. Mit diesem Vorgang wird ein neues Anfügeblob mit 0 Länge erstellt. Der Inhalt eines vorhandenen Blobs wird mit dem neu initialisierten Anfügeblob überschrieben. Um dem Anfügeblob Inhalte hinzuzufügen, rufen Sie die - oder append_block_from_url -append_blockMethode auf.

create_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parameter

content_settings: ContentSettings

Erforderlich

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

metadata: dict(str, str)

Erforderlich

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

tags: dict(str, str)

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), Pluszeichen (+), Minuszeichen (-), Punkt (.), Solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

Neu in Version 12.4.0.

lease: BlobLeaseClient oder str

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

immutability_policy: ImmutabilityPolicy

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

legal_hold: bool

Gibt an, ob für das Blob ein gesetzlicher Aufbewahrungsspeicher festgelegt werden soll.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict[str, Any]

Erstellt ein neues Seitenblob der angegebenen Größe.

create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]

Parameter

size: int

Erforderlich

Dadurch wird die maximale Größe für das Seitenblob von bis zu 1 TB angegeben. Die Größe des Seitenblobs muss auf eine Begrenzung von 512 Bytes ausgerichtet werden.

content_settings: ContentSettings

Erforderlich

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

metadata: dict(str, str)

Erforderlich

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

premium_page_blob_tier: PremiumPageBlobTier

Erforderlich

Ein Seitenblobebenenwert, auf den das Blob festgelegt werden soll. Die Ebene korreliert mit der Größe des Blobs und der Anzahl der zulässigen IOPS. Dies gilt nur für Seitenblobs in Storage Premium-Konten.

tags: dict(str, str)

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), Pluszeichen (+), Minuszeichen (-), Punkt (.), Solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

Neu in Version 12.4.0.

sequence_number: int

Nur für Seitenblobs. Die Sequenznummer ist ein vom Benutzer festgelegter Wert, anhand dessen Anforderungen nachverfolgt werden können. Der Wert der Sequenznummer muss zwischen 0 und 2^63 - 1 liegen. Der Standardwert ist 0.

lease: BlobLeaseClient oder str

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

immutability_policy: ImmutabilityPolicy

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

legal_hold: bool

Gibt an, ob für das Blob ein gesetzlicher Aufbewahrungsspeicher festgelegt werden soll.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict[str, Any]

Erstellt eine Momentaufnahme des Blobs.

Eine Momentaufnahme ist eine schreibgeschützte Version eines Blobs, die zu einem bestimmten Zeitpunkt erstellt wird. Sie kann gelesen, kopiert oder gelöscht, aber nicht geändert werden. Momentaufnahmen bieten eine Möglichkeit, um ein Blob so zu sichern, wie es zu einem bestimmten Zeitpunkt dargestellt wird.

Ein Momentaufnahme eines Blobs hat denselben Namen wie das Basisblob, von dem das Momentaufnahme genommen wird, wobei ein DateTime-Wert angefügt wird, um die Uhrzeit anzugeben, zu der die Momentaufnahme genommen wurde.

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

Parameter

metadata: dict(str, str)

Erforderlich

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL where-Klausel für Blobtags an, die nur für Zielblobs mit einem übereinstimmenden Wert verwendet werden soll.

Neu in Version 12.4.0.

lease: BlobLeaseClient oder str

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

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Momentaufnahme-ID, Etag und zuletzt geändert).

Rückgabetyp

dict[str, Any]

Markiert das angegebene BLOB zum Löschen.

Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang delete_blob() löschen.

Wenn eine Aufbewahrungsrichtlinie für das Löschen für den Dienst aktiviert ist, löscht dieser Vorgang das Blob vorläufig und behält das Blob für eine angegebene Anzahl von Tagen bei. Nach der angegebenen Anzahl von Tagen werden die Daten des Blobs während der Garbage Collection aus dem Dienst entfernt. Auf vorläufig gelöschtes Blob kann über list_blobs die Option include=['deleted'] zugegriffen werden. Vorläufig gelöschtes Blob kann mithilfe eines Vorgangs <xref:azure.storage.blob.undelete> wiederhergestellt werden.

delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None

Parameter

delete_snapshots: str

Erforderlich

Erforderlich, wenn dem BLOB Momentaufnahmen zugeordnet sind. Mögliche Werte:

"nur": Löscht nur die Blobs-Momentaufnahmen.
"include": Löscht das Blob zusammen mit allen Momentaufnahmen.

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, wenn vorhanden, die Version des zu löschenden Blobs angibt.

Neu in Version 12.4.0.

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

lease: BlobLeaseClient oder str

Erforderlich, wenn das BLOB über eine aktive Lease verfügt. Wenn angegeben, ist delete_blob nur erfolgreich, wenn die Lease des Blobs aktiv ist und dieser ID entspricht. Der Wert kann ein BlobLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

Rückgabetyp

None

Der Vorgang Unveränderlichkeitsrichtlinie löschen löscht die Unveränderlichkeitsrichtlinie für das Blob.

Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.

delete_immutability_policy(**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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Schlüsselwertpaare von Blobtags.

Rückgabetyp

Dict[str, str]

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

download_blob(offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Parameter

offset: int

Erforderlich

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

length: int

Erforderlich

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

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, wenn vorhanden, die Version des herunterzuladenden Blobs angibt.

Neu in Version 12.4.0.

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

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 http anstelle von https verwendet wird, da https (der Standardwert) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird. Beachten Sie außerdem, dass der speichereffiziente Uploadalgorithmus bei Aktivierung nicht verwendet wird, da die Berechnung des MD5-Hashs das Puffern ganzer Blöcke erfordert und dadurch den Zweck des speichereffizienten Algorithmus vereitet.

lease: BlobLeaseClient oder str

Erforderlich, wenn das BLOB über eine aktive Lease verfügt. Wenn angegeben, download_blob nur erfolgreich, wenn die Lease des Blobs aktiv ist und dieser ID entspricht. Der Wert kann ein BlobLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

max_concurrency: int

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

encoding: str

Codierung zum Decodieren der heruntergeladenen Bytes. Der Standardwert ist Keine, d. h. keine Decodierung.

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

Ein Rückruf, um den Fortschritt eines lange ausgeführten Downloads nachzuverfolgen. Die Signatur ist function(current: int, total: int), wobei current die Anzahl der bisher übertragenen Bytes ist, und total ist die Gesamtgröße des Downloads.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier. Diese Methode kann mehrere Aufrufe des Diensts tätigen, und das Timeout gilt für jeden Aufruf einzeln. Mehrere Aufrufe des Azure-Diensts und das Timeout gelten für jeden Aufruf einzeln.

Gibt zurück

Ein Streamingobjekt (StorageStreamDownloader)

Rückgabetyp

StorageStreamDownloader

Gibt True zurück, wenn ein Blob mit den definierten Parametern vorhanden ist, und gibt andernfalls False zurück.

exists(**kwargs: Any) -> bool

Parameter

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Version des Blobs angibt, um zu überprüfen, ob es vorhanden 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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

boolean

Rückgabetyp

bool

Erstellen Sie BlobClient aus einer Blob-URL. Dies unterstützt keine angepasste Blob-URL mit "/" im Blobnamen.

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

Parameter

blob_url: str

Erforderlich

Die vollständige Endpunkt-URL für das Blob, einschließlich SAS-Token und Momentaufnahme, falls verwendet. Dies kann je nach aktueller location_mode entweder der primäre Endpunkt oder der sekundäre Endpunkt sein.

credential: Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt oder die Verbindungszeichenfolge bereits über Shared Access Key-Werte 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.

snapshot: str

Standardwert: None

Die optionale Blob-Momentaufnahme, mit der betrieben werden soll. Dies kann die Momentaufnahme ID-Zeichenfolge oder die antwort sein, die von create_snapshotzurückgegeben wird. Wenn angegeben, überschreibt dies die Momentaufnahme in der URL.

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Version des Blobs angibt, mit dem ausgeführt werden soll.

Gibt zurück

Ein Blobclient.

Rückgabetyp

BlobClient

Erstellen Sie BlobClient aus einer Verbindungszeichenfolge.

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

Ein Verbindungszeichenfolge zu einem Azure Storage-Konto.

container_name: str

Erforderlich

Der Containername für das Blob.

blob_name: str

Erforderlich

Der Name des Blobs, mit dem interagiert werden soll.

snapshot: str

Standardwert: None

Die optionale Blob-Momentaufnahme, mit der betrieben werden soll. Dies kann die Momentaufnahme ID-Zeichenfolge oder die antwort sein, die von create_snapshotzurückgegeben wird.

credential: Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt oder die Verbindungszeichenfolge bereits über Shared Access Key-Werte 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. Die hier bereitgestellten Anmeldeinformationen haben Vorrang vor denen im Verbindungszeichenfolge. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Version des Blobs angibt, mit dem ausgeführt werden soll.

Gibt zurück

Ein Blobclient.

Rückgabetyp

BlobClient

Ruft Informationen im Zusammenhang mit dem Speicherkonto ab, in dem sich das Blob befindet.

Die Informationen können auch abgerufen werden, wenn der Benutzer über eine SAS für einen Container oder ein Blob verfügt. Die Schlüssel im zurückgegebenen Wörterbuch enthalten "sku_name" und "account_kind".

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

Gibt zurück

Ein Diktat der Kontoinformationen (SKU und Kontotyp).

Rückgabetyp

dict(str, str)

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für das BLOB zurück. Der Inhalt des BLOB wird nicht zurückgegeben.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parameter

lease: BlobLeaseClient oder str

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

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Version des Blobs angibt, um Eigenschaften abzurufen.

Neu in Version 12.4.0.

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

BlobProperties

Rückgabetyp

BlobProperties

Mit dem Vorgang Tags abrufen können Benutzer Tags für ein Blob oder eine bestimmte Blobversion oder Momentaufnahme abrufen.

Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.

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

Parameter

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die Version des Blobs angibt, dem Tags hinzugefügt werden sollen.

if_tags_match_condition: str

Geben Sie eine SQL where-Klausel für Blobtags an, die nur für Zielblobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

lease: BlobLeaseClient oder str

Erforderlich, wenn das BLOB über eine aktive Lease verfügt. Der Wert kann ein BlobLeaseClient-Objekt oder die Lease-ID als Zeichenfolge 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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Schlüsselwertpaare von Blobtags.

Rückgabetyp

Dict[str, str]

Der Vorgang Blockliste abrufen ruft die Liste der Blöcke ab, die als Teil eines Blockblobs hochgeladen wurden.

get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]

Parameter

block_list_type: str

Erforderlich

Gibt an, ob die Liste der Blöcke mit ausgeführtem Commit, die Liste der Blöcke ohne ausgeführten Commit oder beide Listen zusammen zurückgegeben werden. Mögliche Werte: "commit", "uncommitted", "all"

lease: BlobLeaseClient oder str

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

if_tags_match_condition: str

Geben Sie eine SQL where-Klausel für Blobtags an, die nur für Zielblobs mit einem übereinstimmenden Wert verwendet werden soll.

Neu in Version 12.4.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-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 Tupel aus zwei Listen – committeten und nicht committeten Blöcken

Rückgabetyp

tuple(list(BlobBlock), list(BlobBlock))

Gibt die Liste der gültigen Seitenbereiche für einen verwalteten Datenträger oder Momentaufnahme zurück.

Hinweis

Dieser Vorgang ist nur für Verwaltete Datenträgerkonten verfügbar.

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

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

Parameter

previous_snapshot_url

Erforderlich

Gibt die URL eines vorherigen Momentaufnahme des verwalteten Datenträgers an. Die Antwort enthält nur Seiten, die zwischen dem Zielblob und dem vorherigen Momentaufnahme geändert wurden.

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Abrufen gültiger Seitenbereiche verwendet werden soll. Wenn keine Länge angegeben wird, werden alle Bytes nach dem Offset durchsucht. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Abrufen gültiger Seitenbereiche verwendet werden sollen. Wenn die Länge angegeben ist, muss ein Offset angegeben werden. Dieser Bereich gibt gültige Seitenbereiche vom Offsetstart bis zur angegebenen Länge zurück. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

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-blob-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 Tupel aus zwei Listen von Seitenbereichen als Wörterbücher mit den Tasten "start" und "end". Das erste Element sind gefüllte Seitenbereiche, das 2. Element wird aus Seitenbereichen gelöscht.

Rückgabetyp

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

VERALTET: Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder Momentaufnahme eines Seitenblobs zurück.

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

Parameter

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Abrufen gültiger Seitenbereiche verwendet werden soll. Wenn keine Länge angegeben wird, werden alle Bytes nach dem Offset durchsucht. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Abrufen gültiger Seitenbereiche verwendet werden sollen. Wenn die Länge angegeben ist, muss ein Offset angegeben werden. Dieser Bereich gibt gültige Seitenbereiche vom Offsetstart bis zur angegebenen Länge zurück. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

previous_snapshot_diff: str

Erforderlich

Der Momentaufnahme diff-Parameter, der einen undurchsichtigen DateTime-Wert enthält, der ein vorheriges Blob angibt, Momentaufnahme mit einem aktuelleren Momentaufnahme oder dem aktuellen Blob verglichen werden soll.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-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 Tupel aus zwei Listen von Seitenbereichen als Wörterbücher mit den Tasten "start" und "end". Das erste Element sind gefüllte Seitenbereiche, das 2. Element wird aus Seitenbereichen gelöscht.

Rückgabetyp

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

Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder Momentaufnahme eines Seitenblobs zurück. Wenn previous_snapshot angegeben ist, ist das Ergebnis eine diff von Änderungen zwischen dem Zielblob und dem vorherigen Momentaufnahme.

list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> ItemPaged[PageRange]

Parameter

offset: int

Anfang des Bytebereichs, der zum Abrufen gültiger Seitenbereiche verwendet werden soll. Wenn keine Länge angegeben wird, werden alle Bytes nach dem Offset durchsucht. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

length: int

Anzahl der Bytes, die zum Abrufen gültiger Seitenbereiche verwendet werden sollen. Wenn die Länge angegeben ist, muss ein Offset angegeben werden. Dieser Bereich gibt gültige Seitenbereiche vom Offsetstart bis zur angegebenen Länge zurück. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

previous_snapshot: str oder Dict[str, Any]

Ein Momentaufnahme-Wert, der angibt, dass die Antwort nur Seiten enthält, die zwischen Zielblob und vorherigen Momentaufnahme geändert wurden. Geänderte Seiten umfassen sowohl aktualisierte als auch gelöschte Seiten. Das Zielblob kann ein Momentaufnahme sein, solange die von previous_snapshot angegebene Momentaufnahme der ältere der beiden ist.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

results_per_page: int

Die maximale Anzahl von Seitenbereichen, die pro API-Aufruf abgerufen werden sollen.

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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Eine iterierbare (automatische Paging) von PageRange.

Rückgabetyp

ItemPaged[PageRange]

Ermöglicht Es Benutzern, blob-/oder blob-Momentaufnahme Daten auszuwählen/zu projektieren, indem sie einfache Abfrageausdrücke bereitstellen. Dieser Vorgang gibt einen BlobQueryReader zurück. Benutzer müssen readall() oder readinto() verwenden, um Abfragedaten abzurufen.

query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader

Parameter

query_expression: str

Erforderlich

Erforderlich. eine Abfrageanweisung. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error: Callable[BlobQueryError]

Eine Funktion, die bei allen vom Dienst zurückgegebenen Verarbeitungsfehlern aufgerufen werden soll.

blob_format: DelimitedTextDialect oder DelimitedJsonDialect oder QuickQueryDialect oder str

Optional. Definiert die Serialisierung der derzeit im Blob gespeicherten Daten. Standardmäßig werden die Blobdaten als CSV-Daten behandelt, die im Standarddialekt formatiert sind. Dies kann mit einem benutzerdefinierten DelimitedTextDialect oder delimitedJsonDialect oder "ParquetDialect" (übergeben als Zeichenfolge oder Enumeration) überschrieben werden. Diese Dialekte können über ihre jeweiligen Klassen, die QuickQueryDialect-Enume oder als Zeichenfolge übergeben werden.

output_format: DelimitedTextDialect oder DelimitedJsonDialect oder list[ArrowDialect] oder QuickQueryDialect oder str

Optional. Definiert die Ausgabeserialisierung für den Datenstrom. Standardmäßig werden die Daten zurückgegeben, wie sie im Blob dargestellt werden (Parquet-Formate sind standardmäßig DelimitedTextDialect). Durch Bereitstellen eines Ausgabeformats werden die Blobdaten entsprechend diesem Profil neu formatiert. Dieser Wert kann ein DelimitedTextDialect oder ein DelimitedJsonDialect oder ArrowDialect sein. Diese Dialekte können über ihre jeweiligen Klassen, die QuickQueryDialect-Enume oder als Zeichenfolge übergeben werden.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Ein Streamingobjekt (BlobQueryReader)

Rückgabetyp

BlobQueryReader

Ändert die Größe eines Seitenblob in die angegebene Größe.

Wenn der angegebene Wert kleiner als die aktuelle Größe des BLOB ist, werden alle Seiten über dem angegebenen Wert gelöscht.

resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]

Parameter

size: int

Erforderlich

Größe, die zum Ändern der Blobgröße verwendet wird. Die maximale Größe für ein Seitenblob beträgt bis zu 1 TB. Die Größe des Seitenblobs muss auf eine Begrenzung von 512 Bytes ausgerichtet werden.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Ein Seitenblobebenenwert, auf den das Blob festgelegt werden soll. Die Ebene korreliert mit der Größe des Blobs und der Anzahl der zulässigen IOPS. Dies gilt nur für Seitenblobs in Storage Premium-Konten.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

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

Rückgabetyp

dict(str, Any)

Der Seal-Vorgang versiegelt das Anfügeblob, um es schreibgeschützt zu machen.

Neu in Version 12.4.0.

seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]

Parameter

appendpos_condition: int

Optionaler bedingter Header, der nur für den Vorgang "Block anfügen" verwendet wird. Eine Zahl, die den zu vergleichenden Byteoffset angibt. Der Anfügeblock ist nur erfolgreich, wenn die Anfügeposition gleich dieser Zahl ist. Ist dies nicht der Fall, schlägt die Anforderung mit dem Fehler AppendPositionConditionNotMet (HTTP status Code 412 – Vorbedingung fehlgeschlagen) fehl.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag, zuletzt geändert, Offset anfügen, Anzahl der zugesagten Blocken).

Rückgabetyp

dict(str, Any)

Legt benutzerdefinierte Metadaten für das Blob als mindestens ein Name-Wert-Paar fest.

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

Parameter

metadata: dict(str, str)

Erforderlich

Dict, das Name- und Wertpaare enthält. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die an das BLOB angefügt sind. Um alle Metadaten aus dem BLOB zu entfernen, rufen Sie diesen Vorgang ohne Metadatenheader auf.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag und letzte Änderung)

Mit dem Vorgang Tags festlegen können Benutzer Tags für ein Blob oder eine bestimmte Blobversion festlegen, aber nicht Momentaufnahme. Jeder Aufruf dieses Vorgangs ersetzt alle vorhandenen Tags, die an das Blob angefügt sind. Um alle Tags aus dem Blob zu entfernen, rufen Sie diesen Vorgang ohne Festgelegte Tags auf.

Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.

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

Parameter

tags: dict(str, str)

Erforderlich

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und die Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), plus (+), Minus (-), Punkt (.), solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, wenn vorhanden, die Version des Blobs angibt, dem Tags hinzugefügt werden sollen.

validate_content: bool

Wenn true, berechnet ein MD5-Hash des Tagsinhalts. 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 http anstelle von https verwendet wird, da https (der Standardwert) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Zielblobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

lease: BlobLeaseClient oder str

Erforderlich, wenn das BLOB über eine aktive Lease verfügt. Der Wert kann ein BlobLeaseClient-Objekt oder die Lease-ID als Zeichenfolge 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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag und letzte Änderung)

Rückgabetyp

Dict[str, Any]

Legt Systemeigenschaften für den Blob fest.

Wenn eine Eigenschaft für die content_settings festgelegt ist, werden alle Eigenschaften überschrieben.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Parameter

content_settings: ContentSettings

Erforderlich

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

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag und letzte Änderung)

Rückgabetyp

Dict[str, Any]

Der Vorgang Unveränderlichkeitsrichtlinie festlegen legt die Unveränderlichkeitsrichtlinie für das Blob fest.

Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.

set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Parameter

immutability_policy: ImmutabilityPolicy

Erforderlich

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an.

Neu in Version 12.10.0: Dies 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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Schlüsselwertpaare von Blobtags.

Rückgabetyp

Dict[str, str]

Mit dem Vorgang Set Legal Hold wird ein rechtlicher Haltevorgang für das Blob festgelegt.

Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.

set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]

Parameter

legal_hold: bool

Erforderlich

Gibt an, ob ein gesetzlicher Halteraum für das Blob festgelegt werden soll.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Schlüsselwertpaare von Blobtags.

Rückgabetyp

Dict[str, Union[str, datetime, bool]]

Legt die Seitenblobebenen für das Blob fest. Diese API wird nur für Seitenblobs in Premium-Konten unterstützt.

set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Parameter

premium_page_blob_tier: PremiumPageBlobTier

Erforderlich

Ein Seitenblobebenenwert, auf den das Blob festgelegt werden soll. Die Ebene korreliert mit der Größe des Blobs und der Anzahl der zulässigen IOPS. Dies gilt nur für Seitenblobs in Storage Premium-Konten.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

lease: BlobLeaseClient oder str

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

Rückgabetyp

None

Legt die Blobsequenznummer fest.

set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parameter

sequence_number_action: str

Erforderlich

Diese Eigenschaft gibt an, wie der Dienst die Sequenznummer des BLOB ändern soll. Weitere Informationen finden Sie unter SequenceNumberAction.

sequence_number: str

Erforderlich

Diese Eigenschaft legt die Sequenznummer des BLOB fest. Die Sequenznummer ist eine vom Benutzer festgelegte Eigenschaft, die Sie verwenden können, um Anforderungen nachzuverfolgen und Parallelitätsprobleme zu verwalten.

lease: BlobLeaseClient oder str

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

Gibt zurück

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

Rückgabetyp

dict(str, Any)

Mit diesem Vorgang wird die Ebene für ein Blockblob festgelegt.

Die Ebene eines Blockblobs bestimmt den Speichertyp Hot/Cool/Archive. Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.

set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None

Parameter

standard_blob_tier: str oder StandardBlobTier

Erforderlich

Gibt die Ebene an, die für das Blob festgelegt werden soll. Zu den Optionen gehören "Heiß", "Cool", "Archiv". Die heiße Ebene ist für das Speichern von Daten optimiert, auf die häufig zugegriffen wird. Die kühle Speicherebene ist für das Speichern von Daten optimiert, auf die selten zugegriffen und mindestens einen Monat lang gespeichert wird. Die Archivebene ist für das Speichern von Daten optimiert, auf die selten zugegriffen und mindestens sechs Monate lang mit flexiblen Latenzanforderungen gespeichert wird.

rehydrate_priority: RehydratePriority

Gibt die Priorität an, mit der ein archiviertes Blob rehydriert werden soll.

version_id: str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, wenn vorhanden, die Version des herunterzuladenden Blobs angibt.

Neu in Version 12.4.0.

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

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

timeout: int

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

lease: BlobLeaseClient oder str

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

Rückgabetyp

None

Erstellt einen neuen Block, für den ein Commit als Teil eines BLOB ausgeführt werden soll.

stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> Dict[str, Any]

Parameter

block_id: str

Erforderlich

Ein Zeichenfolgenwert, der den Block identifiziert. Die Zeichenfolge sollte kleiner oder gleich 64 Bytes sein. Für ein bestimmtes Blob muss die block_id für jeden Block die gleiche Größe aufweisen.

data

Erforderlich

Die Blobdaten.

length: int

Erforderlich

Größe des Blocks.

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 http anstelle von https verwendet wird, da https (der Standardwert) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird. Beachten Sie außerdem, dass der speichereffiziente Uploadalgorithmus bei Aktivierung nicht verwendet wird, da die Berechnung des MD5-Hashs das Puffern ganzer Blöcke erfordert und dadurch den Zweck des speichereffizienten Algorithmus vereitet.

lease: BlobLeaseClient oder str

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

encoding: str

Standardmäßig wird UTF-8 verwendet.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

Gibt zurück

Blob-Eigenschaftsdikt.

Rückgabetyp

dict[str, Any]

Erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem die Inhalte aus einer URL gelesen werden.

stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> Dict[str, Any]

Parameter

block_id: str

Erforderlich

Ein Zeichenfolgenwert, der den Block identifiziert. Die Zeichenfolge sollte kleiner oder gleich 64 Bytes sein. Für ein bestimmtes Blob muss die block_id für jeden Block die gleiche Größe aufweisen.

source_url: str

Erforderlich

Die URL.

source_offset: int

Erforderlich

Beginn des Bytebereichs, der für den Block verwendet werden soll. Muss festgelegt werden, wenn die Quelllänge angegeben wird.

source_length: int

Erforderlich

Die Größe des Blocks in Bytes.

source_content_md5: bytearray

Erforderlich

Geben Sie den md5 an, der für den Bytebereich berechnet wird, der aus der Kopierquelle gelesen werden muss.

lease: BlobLeaseClient oder str

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

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

source_authorization: str

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

Gibt zurück

Blob-Eigenschaftsdikt.

Rückgabetyp

dict[str, Any]

Kopiert ein Blob aus der angegebenen URL.

Dieser Vorgang gibt ein Wörterbuch zurück, das copy_status und copy_id enthält, mit denen die status des Kopiervorgangs überprüft oder abgebrochen werden kann. copy_status ist "erfolgreich", wenn die Kopie synchron abgeschlossen wurde, oder "ausstehend", wenn die Kopie asynchron gestartet wurde. Bei asynchronen Kopien kann die status überprüft werden, indem Sie die get_blob_properties -Methode abfragen und die kopierbasierte status überprüfen. Legen Sie requires_sync auf True fest, um zu erzwingen, dass die Kopie synchron ist. Der Blob-Dienst kopiert BLOBs auf Grundlage der besten Leistung.

Das Quellblob für einen Kopiervorgang kann ein Blockblob, ein Anfügeblob oder ein Seitenblob sein. Wenn das Zielblob bereits vorhanden ist, muss es von demselben Blobtyp wie das Quellblob sein. Ein eventuell vorhandenes Zielblob wird überschrieben. Das Ziel-BLOB kann nicht geändert werden, während ein Kopiervorgang ausgeführt wird.

Beim Kopieren aus einem Seitenblob erstellt der Blobdienst ein Zielseitenblob der Länge des Quellblobs, das zunächst alle Nullen enthält. Anschließend werden die Quellseitenbereiche aufgezählt, und nicht leere Bereiche werden kopiert.

Für ein Blockblob oder ein Anfügeblob erstellt der Blob-Dienst ein committetes Blob mit der Länge null, bevor er von diesem Vorgang zurückgibt. Beim Kopieren aus einem Blockblob werden alle gebundenen Blöcke und ihre Block-IDs kopiert. Nicht festgeschriebene Blöcke werden nicht kopiert. Am Ende des Kopiervorgangs weist das Zielblob die gleiche Anzahl von Commits wie die Quelle auf.

Beim Kopieren aus einem Anfügeblob werden alle gebundenen Blöcke kopiert. Am Ende des Kopiervorgangs weist das Zielblob die gleiche Anzahl von Commits wie die Quelle auf.

start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]

Parameter

source_url: str

Erforderlich

Eine URL mit einer Länge von bis zu 2 KB, die eine Datei oder ein Blob angibt. Der Wert sollte so URL-codiert sein, wie er in einem Anforderungs-URI verwendet wird. Wenn sich die Quelle in einem anderen Konto befindet, muss die Quelle entweder öffentlich sein oder über eine Shared Access Signature authentifiziert werden. Wenn die Quelle öffentlich ist, ist keine Authentifizierung erforderlich. Beispiele: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? Momentaufnahme=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata: dict(str, str)

Erforderlich

Name-Wert-Paare, die dem BLOB als Metadaten zugeordnet sind. Wenn keine Name-Wert-Paare angegeben werden, kopiert der Vorgang die Metadaten aus dem Quellblob oder der Quelldatei in das Zielblob. Wenn mindestens ein Name-Wert-Paar angegeben wird, wird das Zielblob mit den angegebenen Metadaten erstellt, und Metadaten werden nicht aus dem Quellblob oder der Quelldatei kopiert.

incremental_copy: bool

Erforderlich

Kopiert die Momentaufnahme des Quellseitenblobs in ein Zielseitenblob. Die Momentaufnahme wird so kopiert, dass nur die differenziellen Änderungen zwischen den zuvor kopierten Momentaufnahme an das Ziel übertragen werden. Die kopierten Momentaufnahmen sind vollständige Kopien der ursprünglichen Momentaufnahme und können wie gewohnt gelesen oder kopiert werden. Der Standardwert lautet „False“.

tags: dict(str, str) oder Literal["COPY"]

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und die Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), plus (+), Minus (-), Punkt (.), solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_).

Das Literal "COPY" (groß-/klein) kann stattdessen übergeben werden, um Tags aus dem Quellblob zu kopieren. Diese Option ist nur verfügbar, wenn incremental_copy=False und requires_sync=True.

Neu in Version 12.4.0.

immutability_policy: ImmutabilityPolicy

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

legal_hold: bool

Gibt an, ob ein gesetzlicher Halteraum für das Blob festgelegt werden soll.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

source_if_modified_since: datetime

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

source_if_unmodified_since: datetime

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

source_etag: str

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

source_match_condition: MatchConditions

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

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen bedingten Header an, um das BLOB nur dann zu kopieren, wenn das Ziel-BLOB seit dem angegebenen Datum bzw. der angegebenen Uhrzeit geändert wurde. Wenn das Ziel-BLOB nicht geändert wurde, gibt der Blob-Dienst Statuscode 412 (Vorbedingung nicht erfüllt) zurück.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen bedingten Header an, um das BLOB nur dann zu kopieren, wenn das Ziel-BLOB seit dem angegebenen Datum bzw. der angegebenen Uhrzeit nicht geändert wurde. Wenn das Ziel-BLOB geändert wurde, gibt der Blob-Dienst Statuscode 412 (Vorbedingung nicht erfüllt) zurück.

etag: str

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

match_condition: MatchConditions

Die Ziel-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

destination_lease: BlobLeaseClient oder str

Die für diesen Header angegebene Lease-ID muss mit der Lease-ID des Ziel-BLOB übereinstimmen. Wenn die Anforderung nicht die Lease-ID enthält oder diese ungültig ist, schlägt der Vorgang mit Statuscode 412 (Vorbedingung nicht erfüllt) fehl.

source_lease: BlobLeaseClient oder str

Geben Sie dies an, um den Kopierblobvorgang nur auszuführen, wenn die angegebene Lease-ID mit der aktiven Lease-ID des Quellblobs übereinstimmt.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

premium_page_blob_tier: PremiumPageBlobTier

Ein Seitenblobebenenwert, auf den das Blob festgelegt werden soll. Die Ebene korreliert mit der Größe des Blobs und der Anzahl der zulässigen IOPS. Dies gilt nur für Seitenblobs in Storage Premium-Konten.

standard_blob_tier: StandardBlobTier

Ein Standardblobebenenwert, auf den das Blob festgelegt werden soll. Für diese Version der Bibliothek gilt dies nur für Blockblobs in Standardspeicherkonten.

rehydrate_priority: RehydratePriority

Gibt die Priorität an, mit der ein archiviertes Blob rehydriert werden soll.

seal_destination_blob: bool

Versiegeln Sie das Zielanfügeblob. Dieser Vorgang gilt nur für Anfügeblob.

Neu in Version 12.4.0.

requires_sync: bool

Erzwingt, dass der Dienst erst dann eine Antwort zurückgibt, wenn die Kopie abgeschlossen ist.

source_authorization: str

Authentifizieren Sie sich als Dienstprinzipal mithilfe eines geheimen Clientschlüssels für den Zugriff auf ein Quellblob. Stellen Sie sicher, dass "Bearer" das Präfix der source_authorization Zeichenfolge ist. Diese Option ist nur verfügbar, wenn incremental_copy auf False und requires_sync auf True festgelegt ist.

Neu in Version 12.9.0.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im kopierten Synchronisierungsblob verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.10.0.

Gibt zurück

Ein Wörterbuch der Kopiereigenschaften (etag, last_modified, copy_id, copy_status).

Rückgabetyp

dict[str, Union[str, datetime]]

Stellt vorläufig gelöschte Blobs oder Momentaufnahmen wieder her.

Der Vorgang ist nur erfolgreich, wenn er innerhalb der angegebenen Anzahl von Tagen verwendet wird, die in der Aufbewahrungsrichtlinie für Löschvorgänge festgelegt ist.

Wenn die Blobversionsverwaltung aktiviert ist, kann das Basisblob mit dieser Methode nicht wiederhergestellt werden. Verwenden Sie start_copy_from_url stattdessen die URL der Blobversion, die Sie auf die aktuelle Version heraufstufen möchten.

undelete_blob(**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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

None

Erstellt ein neues Blob aus einer Datenquelle mit automatischem Blocking.

upload_blob(data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, Any]

Parameter

data

Erforderlich

Die hochzuladenden Blobdaten.

blob_type: BlobType

Erforderlich

Der Typ des Blobs. Dies kann entweder BlockBlob, PageBlob oder AppendBlob sein. Der Standardwert ist BlockBlob.

length: int

Erforderlich

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

metadata: dict(str, str)

Erforderlich

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

tags: dict(str, str)

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und die Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), plus (+), Minus (-), Punkt (.), solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

Neu in Version 12.4.0.

overwrite: bool

Gibt an, ob das hochzuladende Blob die aktuellen Daten überschreiben soll. Bei True überschreibt upload_blob die vorhandenen Daten. Wenn auf False festgelegt ist, schlägt der Vorgang mit ResourceExistsError fehl. Die Ausnahme von oben besteht bei Anfügeblobtypen: Wenn auf False festgelegt ist und die Daten bereits vorhanden sind, wird kein Fehler ausgelöst, und die Daten werden an das vorhandene Blob angefügt. Wenn set overwrite=True, wird das vorhandene Anfügeblob gelöscht und ein neues erstellt. Der Standardwert lautet „False“.

content_settings: ContentSettings

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

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 http anstelle von https verwendet wird, da https (der Standardwert) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird. Beachten Sie außerdem, dass der speichereffiziente Uploadalgorithmus bei Aktivierung nicht verwendet wird, da die Berechnung des MD5-Hashs das Puffern ganzer Blöcke erfordert und dadurch den Zweck des speichereffizienten Algorithmus vereitet.

lease: BlobLeaseClient oder str

Erforderlich, wenn das BLOB über eine aktive Lease verfügt. Wenn angegeben, ist upload_blob nur erfolgreich, wenn die Lease des Blobs aktiv ist und dieser ID entspricht. Der Wert kann ein BlobLeaseClient-Objekt oder die Lease-ID als Zeichenfolge sein.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Ein Seitenblobebenenwert, auf den das Blob festgelegt werden soll. Die Ebene korreliert mit der Größe des Blobs und der Anzahl der zulässigen IOPS. Dies gilt nur für Seitenblobs in Storage Premium-Konten.

standard_blob_tier: StandardBlobTier

Ein Standardblobebenenwert, auf den das Blob festgelegt werden soll. Für diese Version der Bibliothek gilt dies nur für Blockblobs in Standardspeicherkonten.

immutability_policy: ImmutabilityPolicy

Gibt die Unveränderlichkeitsrichtlinie eines Blobs, eines Blobs Momentaufnahme oder einer Blobversion an. Derzeit gilt dieser Parameter der upload_blob()-API nur für BlockBlob.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

legal_hold: bool

Gibt an, ob ein gesetzlicher Halteraum für das Blob festgelegt werden soll. Derzeit gilt dieser Parameter der upload_blob()-API nur für BlockBlob.

Neu in Version 12.10.0: Dies wurde in der API-Version "2020-10-02" eingeführt.

maxsize_condition: int

Optionaler bedingter Header. Die maximale Länge in Bytes, die für das Anfügeblob zulässig ist. Wenn der Vorgang Block anfügen dazu führt, dass das Blob diesen Grenzwert überschreitet oder die Blobgröße bereits größer als der in diesem Header angegebene Wert ist, schlägt die Anforderung mit dem Fehler MaxBlobSizeConditionNotMet (HTTP-status Code 412 – Vorbedingung fehlgeschlagen) fehl.

max_concurrency: int

Maximale Anzahl paralleler Verbindungen, die verwendet werden sollen, wenn die Blobgröße 64 MB überschreitet.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung der vom Kunden bereitgestellten Schlüssel muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung angegeben wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier mit dem Namen referenziert werden. Wenn im Container ein Standardverschlüsselungsbereich definiert wurde, überschreibt ihn dieser Wert, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

encoding: str

Standardmäßig wird UTF-8 verwendet.

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-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier. Diese Methode kann mehrere Aufrufe an den Dienst ausführen, und das Timeout gilt für jeden Aufruf einzeln.

Gibt zurück

Blob-aktualisierte Eigenschaftsdikt (Etag und letzte Änderung)

Rückgabetyp

dict[str, Any]

Erstellt ein neues Blockblob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Der Inhalt eines vorhandenen Blobs wird mit dem neuen Blob überschrieben.

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

Parameter

source_url: str

Erforderlich

Eine URL mit einer Länge von bis zu 2 KB, die eine Datei oder ein Blob angibt. Der Wert sollte so URL-codiert sein, wie er in einem Anforderungs-URI verwendet wird. Wenn sich die Quelle in einem anderen Konto befindet, muss die Quelle entweder öffentlich sein oder über eine Shared Access Signature authentifiziert werden. Wenn die Quelle öffentlich ist, ist keine Authentifizierung erforderlich. Beispiele: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? Momentaufnahme=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

overwrite: bool

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

include_source_blob_properties: bool

Gibt an, ob Eigenschaften aus dem Quellblob kopiert werden sollen. Der Standardwert ist „True“.

tags: dict(str, str)

Name-Wert-Paare, die dem Blob als Tag zugeordnet sind. Bei Tags wird die Groß-/Kleinschreibung beachtet. Der Tagsatz darf höchstens 10 Tags enthalten. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein, und Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind: Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen ( >><<), Pluszeichen (+), Minuszeichen (-), Punkt (.), Solidus (/), Doppelpunkt (:), gleich (=), Unterstrich (_)

source_content_md5: bytearray

Geben Sie den md5 an, der verwendet wird, um die Integrität der Quellbytes zu überprüfen.

source_if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit dem angegebenen Zeitpunkt geändert wurde.

source_if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

source_etag: str

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

source_match_condition: MatchConditions

Die Quell-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Ziel-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

destination_lease: BlobLeaseClient oder str

Die für diesen Header angegebene Lease-ID muss mit der Lease-ID des Ziel-BLOB übereinstimmen. Wenn die Anforderung nicht die Lease-ID enthält oder diese ungültig ist, schlägt der Vorgang mit Statuscode 412 (Vorbedingung nicht erfüllt) fehl.

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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

content_settings: ContentSettings

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

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

standard_blob_tier: StandardBlobTier

Ein Standard-Blobebenenwert, auf den das Blob festgelegt werden soll. Für diese Version der Bibliothek gilt dies nur für Blockblobs in Standardspeicherkonten.

source_authorization: str

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

Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob.

upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]

Parameter

page: bytes

Erforderlich

Inhalt der Seite.

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Schreiben in einen Abschnitt des Blobs verwendet werden soll. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Schreiben in einen Abschnitt des Blobs verwendet werden sollen. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

lease: BlobLeaseClient oder str

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

validate_content: bool

Wenn true, berechnet einen MD5-Hash des Seiteninhalts. Der Speicherdienst überprüft den Hash des Inhalts, der mit dem gesendeten Hash eingetroffen ist. Dies ist in erster Linie für die Erkennung von Bitflips im Netzwerk nützlich, wenn http anstelle von https verwendet wird, da https (standard) bereits überprüft wird. Beachten Sie, dass dieser MD5-Hash nicht mit dem BLOB gespeichert wird.

if_sequence_number_lte: int

Wenn die Sequenznummer des Blobs kleiner oder gleich dem angegebenen Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_lt: int

Wenn die Sequenznummer des Blobs kleiner als der angegebene Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_eq: int

Wenn die Sequenznummer des Blobs dem angegebenen Wert entspricht, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

encoding: str

Der Standardwert ist UTF-8.

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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Blob-aktualisierte Eigenschaftsdict (Etag und letzte Änderung).

Rückgabetyp

dict(str, Any)

Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob, in dem der Inhalt aus einer URL gelesen wird.

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

Parameter

source_url: str

Erforderlich

Die URL der Quelldaten. Sie kann auf ein beliebiges Azure-Blob oder eine Beliebige Datei verweisen, die entweder öffentlich ist oder eine Shared Access Signature angefügt ist.

offset: int

Erforderlich

Anfang des Bytebereichs, der zum Schreiben in einen Abschnitt des Blobs verwendet werden soll. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

length: int

Erforderlich

Anzahl der Bytes, die zum Schreiben in einen Abschnitt des Blobs verwendet werden sollen. Seiten müssen an 512-Byte-Grenzen ausgerichtet sein, der Startoffset muss ein Modulus von 512 und die Länge muss ein Modulus von 512 sein.

source_offset: int

Erforderlich

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

source_content_md5: bytes

Wenn angegeben, berechnet der Dienst den MD5-Hash des Blockinhalts und vergleicht mit diesem Wert.

source_if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit dem angegebenen Zeitpunkt geändert wurde.

source_if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Geben Sie diesen Header an, um den Vorgang nur auszuführen, wenn die Quellressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

source_etag: str

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

source_match_condition: MatchConditions

Die Quell-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

lease: BlobLeaseClient oder str

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

if_sequence_number_lte: int

Wenn die Sequenznummer des Blobs kleiner oder gleich dem angegebenen Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_lt: int

Wenn die Sequenznummer des Blobs kleiner als der angegebene Wert ist, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_sequence_number_eq: int

Wenn die Sequenznummer des Blobs dem angegebenen Wert entspricht, wird die Anforderung fortgesetzt. Andernfalls tritt ein Fehler auf.

if_modified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since: datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimen, die nicht utc sind, in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag: str

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

match_condition: MatchConditions

Die Ziel-Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition: str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Verschlüsselt die Daten auf der Dienstseite mit dem angegebenen Schlüssel. Die Verwendung von kundenseitig bereitgestellten Schlüsseln muss über HTTPS erfolgen. Da der Verschlüsselungsschlüssel selbst in der Anforderung bereitgestellt wird, muss eine sichere Verbindung hergestellt werden, um den Schlüssel zu übertragen.

encryption_scope: str

Ein vordefinierter Verschlüsselungsbereich, der zum Verschlüsseln der Daten im Dienst verwendet wird. Ein Verschlüsselungsbereich kann mithilfe der Verwaltungs-API erstellt und hier anhand des Namens referenziert werden. Wenn ein Standardverschlüsselungsbereich für den Container definiert wurde, überschreibt dieser Wert ihn, wenn der Bereich auf Containerebene so konfiguriert ist, dass Außerkraftsetzungen zugelassen werden. Andernfalls wird ein Fehler ausgelöst.

Neu in Version 12.2.0.

timeout: int

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

source_authorization: str

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

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

Der Standortmodus, den der Client derzeit verwendet.

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

Die vollständige URL des primären Endpunkts.

Der Hostname des primären Endpunkts.

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

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.

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

abort_copy	Abbrechen eines laufenden Kopiervorgangs. Dadurch bleibt ein Zielblob mit der Länge null und den vollständigen Metadaten erhalten. Dadurch wird ein Fehler ausgelöst, wenn der Kopiervorgang bereits beendet wurde.
acquire_lease	Fordert eine neue Lease an. Wenn das Blob keine aktive Lease aufweist, erstellt der Blobdienst eine Lease für das Blob und gibt eine neue Lease zurück.
append_block	Committ einen neuen Datenblock an das Ende des vorhandenen Anfügeblobs.
append_block_from_url	Erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem der Inhalt aus einer Quell-URL gelesen wird.
clear_page	Löscht einen Seitenbereich.
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.
commit_block_list	Der Vorgang Commit-Blockliste schreibt ein Blob, indem die Liste der Block-IDs angegeben wird, aus denen das Blob besteht.
create_append_blob	Erstellt ein neues Anfügeblob. Mit diesem Vorgang wird ein neues Anfügeblob mit 0 Länge erstellt. Der Inhalt eines vorhandenen Blobs wird mit dem neu initialisierten Anfügeblob überschrieben. Um dem Anfügeblob Inhalte hinzuzufügen, rufen Sie die - oder append_block_from_url -append_blockMethode auf.
create_page_blob	Erstellt ein neues Seitenblob der angegebenen Größe.
create_snapshot	Erstellt eine Momentaufnahme des Blobs. Eine Momentaufnahme ist eine schreibgeschützte Version eines Blobs, die zu einem bestimmten Zeitpunkt erstellt wird. Sie kann gelesen, kopiert oder gelöscht, aber nicht geändert werden. Momentaufnahmen bieten eine Möglichkeit, um ein Blob so zu sichern, wie es zu einem bestimmten Zeitpunkt dargestellt wird. Ein Momentaufnahme eines Blobs hat denselben Namen wie das Basisblob, von dem das Momentaufnahme genommen wird, wobei ein DateTime-Wert angefügt wird, um die Uhrzeit anzugeben, zu der die Momentaufnahme genommen wurde.
delete_blob	Markiert das angegebene BLOB zum Löschen. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang delete_blob() löschen. Wenn eine Aufbewahrungsrichtlinie für das Löschen für den Dienst aktiviert ist, löscht dieser Vorgang das Blob vorläufig und behält das Blob für eine angegebene Anzahl von Tagen bei. Nach der angegebenen Anzahl von Tagen werden die Daten des Blobs während der Garbage Collection aus dem Dienst entfernt. Auf vorläufig gelöschtes Blob kann über list_blobs die Option include=['deleted'] zugegriffen werden. Vorläufig gelöschtes Blob kann mithilfe eines Vorgangs <xref:azure.storage.blob.undelete> wiederhergestellt werden.
delete_immutability_policy	Der Vorgang Unveränderlichkeitsrichtlinie löschen löscht die Unveränderlichkeitsrichtlinie für das Blob. Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.
download_blob	Lädt ein Blob in storageStreamDownloader herunter. Die readall()-Methode muss verwendet werden, um den gesamten Inhalt zu lesen, oder readinto() muss verwendet werden, um das Blob in einen Stream herunterzuladen. Die Verwendung von chunks() gibt einen Iterator zurück, der es dem Benutzer ermöglicht, den Inhalt in Blöcken zu durchlaufen.
exists	Gibt True zurück, wenn ein Blob mit den definierten Parametern vorhanden ist, und gibt andernfalls False zurück.
from_blob_url	Erstellen Sie BlobClient aus einer Blob-URL. Dies unterstützt keine angepasste Blob-URL mit "/" im Blobnamen.
from_connection_string	Erstellen Sie BlobClient aus einer Verbindungszeichenfolge.
get_account_information	Ruft Informationen im Zusammenhang mit dem Speicherkonto ab, in dem sich das Blob befindet. Die Informationen können auch abgerufen werden, wenn der Benutzer über eine SAS für einen Container oder ein Blob verfügt. Die Schlüssel im zurückgegebenen Wörterbuch enthalten "sku_name" und "account_kind".
get_blob_properties	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für das BLOB zurück. Der Inhalt des BLOB wird nicht zurückgegeben.
get_blob_tags	Mit dem Vorgang Tags abrufen können Benutzer Tags für ein Blob oder eine bestimmte Blobversion oder Momentaufnahme abrufen. Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.
get_block_list	Der Vorgang Blockliste abrufen ruft die Liste der Blöcke ab, die als Teil eines Blockblobs hochgeladen wurden.
get_page_range_diff_for_managed_disk	Gibt die Liste der gültigen Seitenbereiche für einen verwalteten Datenträger oder Momentaufnahme zurück. Hinweis Dieser Vorgang ist nur für Verwaltete Datenträgerkonten verfügbar. Neu in Version 12.2.0: Dieser Vorgang wurde in der API-Version "2019-07-07" eingeführt.
get_page_ranges	VERALTET: Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder Momentaufnahme eines Seitenblobs zurück.
list_page_ranges	Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder Momentaufnahme eines Seitenblobs zurück. Wenn previous_snapshot angegeben ist, ist das Ergebnis eine diff von Änderungen zwischen dem Zielblob und dem vorherigen Momentaufnahme.
query_blob	Ermöglicht Es Benutzern, blob-/oder blob-Momentaufnahme Daten auszuwählen/zu projektieren, indem sie einfache Abfrageausdrücke bereitstellen. Dieser Vorgang gibt einen BlobQueryReader zurück. Benutzer müssen readall() oder readinto() verwenden, um Abfragedaten abzurufen.
resize_blob	Ändert die Größe eines Seitenblob in die angegebene Größe. Wenn der angegebene Wert kleiner als die aktuelle Größe des BLOB ist, werden alle Seiten über dem angegebenen Wert gelöscht.
seal_append_blob	Der Seal-Vorgang versiegelt das Anfügeblob, um es schreibgeschützt zu machen. Neu in Version 12.4.0.
set_blob_metadata	Legt benutzerdefinierte Metadaten für das Blob als mindestens ein Name-Wert-Paar fest.
set_blob_tags	Mit dem Vorgang Tags festlegen können Benutzer Tags für ein Blob oder eine bestimmte Blobversion festlegen, aber nicht Momentaufnahme. Jeder Aufruf dieses Vorgangs ersetzt alle vorhandenen Tags, die an das Blob angefügt sind. Um alle Tags aus dem Blob zu entfernen, rufen Sie diesen Vorgang ohne Festgelegte Tags auf. Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.
set_http_headers	Legt Systemeigenschaften für den Blob fest. Wenn eine Eigenschaft für die content_settings festgelegt ist, werden alle Eigenschaften überschrieben.
set_immutability_policy	Der Vorgang Unveränderlichkeitsrichtlinie festlegen legt die Unveränderlichkeitsrichtlinie für das Blob fest. Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.
set_legal_hold	Mit dem Vorgang Set Legal Hold wird ein rechtlicher Haltevorgang für das Blob festgelegt. Neu in Version 12.10.0: Dieser Vorgang wurde in der API-Version "2020-10-02" eingeführt.
set_premium_page_blob_tier	Legt die Seitenblobebenen für das Blob fest. Diese API wird nur für Seitenblobs in Premium-Konten unterstützt.
set_sequence_number	Legt die Blobsequenznummer fest.
set_standard_blob_tier	Mit diesem Vorgang wird die Ebene für ein Blockblob festgelegt. Die Ebene eines Blockblobs bestimmt den Speichertyp Hot/Cool/Archive. Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.
stage_block	Erstellt einen neuen Block, für den ein Commit als Teil eines BLOB ausgeführt werden soll.
stage_block_from_url	Erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem die Inhalte aus einer URL gelesen werden.
start_copy_from_url	Kopiert ein Blob aus der angegebenen URL. Dieser Vorgang gibt ein Wörterbuch zurück, das copy_status und copy_id enthält, mit denen die status des Kopiervorgangs überprüft oder abgebrochen werden kann. copy_status ist "erfolgreich", wenn die Kopie synchron abgeschlossen wurde, oder "ausstehend", wenn die Kopie asynchron gestartet wurde. Bei asynchronen Kopien kann die status überprüft werden, indem Sie die get_blob_properties -Methode abfragen und die kopierbasierte status überprüfen. Legen Sie requires_sync auf True fest, um zu erzwingen, dass die Kopie synchron ist. Der Blob-Dienst kopiert BLOBs auf Grundlage der besten Leistung. Das Quellblob für einen Kopiervorgang kann ein Blockblob, ein Anfügeblob oder ein Seitenblob sein. Wenn das Zielblob bereits vorhanden ist, muss es von demselben Blobtyp wie das Quellblob sein. Ein eventuell vorhandenes Zielblob wird überschrieben. Das Ziel-BLOB kann nicht geändert werden, während ein Kopiervorgang ausgeführt wird. Beim Kopieren aus einem Seitenblob erstellt der Blobdienst ein Zielseitenblob der Länge des Quellblobs, das zunächst alle Nullen enthält. Anschließend werden die Quellseitenbereiche aufgezählt, und nicht leere Bereiche werden kopiert. Für ein Blockblob oder ein Anfügeblob erstellt der Blob-Dienst ein committetes Blob mit der Länge null, bevor er von diesem Vorgang zurückgibt. Beim Kopieren aus einem Blockblob werden alle gebundenen Blöcke und ihre Block-IDs kopiert. Nicht festgeschriebene Blöcke werden nicht kopiert. Am Ende des Kopiervorgangs weist das Zielblob die gleiche Anzahl von Commits wie die Quelle auf. Beim Kopieren aus einem Anfügeblob werden alle gebundenen Blöcke kopiert. Am Ende des Kopiervorgangs weist das Zielblob die gleiche Anzahl von Commits wie die Quelle auf.
undelete_blob	Stellt vorläufig gelöschte Blobs oder Momentaufnahmen wieder her. Der Vorgang ist nur erfolgreich, wenn er innerhalb der angegebenen Anzahl von Tagen verwendet wird, die in der Aufbewahrungsrichtlinie für Löschvorgänge festgelegt ist. Wenn die Blobversionsverwaltung aktiviert ist, kann das Basisblob mit dieser Methode nicht wiederhergestellt werden. Verwenden Sie start_copy_from_url stattdessen die URL der Blobversion, die Sie auf die aktuelle Version heraufstufen möchten.
upload_blob	Erstellt ein neues Blob aus einer Datenquelle mit automatischem Blocking.
upload_blob_from_url	Erstellt ein neues Blockblob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Der Inhalt eines vorhandenen Blobs wird mit dem neuen Blob überschrieben.
upload_page	Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob.
upload_pages_from_url	Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob, in dem der Inhalt aus einer URL gelesen wird.

Share via

BlobClient Klasse

Konstruktor

Parameter

Methoden

abort_copy

Parameter

Rückgabetyp

acquire_lease

Parameter

Gibt zurück

Rückgabetyp

append_block

Parameter

Gibt zurück

Rückgabetyp

append_block_from_url

Parameter

clear_page

Parameter

Gibt zurück

Rückgabetyp

close

commit_block_list

Parameter

Gibt zurück

Rückgabetyp

create_append_blob

Parameter

Gibt zurück

Rückgabetyp

create_page_blob

Parameter

Gibt zurück

Rückgabetyp

create_snapshot

Parameter

Gibt zurück

Rückgabetyp

delete_blob

Parameter

Rückgabetyp

delete_immutability_policy

Parameter

Gibt zurück

Rückgabetyp

download_blob

Parameter

Gibt zurück

Rückgabetyp

exists

Parameter

Gibt zurück

Rückgabetyp

from_blob_url

Parameter

Gibt zurück

Rückgabetyp

from_connection_string

Parameter

Gibt zurück

Rückgabetyp

get_account_information

Gibt zurück

Rückgabetyp

get_blob_properties

Parameter

Gibt zurück

Rückgabetyp

get_blob_tags

Parameter

Gibt zurück

Rückgabetyp

get_block_list

Parameter

Gibt zurück

Rückgabetyp

get_page_range_diff_for_managed_disk

Parameter

Gibt zurück