ContainerClient Klass

En klient för att interagera med en specifik container, även om den containern kanske ännu inte finns.

För åtgärder som rör en specifik blob i den här containern kan en blobklient hämtas med hjälp av get_blob_client funktionen .

Klicka här om du vill ha mer valfri konfiguration.

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

Konstruktor

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

Parametrar

account_url
str
Obligatorisk

URI:n till lagringskontot. Använd classmethod för att skapa en klient med den fullständiga URI:n till containern from_container_url .

container_name
str
Obligatorisk

Namnet på containern för bloben.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

  • utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "name" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
api_version
str

Den Storage API-version som ska användas för begäranden. Standardvärdet är den senaste tjänstversionen som är kompatibel med aktuell SDK. Om du anger en äldre version kan funktionskompatibiliteten minska.

Ny i version 12.2.0.

secondary_hostname
str

Värdnamnet för den sekundära slutpunkten.

max_block_size
int

Den maximala segmentstorleken för att ladda upp en blockblob i segment. Standardvärdet är 4*1024*1024 eller 4 MB.

max_single_put_size
int

Om blobstorleken är mindre än eller lika med max_single_put_size laddas bloben bara upp med en http PUT-begäran. Om blobstorleken är större än max_single_put_size laddas bloben upp i segment. Standardvärdet är 64*1024*1024 eller 64 MB.

min_large_block_upload_threshold
int

Den minsta segmentstorlek som krävs för att använda den minneseffektiva algoritmen när du laddar upp en blockblob. Standardvärdet är 4*1024*1024+1.

use_byte_buffer
bool

Använd en bytebuffert för blockblobuppladdningar. Standardvärdet är False.

max_page_size
int

Den maximala segmentstorleken för att ladda upp en sidblob. Standardvärdet är 4*1024*1024 eller 4 MB.

max_single_get_size
int

Den maximala storleken för en blob som ska laddas ned i ett enda anrop. Den överskred delen laddas ned i segment (kan vara parallell). Standardvärdet är 32*1024*1024 eller 32 MB.

max_chunk_get_size
int

Den maximala segmentstorleken som används för att ladda ned en blob. Standardvärdet är 4*1024*1024 eller 4 MB.

Metoder

acquire_lease

Begär ett nytt lån. Om containern inte har ett aktivt lån skapar Blob Service ett lån för containern och returnerar ett nytt låne-ID.

close

Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare.

create_container

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

delete_blob

Markerar den angivna bloben eller ögonblicksbilden för borttagning.

Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden delete_blob.

Om en kvarhållningsprincip för borttagning är aktiverad för tjänsten tar den här åtgärden bort bloben eller ögonblicksbilden och behåller bloben eller ögonblicksbilden under angivet antal dagar. Efter angivet antal dagar tas blobens data bort från tjänsten under skräpinsamlingen. Mjuk borttagen blob eller ögonblicksbild är tillgänglig genom list_blobs att ange alternativet include=["deleted"] . Mjuk borttagen blob eller ögonblicksbild kan återställas med hjälp av <xref:azure.storage.blob.BlobClient.undelete>

delete_blobs

Markerar de angivna blobarna eller ögonblicksbilderna för borttagning.

Blobarna tas senare bort under skräpinsamlingen. Observera att för att kunna ta bort blobar måste du ta bort alla deras ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden delete_blobs.

Om en kvarhållningsprincip för borttagning är aktiverad för tjänsten tar den här åtgärden bort blobar eller ögonblicksbilder och behåller blobar eller ögonblicksbilder under angivet antal dagar. Efter angivet antal dagar tas blobarnas data bort från tjänsten under skräpinsamlingen. Mjuka borttagna blobar eller ögonblicksbilder är tillgängliga genom list_blobs att ange include=["deleted"] Mjukt borttagna blobar eller ögonblicksbilder kan återställas med hjälp av <xref:azure.storage.blob.BlobClient.undelete>

Det maximala antalet blobar som kan tas bort i en enda begäran är 256.

delete_container

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

download_blob

Laddar ned en blob till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll eller readinto() måste användas för att ladda ned bloben till en dataström. Med segment() returneras en iterator som gör att användaren kan iterera över innehållet i segment.

