Share via


ContainerClient Klas

Een client voor interactie met een specifieke container, hoewel die container mogelijk nog niet bestaat.

Voor bewerkingen met betrekking tot een specifieke blob in deze container kan een blobclient worden opgehaald met behulp van de get_blob_client functie.

Klik hier voor meer optionele configuratie.

Overname
azure.storage.blob._shared.base_client.StorageAccountHostsMixin
ContainerClient
azure.storage.blob._encryption.StorageEncryptionMixin
ContainerClient

Constructor

ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parameters

account_url
str
Vereist

De URI naar het opslagaccount. Als u een client wilt maken die de volledige URI aan de container heeft gegeven, gebruikt u de from_container_url klassemethode.

container_name
str
Vereist

De naam van de container voor de blob.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor het account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

  • behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.
api_version
str

De storage-API-versie die moet worden gebruikt voor aanvragen. De standaardwaarde is de meest recente serviceversie die compatibel is met de huidige SDK. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies.

Nieuw in versie 12.2.0.

secondary_hostname
str

De hostnaam van het secundaire eindpunt.

max_block_size
int

De maximale segmentgrootte voor het uploaden van een blok-blob in segmenten. De standaardinstelling is 4*1024*1024 of 4 MB.

max_single_put_size
int

Als de blobgrootte kleiner is dan of gelijk is aan max_single_put_size, wordt de blob geüpload met slechts één HTTP PUT-aanvraag. Als de blob groter is dan max_single_put_size, wordt de blob in segmenten geüpload. De standaardwaarde is 64*1024*1024 of 64 MB.

min_large_block_upload_threshold
int

De minimale segmentgrootte die is vereist om het geheugenefficiënte algoritme te gebruiken bij het uploaden van een blok-blob. De standaardinstelling is 4*1024*1024+1.

use_byte_buffer
bool

Gebruik een bytebuffer voor blok-blob-uploads. Standaard ingesteld op False.

max_page_size
int

De maximale segmentgrootte voor het uploaden van een pagina-blob. De standaardinstelling is 4*1024*1024 of 4 MB.

max_single_get_size
int

De maximale grootte voor een blob die in één aanroep moet worden gedownload, het overschreden gedeelte wordt in segmenten gedownload (kan parallel zijn). De standaardwaarde is 32*1024*1024 of 32 MB.

max_chunk_get_size
int

De maximale segmentgrootte die wordt gebruikt voor het downloaden van een blob. De standaardinstelling is 4*1024*1024 of 4 MB.

Methoden

acquire_lease

Vraagt een nieuwe lease aan. Als de container geen actieve lease heeft, maakt de Blob-service een lease voor de container en retourneert een nieuwe lease-id.

close

Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder.

create_container

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, mislukt de bewerking.

delete_blob

Hiermee markeert u de opgegeven blob of momentopname voor verwijdering.

De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking delete_blob.

Als een bewaarbeleid voor verwijderen is ingeschakeld voor de service, wordt met deze bewerking de blob of momentopname voorlopig verwijderd en wordt de blob of momentopname bewaard gedurende het opgegeven aantal dagen. Na het opgegeven aantal dagen worden de gegevens van de blob verwijderd uit de service tijdens garbagecollection. Voorlopig verwijderde blob of momentopname is toegankelijk via list_blobs de optie include=["deleted"]. Voorlopig verwijderde blob of momentopname kan worden hersteld met behulp van <xref:azure.storage.blob.BlobClient.undelete>

delete_blobs

Markeert de opgegeven blobs of momentopnamen voor verwijdering.

De blobs worden later verwijderd tijdens de garbagecollection. Als u blobs wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de delete_blobs bewerking.

Als een bewaarbeleid voor verwijderen is ingeschakeld voor de service, worden met deze bewerking de blobs of momentopnamen voorlopig verwijderd en worden de blobs of momentopnamen gedurende het opgegeven aantal dagen bewaard. Na het opgegeven aantal dagen worden de gegevens van blobs verwijderd uit de service tijdens de garbagecollection. Voorlopig verwijderde blobs of momentopnamen zijn toegankelijk via list_blobsinclude=["deleted"] Voorlopig verwijderde blobs of momentopnamen kunnen worden hersteld met behulp van <xref:azure.storage.blob.BlobClient.undelete>