exists

Returnerar Sant om det finns en container och returnerar False annars.

find_blobs_by_tags

Returnerar en generator för att visa blobarna under den angivna containern vars taggar matchar det angivna sökuttrycket. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

from_connection_string

Skapa ContainerClient från en anslutningssträng.

from_container_url

Skapa ContainerClient från en container-URL.

get_account_information

Hämtar information om lagringskontot.

Informationen kan också hämtas om användaren har en SAS till en container eller blob. Nycklarna i den returnerade ordlistan innehåller "sku_name" och "account_kind".

get_blob_client

Hämta en klient för att interagera med den angivna bloben.

Bloben behöver inte redan finnas.

get_container_access_policy

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan nås offentligt.

get_container_properties

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

list_blob_names

Returnerar en generator för att visa namnen på blobar under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

Observera att inga ytterligare egenskaper eller metadata returneras när du använder det här API:et. Dessutom har det här API:et inte något alternativ för att inkludera ytterligare blobar, till exempel ögonblicksbilder, versioner, mjukt borttagna blobbar osv. Om du vill hämta någon av dessa data använder du list_blobs.

list_blobs

Returnerar en generator för att visa blobarna under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

set_container_access_policy

Anger behörigheter för den angivna containern eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om blobar i en container kan nås offentligt.

set_container_metadata

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till containern. Om du vill ta bort alla metadata från containern anropar du den här åtgärden utan metadatadiktering.

set_premium_page_blob_tier_blobs

Anger sidblobnivåerna för alla blobar. Det här API:et stöds bara för sidblobar på Premium-konton.

Det maximala antalet blobar som kan uppdateras i en enskild begäran är 256.

set_standard_blob_tier_blobs

Den här åtgärden anger nivån för blockblobar.

En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag.

Det maximala antalet blobar som kan uppdateras i en enskild begäran är 256.

upload_blob

Skapar en ny blob från en datakälla med automatisk segmentering.

walk_blobs

Returnerar en generator för att visa blobarna under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten. Den här åtgärden listar blobar i enlighet med en hierarki, som avgränsas av det angivna avgränsartecknet.

acquire_lease

Begär ett nytt lån. Om containern inte har ett aktivt lån skapar Blob Service ett lån för containern och returnerar ett nytt låne-ID.

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

Parametrar

lease_duration
int
Obligatorisk

Anger lånets varaktighet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra en lånetid med hjälp av förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).

lease_id
str
Obligatorisk

Föreslaget låne-ID i ett GUID-strängformat. Blob-tjänsten returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett BlobLeaseClient-objekt som kan köras i en kontexthanterare.

Returtyp

close

Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare.

close()

create_container

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

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

Parametrar

metadata
dict[str, str]
Obligatorisk

En diktering med name_value par som ska associeras med containern som metadata. Exempel:{'Kategori':'test'}

public_access
PublicAccess
Obligatorisk

Möjliga värden är: "container", "blob".

container_encryption_scope
dict eller ContainerEncryptionScope

Anger standardkrypteringsomfånget som ska anges för containern och används för alla framtida skrivningar.

Ny i version 12.2.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En ordlista med svarshuvuden.

Returtyp

delete_blob

Markerar den angivna bloben eller ögonblicksbilden för borttagning.

Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden delete_blob.

Om en kvarhållningsprincip för borttagning är aktiverad för tjänsten tar den här åtgärden bort bloben eller ögonblicksbilden och behåller bloben eller ögonblicksbilden under angivet antal dagar. Efter angivet antal dagar tas blobens data bort från tjänsten under skräpinsamlingen. Mjuk borttagen blob eller ögonblicksbild är tillgänglig genom list_blobs att ange alternativet include=["deleted"] . Mjuk borttagen blob eller ögonblicksbild kan återställas med hjälp av <xref:azure.storage.blob.BlobClient.undelete>

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

Parametrar

blob
str eller BlobProperties
Obligatorisk

Bloben som du vill interagera med. Om det här värdet anges åsidosätts ett blobvärde som anges i blob-URL:en.

delete_snapshots
str
Obligatorisk