Het maximum aantal blobs dat in één aanvraag kan worden verwijderd, is 256.

delete_container

Markeert de opgegeven container voor verwijdering. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

download_blob

Hiermee downloadt u een blob naar de StorageStreamDownloader. De methode readall() moet worden gebruikt om alle inhoud te lezen of readinto() moet worden gebruikt om de blob in een stream te downloaden. Het gebruik van chunks() retourneert een iterator waarmee de gebruiker de inhoud in segmenten kan herhalen.

exists

Retourneert True als er een container bestaat en retourneert anders False.

find_blobs_by_tags

Retourneert een generator om de blobs weer te geven onder de opgegeven container waarvan de tags overeenkomen met de opgegeven zoekexpressie. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

from_connection_string

ContainerClient maken op basis van een verbindingsreeks.

from_container_url

Maak ContainerClient op basis van een container-URL.

get_account_information

Hiermee haalt u informatie op met betrekking tot het opslagaccount.

De informatie kan ook worden opgehaald als de gebruiker een SAS voor een container of blob heeft. De sleutels in de geretourneerde woordenlijst bevatten 'sku_name' en 'account_kind'.

get_blob_client

Vraag een client om te communiceren met de opgegeven blob.

De blob hoeft nog niet te bestaan.

get_container_access_policy

Hiermee haalt u de machtigingen voor de opgegeven container op. De machtigingen geven aan of containergegevens openbaar kunnen worden geopend.

get_container_properties

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven container. De geretourneerde gegevens bevatten niet de lijst met blobs van de container.

list_blob_names

Retourneert een generator om de namen van blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

Houd er rekening mee dat er geen aanvullende eigenschappen of metagegevens worden geretourneerd wanneer u deze API gebruikt. Bovendien heeft deze API geen optie voor het opnemen van extra blobs, zoals momentopnamen, versies, voorlopig verwijderde blobs, enzovoort. Als u deze gegevens wilt ophalen, gebruikt u list_blobs.

list_blobs

Retourneert een generator om de blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

set_container_access_policy

Hiermee stelt u de machtigingen in voor de opgegeven container of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of blobs in een container openbaar toegankelijk zijn.

set_container_metadata

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven container. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de container zijn gekoppeld. Als u alle metagegevens uit de container wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.

set_premium_page_blob_tier_blobs

Hiermee stelt u de pagina-bloblagen voor alle blobs in. Deze API wordt alleen ondersteund voor pagina-blobs op Premium-accounts.

Het maximum aantal blobs dat in één aanvraag kan worden bijgewerkt, is 256.

set_standard_blob_tier_blobs

Met deze bewerking wordt de laag voor blok-blobs ingesteld.

De laag van een blok-blob bepaalt het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.

Het maximum aantal blobs dat in één aanvraag kan worden bijgewerkt, is 256.

upload_blob

Hiermee maakt u een nieuwe blob op basis van een gegevensbron met automatische segmentering.

walk_blobs

Retourneert een generator om de blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd. Met deze bewerking worden blobs weergegeven in overeenstemming met een hiërarchie, gescheiden door het opgegeven scheidingsteken.

acquire_lease

Vraagt een nieuwe lease aan. Als de container geen actieve lease heeft, maakt de Blob-service een lease voor de container en retourneert een nieuwe lease-id.

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

Parameters

lease_duration
int
Vereist