Krävs om bloben har associerade ögonblicksbilder. Exempel på värden:

  • "only": Tar bara bort ögonblicksbilderna av blobar.

  • "include": Tar bort bloben tillsammans med alla ögonblicksbilder.

version_id
str

Parametern för versions-ID är ett täckande DateTime-värde som, när det finns, anger vilken version av bloben som ska tas bort.

Ny i version 12.4.0.

Det här nyckelordsargumentet introducerades i API-versionen "2019-12-12".

lease
BlobLeaseClient eller str

Krävs om bloben har ett aktivt lån. Värdet kan vara ett BlobLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

delete_blobs

Markerar de angivna blobarna eller ögonblicksbilderna för borttagning.

Blobarna tas senare bort under skräpinsamlingen. Observera att för att kunna ta bort blobar måste du ta bort alla deras ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden delete_blobs.

Om en kvarhållningsprincip för borttagning är aktiverad för tjänsten tar den här åtgärden bort blobar eller ögonblicksbilder och behåller blobar eller ögonblicksbilder under angivet antal dagar. Efter angivet antal dagar tas blobarnas data bort från tjänsten under skräpinsamlingen. Mjuka borttagna blobar eller ögonblicksbilder är tillgängliga genom list_blobs att ange include=["deleted"] Mjukt borttagna blobar eller ögonblicksbilder kan återställas med hjälp av <xref:azure.storage.blob.BlobClient.undelete>

Det maximala antalet blobar som kan tas bort i en enda begäran är 256.

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

Parametrar

blobs
str eller dict(str, Any) eller BlobProperties
Obligatorisk

De blobar som ska tas bort. Detta kan vara en enda blob, eller så kan flera värden anges, där varje värde antingen är namnet på bloben (str) eller BlobProperties.

Anteckning

När blobtypen är diktamen finns här en lista över nycklar, värderegler.

blobnamn:

key: 'name', value type: str

ögonblicksbild som du vill ta bort:

key: 'snapshot', value type: str

versions-ID:

nyckel: "version_id", värdetyp: str

om du vill ta bort ögonblicksbilder när bloben tas bort:

nyckel: "delete_snapshots", värde: "include" eller "only"

om bloben har ändrats eller inte:

nyckel: "if_modified_since", "if_unmodified_since", värdetyp: datetime

Etag:

nyckel: "etag", värdetyp: str

matcha etag eller inte:

nyckel: "match_condition", värdetyp: MatchConditions

taggar matchar villkor:

nyckel: "if_tags_match_condition", värdetyp: str

Leasing:

nyckel: "lease_id", värdetyp: Union[str, LeaseClient]

timeout för underbegäran:

nyckel: "timeout", värdetyp: int

delete_snapshots
str

Krävs om en blob har associerade ögonblicksbilder. Exempel på värden:

  • "only": Tar bara bort ögonblicksbilder av blobar.

  • "include": Tar bort bloben tillsammans med alla ögonblicksbilder.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

if_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

raise_on_any_failure
bool

Det här är en boolesk param som standard är True. När detta anges utlöses ett undantag även om det uppstår ett enskilt åtgärdsfel.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En iterator av svar, en för varje blob i ordning

Returtyp

delete_container

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

delete_container(**kwargs: Any) -> None

Parametrar

lease
BlobLeaseClient eller str

Om det anges lyckas delete_container bara om containerns lån är aktivt och matchar det här ID:t. Krävs om containern har ett aktivt lån.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

download_blob

Laddar ned en blob till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll eller readinto() måste användas för att ladda ned bloben till en dataström. Med segment() returneras en iterator som gör att användaren kan iterera över innehållet i segment.

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

Parametrar

blob
str eller BlobProperties
Obligatorisk

Den blob som du vill interagera med. Om det här värdet anges åsidosätter det ett blobvärde som anges i blob-URL:en.

offset
int
Obligatorisk

Start av byteintervall som ska användas för att ladda ned ett avsnitt av blobben. Måste anges om längden anges.

length
int
Obligatorisk

Antal byte som ska läsas från dataströmmen. Detta är valfritt, men bör tillhandahållas för optimala prestanda.

version_id
str

Parametern versions-ID är ett ogenomskinliga DateTime-värde som när det finns anger vilken version av bloben som ska laddas ned.

Nytt i version 12.4.0.

Det här nyckelordsargumentet introducerades i API-versionen "2019-12-12".

validate_content
bool

Om det är sant beräknas en MD5-hash för varje segment av blobben. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med hashen som skickades. Detta är främst värdefullt för att identifiera bitflips på tråden om http i stället för https, som https (standard), redan verifieras. Observera att denna MD5-hash inte lagras med bloben. Observera också att om den är aktiverad används inte den minneseffektiva uppladdningsalgoritmen eftersom databehandling av MD5-hashen kräver buffring av hela block, och detta minskar syftet med den minneseffektiva algoritmen.

lease
BlobLeaseClient eller str

Krävs om bloben har ett aktivt lån. Om det anges lyckas download_blob endast om blobens lån är aktivt och matchar detta ID. Värdet kan vara ett BlobLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

cpk
CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS. Eftersom själva krypteringsnyckeln anges i begäran måste en säker anslutning upprättas för att överföra nyckeln.

max_concurrency
int

Antalet parallella anslutningar som du kan ladda ned.

encoding
str

Kodning för att avkoda nedladdade byte. Standardvärdet är Ingen, dvs. ingen avkodning.

progress_hook
Callable[[int, int], None]

Ett återanrop för att spåra förloppet för en tidskrävande nedladdning. Signaturen är function(current: int, total: int) där aktuellt är antalet byte som överförts hittills, och summan är den totala storleken på nedladdningen.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här. Den här metoden kan göra flera anrop till tjänsten och tidsgränsen gäller för varje anrop individuellt. flera anrop till Azure-tjänsten och tidsgränsen gäller för varje anrop individuellt.

Returer

Ett strömmande objekt (StorageStreamDownloader)

Returtyp

exists

Returnerar Sant om det finns en container och returnerar False annars.

exists(**kwargs: Any) -> bool

Parametrar

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

boolean

Returtyp

find_blobs_by_tags

Returnerar en generator för att visa blobarna under den angivna containern vars taggar matchar det angivna sökuttrycket. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

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

Parametrar

filter_expression
str
Obligatorisk

Uttrycket för att hitta blobar vars taggar matchar det angivna villkoret. t.ex. ""yourtagname"='firsttag' och "yourtagname2"='secondtag'"

results_per_page
int

Det maximala resultatet per sida vid sidnumrering.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett iterbart svar (automatisk växling) av FilteredBlob.

Returtyp

from_connection_string

Skapa ContainerClient från en anslutningssträng.

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

Parametrar

conn_str
str
Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

container_name
str
Obligatorisk

Containernamnet för bloben.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Det här är valfritt om konto-URL:en redan har en SAS-token, eller om anslutningssträngen redan har värden för delad åtkomstnyckel. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Autentiseringsuppgifterna som anges här har företräde framför dem i anslutningssträngen. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

Returer

En containerklient.

Returtyp

from_container_url

Skapa ContainerClient från en container-URL.

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

Parametrar

container_url
str
Obligatorisk

Den fullständiga slutpunkts-URL:en till containern, inklusive SAS-token om den används. Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på den aktuella location_mode.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Det här är valfritt om konto-URL:en redan har en SAS-token, eller om anslutningssträngen redan har värden för delad åtkomstnyckel. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

  • utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

Returer

En containerklient.

Returtyp

get_account_information

Hämtar information om lagringskontot.

Informationen kan också hämtas om användaren har en SAS till en container eller blob. Nycklarna i den returnerade ordlistan innehåller "sku_name" och "account_kind".

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

Returer

En dikta av kontoinformation (SKU och kontotyp).

Returtyp

get_blob_client

Hämta en klient för att interagera med den angivna bloben.

Bloben behöver inte redan finnas.

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

Parametrar

blob
str eller BlobProperties
Obligatorisk

Den blob som du vill interagera med.

snapshot
str
standardvärde: None

Den valfria blobögonblicksbilden som ska användas. Detta kan vara ögonblicksbildens ID-sträng eller svaret som returneras från create_snapshot.

version_id
str

Parametern versions-ID är ett ogenomskinliga DateTime-värde som när det finns anger vilken version av bloben som ska användas.

Returer

En BlobClient.