Hiermee geeft u de duur van de lease, in seconden, of een negatieve (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

lease_id
str
Vereist

Voorgestelde lease-id, in een GUID-tekenreeksindeling. De Blob-service retourneert 400 (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een BlobLeaseClient-object, dat kan worden uitgevoerd in een contextbeheer.

Retourtype

close

Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder.

close()

create_container

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, mislukt de bewerking.

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

Parameters

metadata
dict[str, str]
Vereist

Een dict met name_value paren om als metagegevens aan de container te koppelen. Voorbeeld:{'Category':'test'}

public_access
PublicAccess
Vereist

Mogelijke waarden zijn: 'container', 'blob'.

container_encryption_scope
dict of ContainerEncryptionScope

Hiermee geeft u het standaardversleutelingsbereik op dat moet worden ingesteld voor de container en moet worden gebruikt voor alle toekomstige schrijfbewerkingen.

Nieuw in versie 12.2.0.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een woordenlijst met antwoordheaders.

Retourtype

delete_blob

Hiermee markeert u de opgegeven blob of momentopname voor verwijdering.

De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking delete_blob.

Als een bewaarbeleid voor verwijderen is ingeschakeld voor de service, wordt met deze bewerking de blob of momentopname voorlopig verwijderd en wordt de blob of momentopname bewaard gedurende het opgegeven aantal dagen. Na het opgegeven aantal dagen worden de gegevens van de blob verwijderd uit de service tijdens garbagecollection. Voorlopig verwijderde blob of momentopname is toegankelijk via list_blobs de optie include=["deleted"]. Voorlopig verwijderde blob of momentopname kan worden hersteld met behulp van <xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

Parameters

blob
str of BlobProperties
Vereist

De blob waarmee moet worden gecommuniceerd. Indien opgegeven, overschrijft deze waarde een blobwaarde die is opgegeven in de blob-URL.

delete_snapshots
str
Vereist

Vereist als de blob gekoppelde momentopnamen heeft. De waarden zijn:

  • 'alleen': hiermee verwijdert u alleen de momentopnamen van blobs.

  • "include": hiermee verwijdert u de blob samen met alle momentopnamen.

version_id
str

De parameter versie-id is een ondoorzichtige Datum/tijd-waarde die, indien aanwezig, aangeeft welke versie van de blob moet worden verwijderd.

Nieuw in versie 12.4.0.

Dit trefwoordargument is geïntroduceerd in API-versie 2019-12-12.

lease
BlobLeaseClient of str

Vereist als de blob een actieve lease heeft. Waarde kan een BlobLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags om alleen te werken op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retourtype

delete_blobs

Markeert de opgegeven blobs of momentopnamen voor verwijdering.

De blobs worden later verwijderd tijdens de garbagecollection. Als u blobs wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de delete_blobs bewerking.

Als een bewaarbeleid voor verwijderen is ingeschakeld voor de service, worden met deze bewerking de blobs of momentopnamen voorlopig verwijderd en worden de blobs of momentopnamen gedurende het opgegeven aantal dagen bewaard. Na het opgegeven aantal dagen worden de gegevens van blobs verwijderd uit de service tijdens de garbagecollection. Voorlopig verwijderde blobs of momentopnamen zijn toegankelijk via list_blobsinclude=["deleted"] Voorlopig verwijderde blobs of momentopnamen kunnen worden hersteld met behulp van <xref:azure.storage.blob.BlobClient.undelete>

Het maximum aantal blobs dat in één aanvraag kan worden verwijderd, is 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

blobs
str of dict(str, Any) of BlobProperties
Vereist

De blobs die moeten worden verwijderd. Dit kan één blob zijn of meerdere waarden kunnen worden opgegeven, waarbij elke waarde de naam van de blob (str) of blobeigenschappen is.

Notitie

Wanneer het blobtype dict is, volgt hier een lijst met sleutels en waarderegels.

blobnaam:

sleutel: 'naam', waardetype: str

momentopname die u wilt verwijderen:

sleutel: 'momentopname', waardetype: str

versie-id:

sleutel: 'version_id', waardetype: str

of momentopnamen moeten worden verwijderd bij het verwijderen van een blob:

sleutel: 'delete_snapshots', waarde: 'include' of 'only'

als de blob is gewijzigd of niet:

sleutel: 'if_modified_since', 'if_unmodified_since', waardetype: datetime

etag:

sleutel: 'etag', waardetype: str

al dan niet overeenkomen met de etag:

sleutel: 'match_condition', waardetype: MatchConditions

tags overeenkomen met voorwaarde:

sleutel: 'if_tags_match_condition', waardetype: str

Lease:

sleutel: 'lease_id', waardetype: Union[str, LeaseClient]

time-out voor subaanvraag:

sleutel: 'time-out', waardetype: int

delete_snapshots
str

Vereist als aan een blob momentopnamen zijn gekoppeld. De waarden zijn:

  • 'alleen': hiermee verwijdert u alleen de momentopnamen van blobs.

  • 'include': hiermee verwijdert u de blob samen met alle momentopnamen.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags om alleen te werken op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

raise_on_any_failure
bool

Dit is een booleaanse param die standaard wordt ingesteld op True. Wanneer dit is ingesteld, wordt er een uitzondering gegenereerd, zelfs als er één bewerkingsfout optreedt.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een iterator van antwoorden, één voor elke blob in volgorde

Retourtype

delete_container

Markeert de opgegeven container voor verwijdering. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

delete_container(**kwargs: Any) -> None

Parameters

lease
BlobLeaseClient of str

Indien opgegeven, slaagt delete_container alleen als de lease van de container actief is en overeenkomt met deze id. Vereist als de container een actieve lease heeft.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retourtype

download_blob

Hiermee downloadt u een blob naar de StorageStreamDownloader. De methode readall() moet worden gebruikt om alle inhoud te lezen of readinto() moet worden gebruikt om de blob in een stream te downloaden. Het gebruik van chunks() retourneert een iterator waarmee de gebruiker de inhoud in segmenten kan herhalen.

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

Parameters

blob
str of BlobProperties
Vereist

De blob waarmee moet worden gecommuniceerd. Indien opgegeven, overschrijft deze waarde een blobwaarde die is opgegeven in de blob-URL.

offset
int
Vereist

Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van de blob. Moet worden ingesteld als de lengte is opgegeven.

length
int
Vereist

Aantal bytes dat uit de stream moet worden gelezen. Dit is optioneel, maar moet worden geleverd voor optimale prestaties.

version_id
str

De parameter versie-id is een ondoorzichtige Datum/tijd-waarde die, indien aanwezig, aangeeft welke versie van de blob moet worden gedownload.

Nieuw in versie 12.4.0.

Dit trefwoordargument is geïntroduceerd in API-versie 2019-12-12.

validate_content
bool

Als dit waar is, wordt een MD5-hash berekend voor elk segment van de blob. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de kabel als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen met de blob. Houd er ook rekening mee dat als dit is ingeschakeld, het algoritme voor geheugenefficiënte upload niet wordt gebruikt, omdat voor het berekenen van de MD5-hash hele blokken moeten worden gebufferd, waardoor het doel van het geheugenefficiënte algoritme wordt genegeerd.

lease
BlobLeaseClient of str

Vereist als de blob een actieve lease heeft. Indien opgegeven, slaagt download_blob alleen als de lease van de blob actief is en overeenkomt met deze id. De waarde kan een BlobLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags die alleen moeten worden uitgevoerd op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

cpk
CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS. Omdat de versleutelingssleutel zelf is opgegeven in de aanvraag, moet er een beveiligde verbinding tot stand worden gebracht om de sleutel over te dragen.

max_concurrency
int

Het aantal parallelle verbindingen waarmee moet worden gedownload.

encoding
str

Codering om de gedownloade bytes te decoderen. De standaardwaarde is Geen, dat wil zeggen geen decodering.

progress_hook
Callable[[int, int], None]

Een callback om de voortgang van een langlopende download bij te houden. De handtekening is function(current: int, total: int) waarbij current het aantal bytes is dat tot nu toe is overgedragen en total de totale grootte van de download.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren. Met deze methode kunnen meerdere aanroepen naar de service worden uitgevoerd en de time-out is van toepassing op elke aanroep afzonderlijk. meerdere aanroepen naar de Azure-service en de time-out is van toepassing op elke aanroep afzonderlijk.

Retouren

Een streamingobject (StorageStreamDownloader)

Retourtype

exists

Retourneert True als er een container bestaat en retourneert anders False.

exists(**kwargs: Any) -> bool

Parameters

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

booleaans

Retourtype

find_blobs_by_tags

Retourneert een generator om de blobs weer te geven onder de opgegeven container waarvan de tags overeenkomen met de opgegeven zoekexpressie. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]

Parameters

filter_expression
str
Vereist

De expressie om blobs te vinden waarvan de tags overeenkomen met de opgegeven voorwaarde. bijvoorbeeld ""yourtagname"='firsttag' en "yourtagname2"='secondtag'"

results_per_page
int

Het maximale resultaat per pagina bij het pagineren.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een iterable (automatisch paging) antwoord van FilteredBlob.

Retourtype

from_connection_string

ContainerClient maken op basis van een verbindingsreeks.

from_connection_string(conn_str: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameters

conn_str
str
Vereist

Een connection string naar een Azure Storage-account.

container_name
str
Vereist

De containernaam voor de blob.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de connection string al gedeelde toegangssleutelwaarden heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor het account of een exemplaar van een TokenCredentials-klasse van azure.identity. Referenties die hier worden opgegeven, hebben voorrang op de referenties in de connection string. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

Retouren

Een containerclient.

Retourtype

from_container_url

Maak ContainerClient op basis van een container-URL.

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

Parameters

container_url
str
Vereist

De volledige eindpunt-URL naar de container, inclusief SAS-token indien gebruikt. Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de connection string al gedeelde toegangssleutelwaarden heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor het account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

  • behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

Retouren

Een containerclient.

Retourtype

get_account_information

Hiermee haalt u informatie op met betrekking tot het opslagaccount.

De informatie kan ook worden opgehaald als de gebruiker een SAS voor een container of blob heeft. De sleutels in de geretourneerde woordenlijst bevatten 'sku_name' en 'account_kind'.

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

Retouren

Een dictaat met accountgegevens (SKU en accounttype).

Retourtype

get_blob_client

Vraag een client om te communiceren met de opgegeven blob.

De blob hoeft nog niet te bestaan.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

Parameters

blob
str of BlobProperties
Vereist

De blob waarmee moet worden gecommuniceerd.

snapshot
str
standaardwaarde: None

De optionele blob-momentopname waarop moet worden uitgevoerd. Dit kan de tekenreeks van de momentopname-id zijn of het antwoord dat wordt geretourneerd door create_snapshot.

version_id
str

De parameter versie-id is een ondoorzichtige DateTime-waarde die, indien aanwezig, aangeeft welke versie van de blob moet worden uitgevoerd.

Retouren

Een BlobClient.

Retourtype

get_container_access_policy

Hiermee haalt u de machtigingen voor de opgegeven container op. De machtigingen geven aan of containergegevens openbaar kunnen worden geopend.

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

Parameters

lease
BlobLeaseClient of str

Indien opgegeven, slaagt get_container_access_policy alleen als de lease van de container actief is en overeenkomt met deze id.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Toegang tot beleidsinformatie in een dict.

Retourtype

get_container_properties

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven container. De geretourneerde gegevens bevatten niet de lijst met blobs van de container.

get_container_properties(**kwargs: Any) -> ContainerProperties

Parameters

lease
BlobLeaseClient of str

Indien opgegeven, slaagt get_container_properties alleen als de lease van de container actief is en overeenkomt met deze id.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Eigenschappen voor de opgegeven container in een containerobject.

Retourtype

list_blob_names

Retourneert een generator om de namen van blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

Houd er rekening mee dat er geen aanvullende eigenschappen of metagegevens worden geretourneerd wanneer u deze API gebruikt. Bovendien heeft deze API geen optie voor het opnemen van extra blobs, zoals momentopnamen, versies, voorlopig verwijderde blobs, enzovoort. Als u deze gegevens wilt ophalen, gebruikt u list_blobs.

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Parameters

name_starts_with
str

Filtert de resultaten om alleen blobs te retourneren waarvan de naam begint met het opgegeven voorvoegsel.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een iterable (automatisch paging) antwoord van blobnamen als tekenreeksen.

Retourtype

list_blobs

Retourneert een generator om de blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Parameters

name_starts_with
str
Vereist

Filtert de resultaten om alleen blobs te retourneren waarvan de naam begint met het opgegeven voorvoegsel.

include
list[str] of str
Vereist

Hiermee geeft u een of meer aanvullende gegevenssets op die moeten worden opgenomen in het antwoord. De opties zijn: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een iterable (automatisch paging) antwoord van BlobProperties.

Retourtype

set_container_access_policy

Hiermee stelt u de machtigingen in voor de opgegeven container of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of blobs in een container openbaar toegankelijk zijn.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Parameters

signed_identifiers
dict[str, AccessPolicy]
Vereist

Een woordenlijst met toegangsbeleidsregels die aan de container moeten worden gekoppeld. De woordenlijst kan maximaal 5 elementen bevatten. Met een lege woordenlijst wordt het toegangsbeleid dat voor de service is ingesteld, gewist.

public_access
PublicAccess
Vereist

Mogelijke waarden zijn: 'container', 'blob'.

lease
BlobLeaseClient of str

Vereist als de container een actieve lease heeft. Waarde kan een BlobLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource is gewijzigd sinds de opgegeven datum/tijd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Container bijgewerkt eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

set_container_metadata

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven container. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de container zijn gekoppeld. Als u alle metagegevens uit de container wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.

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

Parameters

metadata
dict[str, str]
Vereist

Een dicteerfunctie met naam-waardeparen die als metagegevens aan de container moeten worden gekoppeld. Voorbeeld: {'category':'test'}

lease
BlobLeaseClient of str

Indien opgegeven, slaagt set_container_metadata alleen als de lease van de container actief is en overeenkomt met deze id.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Container bijgewerkt eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

set_premium_page_blob_tier_blobs

Hiermee stelt u de pagina-bloblagen voor alle blobs in. Deze API wordt alleen ondersteund voor pagina-blobs op Premium-accounts.

Het maximum aantal blobs dat in één aanvraag kan worden bijgewerkt, is 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

premium_page_blob_tier
PremiumPageBlobTier
Vereist

Een pagina-bloblaagwaarde waarop de blob moet worden ingesteld. De laag is gerelateerd aan de grootte van de blob en het aantal toegestane IOPS. Dit is alleen van toepassing op pagina-blobs in Premium Storage-accounts.

Notitie

Als u een andere laag voor verschillende blobs wilt instellen, stelt u deze positionele parameter in op Geen.

Vervolgens wordt de bloblaag voor elke BlobProperties gebruikt.

blobs
str of dict(str, Any) of BlobProperties
Vereist

De blobs waarmee moet worden gecommuniceerd. Dit kan één blob zijn of meerdere waarden kunnen worden opgegeven, waarbij elke waarde de naam van de blob (str) of blobeigenschappen is.

Notitie

Wanneer het blobtype dict is, volgt hier een lijst met sleutels en waarderegels.

blobnaam:

sleutel: 'naam', waardetype: str

Premium Blob-laag:

sleutel: 'blob_tier', waardetype: PremiumPageBlobTier

Lease:

sleutel: 'lease_id', waardetype: Union[str, LeaseClient]

time-out voor subaanvraag:

sleutel: 'time-out', waardetype: int

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

raise_on_any_failure
bool

Dit is een booleaanse param die standaard wordt ingesteld op True. Wanneer dit is ingesteld, wordt er een uitzondering gegenereerd, zelfs als er één bewerkingsfout optreedt.

Retouren

Een iterator van antwoorden, één voor elke blob in volgorde

Retourtype

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Met deze bewerking wordt de laag voor blok-blobs ingesteld.

De laag van een blok-blob bepaalt het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.

Het maximum aantal blobs dat in één aanvraag kan worden bijgewerkt, is 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

standard_blob_tier
str of StandardBlobTier
Vereist

Geeft de laag aan die moet worden ingesteld voor alle blobs. Opties zijn onder andere 'Dynamisch', 'Statisch', 'Archiveren'. De dynamische laag is geoptimaliseerd voor het opslaan van gegevens die regelmatig worden geopend. De statische opslaglaag is geoptimaliseerd voor het opslaan van gegevens die zelden worden geopend en die gedurende ten minste een maand worden opgeslagen. De archieflaag is geoptimaliseerd voor het opslaan van gegevens die zelden worden geopend en die gedurende ten minste zes maanden worden opgeslagen met flexibele latentievereisten.

Notitie

Als u een andere laag voor verschillende blobs wilt instellen, stelt u deze positionele parameter in op Geen.

Vervolgens wordt de bloblaag voor elke BlobProperties gebruikt.

blobs
str of dict(str, Any) of BlobProperties
Vereist

De blobs waarmee moet worden gecommuniceerd. Dit kan één blob zijn of meerdere waarden kunnen worden opgegeven, waarbij elke waarde de naam van de blob (str) of blobeigenschappen is.

Notitie

Wanneer het blobtype dict is, volgt hier een lijst met sleutels en waarderegels.

blobnaam:

sleutel: 'naam', waardetype: str

standaard-bloblaag:

sleutel: 'blob_tier', waardetype: StandardBlobTier

rehydrateerprioriteit:

sleutel: 'rehydrate_priority', waardetype: RehydratePriority

Lease:

sleutel: 'lease_id', waardetype: Union[str, LeaseClient]

Momentopname:

sleutel: "momentopname", waardetype: str

versie-id:

sleutel: "version_id", waardetype: str

tags overeenkomen met voorwaarde:

sleutel: 'if_tags_match_condition', waardetype: str

time-out voor subaanvraag:

sleutel: 'time-out', waardetype: int

rehydrate_priority
RehydratePriority

Geeft de prioriteit aan waarmee een gearchiveerde blob moet worden gerehydrateerd

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags om alleen te werken op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

raise_on_any_failure
bool

Dit is een booleaanse param die standaard wordt ingesteld op True. Wanneer dit is ingesteld, wordt er een uitzondering gegenereerd, zelfs als er één bewerkingsfout optreedt.

Retouren

Een iterator van antwoorden, één voor elke blob in volgorde

Retourtype

upload_blob

Hiermee maakt u een nieuwe blob op basis van een gegevensbron met automatische segmentering.

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

Parameters

name
str of BlobProperties
Vereist

De blob waarmee u wilt communiceren. Indien opgegeven, overschrijft deze waarde een blobwaarde die is opgegeven in de blob-URL.

data
Vereist

De blobgegevens die moeten worden geüpload.

blob_type
BlobType
Vereist

Het type blob. Dit kan BlockBlob, PageBlob of AppendBlob zijn. De standaardwaarde is BlockBlob.

length
int
Vereist

Het aantal bytes dat uit de stream moet worden gelezen. Dit is optioneel, maar moet worden opgegeven voor optimale prestaties.

metadata
dict(str, str)
Vereist

Naam-waardeparen die als metagegevens aan de blob zijn gekoppeld.

overwrite
bool

Of de blob die moet worden geüpload, de huidige gegevens moet overschrijven. Indien waar, overschrijft upload_blob de bestaande gegevens. Als deze optie is ingesteld op False, mislukt de bewerking met ResourceExistsError. De uitzondering op het bovenstaande is bij de typen toevoeg-blob: als deze is ingesteld op Onwaar en de gegevens al bestaan, wordt er geen fout gegenereerd en worden de gegevens toegevoegd aan de bestaande blob. Als overschrijven=Waar is ingesteld, wordt de bestaande toevoeg-blob verwijderd en wordt er een nieuwe gemaakt. Standaard ingesteld op False.

content_settings
ContentSettings

ContentSettings-object dat wordt gebruikt om blobeigenschappen in te stellen. Wordt gebruikt voor het instellen van inhoudstype, codering, taal, verwijdering, md5 en cachebeheer.

validate_content
bool

Indien waar, berekent u een MD5-hash voor elk segment van de blob. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral nuttig voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen met de blob. Houd er ook rekening mee dat als dit is ingeschakeld, het geheugenefficiënte upload-algoritme niet wordt gebruikt, omdat voor het berekenen van de MD5-hash hele blokken moeten worden gebufferd, waardoor het doel van het geheugenefficiënte algoritme wordt verslagen.

lease
BlobLeaseClient of str

Vereist als de container een actieve lease heeft. Waarde kan een BlobLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since
datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag
str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags om alleen te werken op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren. Met deze methode kunnen meerdere aanroepen naar de service worden uitgevoerd en de time-out is van toepassing op elke aanroep afzonderlijk.

premium_page_blob_tier
PremiumPageBlobTier

Een pagina-bloblaagwaarde waarop de blob moet worden ingesteld. De laag komt overeen met de grootte van de blob en het aantal toegestane IOPS. Dit is alleen van toepassing op pagina-blobs in Premium Storage-accounts.

standard_blob_tier
StandardBlobTier

Een standaard-bloblaagwaarde om de blob op in te stellen. Voor deze versie van de bibliotheek is dit alleen van toepassing op blok-blobs in standaardopslagaccounts.

maxsize_condition
int

Optionele voorwaardelijke header. De maximale lengte in bytes die is toegestaan voor de toevoeg-blob. Als de bewerking Append Block ervoor zorgt dat de blob deze limiet overschrijdt of als de blobgrootte al groter is dan de waarde die in deze header is opgegeven, mislukt de aanvraag met de fout MaxBlobSizeConditionNotMet (HTTP-statuscode 412 - Voorwaarde is mislukt).

max_concurrency
int

Maximum aantal parallelle verbindingen dat moet worden gebruikt wanneer de blob groter is dan 64 MB.

cpk
CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS. Omdat de versleutelingssleutel zelf is opgegeven in de aanvraag, moet er een beveiligde verbinding tot stand worden gebracht om de sleutel over te dragen.

encryption_scope
str

Een vooraf gedefinieerd versleutelingsbereik dat wordt gebruikt om de gegevens op de service te versleutelen. Een versleutelingsbereik kan worden gemaakt met behulp van de Management-API en hier op naam naar verwijzen. Als er een standaardversleutelingsbereik is gedefinieerd in de container, wordt deze waarde overschreven als het bereik op containerniveau is geconfigureerd om onderdrukkingen toe te staan. Anders treedt er een fout op.

Nieuw in versie 12.2.0.

encoding
str

De standaardinstelling is UTF-8.

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

Een callback om de voortgang van een langlopende upload bij te houden. De handtekening is function(current: int, total: Optional[int]) waarbij de huidige het aantal bytes is dat tot nu toe is overgedragen en het totaal de grootte van de blob of Geen als de grootte onbekend is.

Retouren

Een BlobClient om te communiceren met de zojuist geüploade blob.

Retourtype

walk_blobs

Retourneert een generator om de blobs onder de opgegeven container weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd. Met deze bewerking worden blobs weergegeven in overeenstemming met een hiërarchie, gescheiden door het opgegeven scheidingsteken.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

Parameters

name_starts_with
str
Vereist

Filtert de resultaten om alleen blobs te retourneren waarvan de naam begint met het opgegeven voorvoegsel.

include
list[str] of str
Vereist

Hiermee geeft u een of meer extra gegevenssets op die moeten worden opgenomen in het antwoord. Opties zijn onder andere: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.

delimiter
str
Vereist

Wanneer de aanvraag deze parameter bevat, retourneert de bewerking een BlobPrefix-element in de antwoordtekst dat fungeert als een tijdelijke aanduiding voor alle blobs waarvan de namen beginnen met dezelfde subtekenreeks tot het uiterlijk van het scheidingsteken. Het scheidingsteken kan één teken of een tekenreeks zijn.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een iterable (automatisch paging) antwoord van BlobProperties.

Retourtype

Kenmerken

api_version

De versie van de Storage-API die wordt gebruikt voor aanvragen.

location_mode

De locatiemodus die de client momenteel gebruikt.

Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.

primary_endpoint

De volledige URL van het primaire eindpunt.

primary_hostname

De hostnaam van het primaire eindpunt.

secondary_endpoint

De volledige url van het secundaire eindpunt, indien geconfigureerd.

Als dit niet beschikbaar is, wordt er een ValueError gegenereerd. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname trefwoordargument bij instantiëring.

Uitzonderingen

secondary_hostname

De hostnaam van het secundaire eindpunt.

Als dit niet beschikbaar is, is dit Geen. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname trefwoordargument bij instantiëring.

url

De volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt.

Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode. :retourneert: de volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt. :rtype: str