Returtyp

get_container_access_policy

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan nås offentligt.

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

Parametrar

lease
BlobLeaseClient eller str

Om det anges lyckas get_container_access_policy bara om containerns lån är aktivt och matchar det här ID:t.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Få åtkomst till principinformation i en dikta.

Returtyp

get_container_properties

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

get_container_properties(**kwargs: Any) -> ContainerProperties

Parametrar

lease
BlobLeaseClient eller str

Om det anges lyckas get_container_properties bara om containerns lån är aktivt och matchar det här ID:t.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Egenskaper för den angivna containern i ett containerobjekt.

Returtyp

list_blob_names

Returnerar en generator för att visa namnen på blobar under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

Observera att inga ytterligare egenskaper eller metadata returneras när du använder det här API:et. Dessutom har det här API:et inte något alternativ för att inkludera ytterligare blobar, till exempel ögonblicksbilder, versioner, mjukt borttagna blobbar osv. Om du vill hämta någon av dessa data använder du list_blobs.

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

Parametrar

name_starts_with
str

Filtrerar resultatet så att endast blobar vars namn börjar med det angivna prefixet returneras.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett iterabelt svar (automatisk växling) av blobnamn som strängar.

Returtyp

list_blobs

Returnerar en generator för att visa blobarna under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

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

Parametrar

name_starts_with
str
Obligatorisk

Filtrerar resultatet så att endast blobar vars namn börjar med det angivna prefixet returneras.

include
list[str] eller str
Obligatorisk

Anger en eller flera ytterligare datauppsättningar som ska ingå i svaret. Alternativen är: "snapshots", "metadata", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett iterabelt svar (automatisk växling) för BlobProperties.

Returtyp

set_container_access_policy

Anger behörigheter för den angivna containern eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om blobar i en container kan nås offentligt.

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

Parametrar

signed_identifiers
dict[str, AccessPolicy]
Obligatorisk

En ordlista med åtkomstprinciper som ska associeras med containern. Ordlistan kan innehålla upp till 5 element. En tom ordlista rensar åtkomstprinciperna som angetts för tjänsten.

public_access
PublicAccess
Obligatorisk

Möjliga värden är: "container", "blob".

lease
BlobLeaseClient eller str

Krävs om containern har ett aktivt lån. Värdet kan vara ett BlobLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since
datetime

Ett datetime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan det angivna datumet/tiden.

if_unmodified_since
datetime

Ett datetime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Container-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

set_container_metadata

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till containern. Om du vill ta bort alla metadata från containern anropar du den här åtgärden utan metadatadiktering.

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

Parametrar

metadata
dict[str, str]
Obligatorisk

En diktamen som innehåller namn/värde-par som ska associeras med containern som metadata. Exempel: {'category':'test'}

lease
BlobLeaseClient eller str

Om det anges lyckas set_container_metadata bara om containerns lån är aktivt och matchar det här ID:t.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Container-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

set_premium_page_blob_tier_blobs

Anger sidblobnivåerna för alla blobar. Det här API:et stöds bara för sidblobar på Premium-konton.

Det maximala antalet blobar som kan uppdateras i en enskild begäran är 256.

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

Parametrar

premium_page_blob_tier
PremiumPageBlobTier
Obligatorisk

Ett sidblobnivåvärde som bloben ska anges till. Nivån korrelerar med storleken på bloben och antalet tillåtna IOPS. Detta gäller endast sidblobar på Premium Storage-konton.

Anteckning

Om du vill ange en annan nivå på olika blobar anger du den här positionsparametern till Ingen.

Sedan tas blobnivån på varje BlobProperties.

blobs
str eller dict(str, Any) eller BlobProperties
Obligatorisk

De blobar som du vill interagera med. Detta kan vara en enda blob, eller så kan flera värden anges, där varje värde antingen är namnet på bloben (str) eller BlobProperties.

Anteckning

När blobtypen är diktamen finns här en lista över nycklar, värderegler.

blobnamn:

key: 'name', value type: str

premiumblobnivå:

key: "blob_tier", värdetyp: PremiumPageBlobTier

Leasing:

key: 'lease_id', value type: Union[str, LeaseClient]

Timeout för underbegäran:

key: 'timeout', value type: int

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

raise_on_any_failure
bool

Det här är en boolesk param som standard är True. När detta anges utlöses ett undantag även om det uppstår ett enskilt åtgärdsfel.

Returer

En iterator av svar, en för varje blob i ordning

Returtyp

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Den här åtgärden anger nivån för blockblobar.

En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag.

Det maximala antalet blobar som kan uppdateras i en enskild begäran är 256.

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

Parametrar

standard_blob_tier
str eller StandardBlobTier
Obligatorisk

Anger vilken nivå som ska anges för alla blobar. Alternativen är "Hot", "Cool", "Archive". Frekvent nivå är optimerad för att lagra data som används ofta. Den lågfrekventa lagringsnivån är optimerad för att lagra data som inte används ofta och som lagras i minst en månad. Arkivnivån är optimerad för att lagra data som sällan används och lagras i minst sex månader med flexibla svarstidskrav.

Anteckning

Om du vill ange en annan nivå för olika blobar anger du den här positionsparametern till Ingen.

Sedan tas blobnivån på varje BlobProperties.

blobs
str eller dict(str, Any) eller BlobProperties
Obligatorisk

De blobar som du vill interagera med. Det kan vara en enda blob, eller så kan flera värden anges, där varje värde antingen är namnet på bloben (str) eller BlobProperties.

Anteckning

Här är en lista över nycklar och värderegler när blobtypen är diktamen.

blobnamn:

key: 'name', value type: str

standardblobnivå:

key: "blob_tier", värdetyp: StandardBlobTier

rehydratprioritet:

key: "rehydrate_priority", värdetyp: RehydratePriority

Leasing:

key: 'lease_id', value type: Union[str, LeaseClient]

Ögonblicksbild:

key: "snapshot", value type: str

versions-ID:

key: "version_id", värdetyp: str

taggar matchar villkor:

key: "if_tags_match_condition", värdetyp: str

Timeout för underbegäran:

key: 'timeout', value type: int

rehydrate_priority
RehydratePriority

Anger med vilken prioritet en arkiverad blob ska extraheras

if_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska användas på blobar med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Ny i version 12.4.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

raise_on_any_failure
bool

Det här är en boolesk param som standard är True. När detta anges utlöses ett undantag även om det uppstår ett enskilt åtgärdsfel.

Returer

En iterator av svar, en för varje blob i ordning

Returtyp

upload_blob

Skapar en ny blob från en datakälla med automatisk 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

Parametrar

name
str eller BlobProperties
Obligatorisk

Bloben som du vill interagera med. Om det här värdet anges åsidosätts ett blobvärde som anges i blob-URL:en.

data
Obligatorisk

De blobdata som ska laddas upp.

blob_type
BlobType
Obligatorisk

Blobens typ. Detta kan vara antingen BlockBlob, PageBlob eller AppendBlob. Standardvärdet är BlockBlob.

length
int
Obligatorisk

Antal byte som ska läsas från strömmen. Detta är valfritt, men bör anges för optimala prestanda.

metadata
dict(str, str)
Obligatorisk

Namn/värde-par som är associerade med bloben som metadata.

overwrite
bool

Om bloben som ska laddas upp ska skriva över aktuella data. Om värdet är Sant skriver upload_blob över befintliga data. Om värdet är False misslyckas åtgärden med ResourceExistsError. Undantaget till ovanstående gäller blobtyper för tillägg: om värdet är Falskt och data redan finns utlöses inget fel och data läggs till i den befintliga bloben. Om du anger overwrite=True tas den befintliga tilläggsbloben bort och en ny skapas. Standardvärdet är False.

content_settings
ContentSettings

ContentSettings-objekt som används för att ange blobegenskaper. Används för att ange innehållstyp, kodning, språk, borttagning, md5 och cachekontroll.

validate_content
bool

Om det är sant beräknas en MD5-hash för varje segment i bloben. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med den hash som skickades. Detta är främst värdefullt för att identifiera bitflips på kabeln om http i stället för https, som https (standard), redan verifieras. Observera att denna MD5-hash inte lagras med bloben. Observera också att om den är aktiverad används inte den minneseffektiva uppladdningsalgoritmen eftersom databehandling av MD5-hashen kräver buffring av hela block, och detta motverkar syftet med den minneseffektiva algoritmen.

lease
BlobLeaseClient eller str

Krävs om containern har ett aktivt lån. Värdet kan vara ett BlobLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag
str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska användas på blobar med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Ny i version 12.4.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här. Den här metoden kan göra flera anrop till tjänsten och tidsgränsen gäller för varje anrop individuellt.

premium_page_blob_tier
PremiumPageBlobTier

Ett sidblobnivåvärde som bloben ska anges till. Nivån korrelerar med storleken på bloben och antalet tillåtna IOPS. Detta gäller endast sidblobar på Premium Storage-konton.

standard_blob_tier
StandardBlobTier

Ett standardblobnivåvärde som bloben ska anges till. För den här versionen av biblioteket gäller detta endast blockblobar på standardlagringskonton.

maxsize_condition
int

Valfritt villkorsstyrt huvud. Den maximala längden i byte som tillåts för tilläggsbloben. Om åtgärden Lägg till block skulle göra att bloben överskrider den gränsen eller om blobstorleken redan är större än värdet som anges i det här huvudet misslyckas begäran med MaxBlobSizeConditionNotMet-fel (HTTP-statuskod 412 – Förutsättningen misslyckades).

max_concurrency
int

Maximalt antal parallella anslutningar som ska användas när blobstorleken överskrider 64 MB.

cpk
CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av nycklar som tillhandahålls av kunden måste göras via HTTPS. Eftersom själva krypteringsnyckeln anges i begäran måste en säker anslutning upprättas för att överföra nyckeln.

encryption_scope
str

Ett fördefinierat krypteringsomfång som används för att kryptera data i tjänsten. Ett krypteringsomfång kan skapas med hjälp av API:et för hantering och refereras här efter namn. Om ett standardkrypteringsomfång har definierats i containern åsidosätter det här värdet det om omfånget på containernivå har konfigurerats för att tillåta åsidosättningar. Annars utlöses ett fel.

Ny i version 12.2.0.

encoding
str

Standardvärdet är UTF-8.

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

Ett återanrop för att spåra förloppet för en tidskrävande uppladdning. Signaturen är function(current: int, total: Optional[int]) där current är det antal byte som överförts hittills, och summan är storleken på bloben eller Ingen om storleken är okänd.

Returer

En BlobClient för att interagera med den nyligen uppladdade bloben.

Returtyp

walk_blobs

Returnerar en generator för att visa blobarna under den angivna containern. Generatorn följer lazily fortsättningstoken som returneras av tjänsten. Den här åtgärden listar blobar i enlighet med en hierarki, som avgränsas av det angivna avgränsartecknet.

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

Parametrar

name_starts_with
str
Obligatorisk

Filtrerar resultatet så att endast blobar vars namn börjar med det angivna prefixet returneras.

include
list[str] eller str
Obligatorisk

Anger en eller flera ytterligare datauppsättningar som ska ingå i svaret. Alternativen är: "snapshots", "metadata", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

delimiter
str
Obligatorisk

När begäran innehåller den här parametern returnerar åtgärden ett BlobPrefix-element i svarstexten som fungerar som platshållare för alla blobar vars namn börjar med samma delsträng upp till avgränsningstecknets utseende. Avgränsaren kan vara ett enskilt tecken eller en sträng.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett iterabelt svar (automatisk sidindelning) för BlobProperties.

Returtyp

Attribut

api_version

Den version av Storage-API:et som används för begäranden.

location_mode

Det platsläge som klienten använder för närvarande.

Som standard är detta "primärt". Alternativen är "primär" och "sekundär".

primary_endpoint

Den fullständiga primära slutpunkts-URL:en.

primary_hostname

Värdnamnet för den primära slutpunkten.

secondary_endpoint

Den fullständiga sekundära slutpunkts-URL:en om den har konfigurerats.

Om den inte är tillgänglig utlöses en ValueError. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

Undantag

secondary_hostname

Värdnamnet för den sekundära slutpunkten.

Om det inte är tillgängligt blir detta Ingen. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

url

Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.

Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell location_mode. :returns: Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används. :rtype: str