BlobClient Klass

En klient som ska interagera med en specifik blob, även om den bloben kanske inte finns ännu.

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

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

Konstruktor

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

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 bloben from_blob_url .

container_name
str
Obligatorisk

Containernamnet för bloben.

blob_name
str
Obligatorisk

Namnet på 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.

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.

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 "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
api_version
str

Lagrings-API-versionen som ska användas för begäranden. Standardvärdet är den senaste tjänstversionen som är kompatibel med den aktuella SDK:en. Om du anger en äldre version kan det leda till minskad funktionskompatibilitet.

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 upp med endast 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 Falskt.

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.

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.

Metoder

abort_copy

Avbryt en pågående kopieringsåtgärd.

Detta lämnar en målblob med noll längd och fullständiga metadata. Detta genererar ett fel om kopieringsåtgärden redan har avslutats.

acquire_lease

Begär ett nytt lån.

Om bloben inte har något aktivt lån skapar Blob Service ett lån för bloben och returnerar ett nytt lån.

append_block

Checkar in ett nytt datablock i slutet av den befintliga tilläggsbloben.

append_block_from_url

Skapar ett nytt block som ska checkas in som en del av en blob, där innehållet läse från en käll-URL.

clear_page

Rensar ett antal sidor.

close

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

commit_block_list

Åtgärden Checka in blockeringslista skriver en blob genom att ange listan över block-ID:t som utgör bloben.

create_append_blob

Skapar en ny tilläggsblob. Den här åtgärden skapar en ny tilläggsblob med 0 längder. Innehållet i en befintlig blob skrivs över med den nyligen initierade tilläggsbloben. Om du vill lägga till innehåll i tilläggsbloben anropar append_block du metoden eller append_block_from_url .

create_page_blob

Skapar en ny sidblob med den angivna storleken.

create_snapshot

Skapar en ögonblicksbild av bloben.

En ögonblicksbild är en skrivskyddad version av en blob som tas vid en tidpunkt. Den kan läsas, kopieras eller tas bort, men inte ändras. Ögonblicksbilder är ett sätt att säkerhetskopiera en blob som den visas just nu.

En ögonblicksbild av en blob har samma namn som den basblob som ögonblicksbilden tas från, med ett DateTime-värde som anger tidpunkten då ögonblicksbilden togs.

delete_blob

Markerar den angivna bloben 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 blobben och behåller bloben under ett angivet antal dagar. Efter det angivna antalet dagar tas blobens data bort från tjänsten under skräpinsamlingen. Mjuk borttagen blob är tillgänglig genom list_blobs att ange alternativet include=['deleted'] . Mjuk borttagen blob kan återställas med hjälp av <xref:azure.storage.blob.undelete> åtgärden.

delete_immutability_policy

Åtgärden Ta bort oföränderlighetsprincip tar bort principen för oföränderlighet på blobben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

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 blob med de definierade parametrarna och returnerar Annars falskt.

from_blob_url

Skapa BlobClient från en blob-URL. Detta stöder inte anpassad blob-URL med "/" i blobnamn.

from_connection_string

Skapa BlobClient från en anslutningssträng.

get_account_information

Hämtar information om lagringskontot där bloben finns.

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_properties

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben.

get_blob_tags

Åtgärden Hämta taggar gör det möjligt för användare att hämta taggar på en blob eller specifik blobversion eller ögonblicksbild.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

get_block_list

Åtgärden Hämta blocklista hämtar listan över block som har laddats upp som en del av en blockblob.

get_page_range_diff_for_managed_disk

Returnerar listan över giltiga sidintervall för en hanterad disk eller ögonblicksbild.

Anteckning

Den här åtgärden är endast tillgänglig för hanterade diskkonton.

Ny i version 12.2.0: Den här åtgärden introducerades i API-versionen "2019-07-07".

get_page_ranges

INAKTUELL: Returnerar listan över giltiga sidintervall för en sidblob eller en ögonblicksbild av en sidblob.

list_page_ranges

Returnerar listan över giltiga sidintervall för en sidblob eller en ögonblicksbild av en sidblob. Om previous_snapshot anges blir resultatet en skillnad mellan målbloben och den tidigare ögonblicksbilden.

query_blob

Gör det möjligt för användare att välja/projicera på blob-/eller blobögonblicksdata genom att tillhandahålla enkla frågeuttryck. De här åtgärderna returnerar en BlobQueryReader, användarna måste använda readall() eller readinto() för att hämta frågedata.

resize_blob

Ändrar storlek på en sidblob till den angivna storleken.

Om det angivna värdet är mindre än blobens aktuella storlek rensas alla sidor ovanför det angivna värdet.

seal_append_blob

Seal-åtgärden förseglar tilläggsbloben så att den blir skrivskyddad.

Ny i version 12.4.0.

set_blob_metadata

Anger användardefinierade metadata för bloben som ett eller flera namn/värde-par.

set_blob_tags

Åtgärden Ange taggar gör det möjligt för användare att ange taggar för en blob eller specifik blobversion, men inte ögonblicksbilder. Varje anrop till den här åtgärden ersätter alla befintliga taggar som är kopplade till bloben. Om du vill ta bort alla taggar från bloben anropar du den här åtgärden utan att några taggar har angetts.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

set_http_headers

Anger systemegenskaper för bloben.

Om en egenskap anges för content_settings åsidosätts alla egenskaper.

set_immutability_policy

Åtgärden Ange oföränderlighetsprincip anger oföränderlighetsprincipen för bloben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

set_legal_hold

Åtgärden Ange bevarande av juridiska skäl anger ett juridiskt undantag för bloben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

set_premium_page_blob_tier

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

set_sequence_number

Anger blobsekvensnumret.

set_standard_blob_tier

Den här åtgärden anger nivån på en blockblob.

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

stage_block

Skapar ett nytt block som ska checkas in som en del av en blob.

stage_block_from_url

Skapar ett nytt block som ska checkas in som en del av en blob där innehållet läse från en URL.

start_copy_from_url

Kopierar en blob från den angivna URL:en.

Den här åtgärden returnerar en ordlista som innehåller copy_status och copy_id, som kan användas för att kontrollera status för eller avbryta kopieringsåtgärden. copy_status "lyckas" om kopian har slutförts synkront eller "väntar" om kopian har startats asynkront. För asynkrona kopior kan statusen kontrolleras genom att metoden avsöks get_blob_properties och kopieringsstatusen kontrolleras. Ange requires_sync till True för att tvinga kopiappen att vara synkron. Blob-tjänsten kopierar blobar efter bästa förmåga.

Källbloben för en kopieringsåtgärd kan vara en blockblob, en tilläggsblob eller en sidblob. Om målbloben redan finns måste den vara av samma blobtyp som källbloben. Alla befintliga målblobar skrivs över. Det går inte att ändra målbloben när en kopieringsåtgärd pågår.

När du kopierar från en sidblob skapar Blob Service en målsideblob med källblobens längd, som ursprungligen innehåller alla nolla. Sedan räknas källsidans intervall upp och icke-tomma intervall kopieras.

För en blockblob eller en tilläggsblob skapar Blob Service en allokerad blob med noll längd innan den returneras från den här åtgärden. När du kopierar från en blockblob kopieras alla incheckade block och deras block-ID:t. Ogenomförda block kopieras inte. I slutet av kopieringsåtgärden har målbloben samma bekräftade blockantal som källan.

När du kopierar från en tilläggsblob kopieras alla incheckade block. I slutet av kopieringsåtgärden har målbloben samma bekräftade blockantal som källan.

undelete_blob

Återställer mjukt borttagna blobar eller ögonblicksbilder.

Åtgärden lyckas endast om den används inom det angivna antalet dagar som anges i kvarhållningsprincipen för borttagning.

Om versionshantering av blob är aktiverat går det inte att återställa basbloben med den här metoden. Använd start_copy_from_url i stället med URL:en för den blobversion som du vill flytta upp till den aktuella versionen.

upload_blob

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

upload_blob_from_url

Skapar en ny blockblob där innehållet i bloben läse från en viss URL. Innehållet i en befintlig blob skrivs över med den nya bloben.

upload_page

Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob.

upload_pages_from_url

Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob där innehållet läse från en URL.

abort_copy

Avbryt en pågående kopieringsåtgärd.

Detta lämnar en målblob med noll längd och fullständiga metadata. Detta genererar ett fel om kopieringsåtgärden redan har avslutats.

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

Parametrar

copy_id
str eller BlobProperties
Obligatorisk

Kopieringsåtgärden som ska avbrytas. Detta kan vara antingen en ID-sträng eller en instans av BlobProperties.

Returtyp

acquire_lease

Begär ett nytt lån.

Om bloben inte har något aktivt lån skapar Blob Service ett lån för bloben och returnerar ett nytt lån.

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

Parametrar

lease_duration
int
Obligatorisk

Anger varaktigheten för lånet, 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 lånetiden med 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 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.

Returer

Ett BlobLeaseClient-objekt.

Returtyp

append_block

Checkar in ett nytt datablock i slutet av den befintliga tilläggsbloben.

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

Parametrar

data
bytes eller str eller Iterable
Obligatorisk

Innehållet i blocket. Detta kan vara byte, text, ett iterbart eller ett filliknande objekt.

length
int
Obligatorisk

Storleken på blocket i byte.

validate_content
bool

Om det är sant beräknas en MD5-hash för blockinnehållet. 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.

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 det värde som anges i det här huvudet misslyckas begäran med Felet MaxBlobSizeConditionNotMet (HTTP-statuskod 412 – Villkoret misslyckades).

appendpos_condition
int

Valfritt villkorshuvud som endast används för åtgärden Lägg till block. Ett tal som anger byteförskjutningen som ska jämföras. Tilläggsblocket lyckas bara om tilläggspositionen är lika med det här talet. Om den inte är det misslyckas begäran med felet AppendPositionConditionNotMet (HTTP-statuskod 412 – Förhandsvillkoret misslyckades).

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 ä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.

encoding
str

Standardvärdet är UTF-8.

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.

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

Blob-uppdaterad egenskapsdikt (Etag, senast ändrad, tilläggsförskjutning, bekräftat blockantal).

Returtyp

append_block_from_url

Skapar ett nytt block som ska checkas in som en del av en blob, där innehållet läse från en käll-URL.

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

Parametrar

copy_source_url
str
Obligatorisk

URL:en för källdata. Den kan peka på valfri Azure-blobb eller -fil, som antingen är offentlig eller har en signatur för delad åtkomst kopplad.

source_offset
int
Obligatorisk

Detta anger början av intervallet med byte (inklusive) som måste hämtas från kopieringskällan.

source_length
int
Obligatorisk

Detta anger slutet på byteintervallet som måste hämtas från kopieringskällan.

source_content_md5
bytearray

Om det anges beräknar tjänsten MD5-hashen för blockinnehållet och jämför med det här värdet.

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

appendpos_condition
int

Valfritt villkorsstyrt huvud, som endast används för åtgärden Lägg till block. Ett tal som anger byteförskjutningen som ska jämföras. Tilläggsblocket lyckas bara om tilläggspositionen är lika med det här talet. Om den inte är det misslyckas begäran med felet AppendPositionConditionNotMet (HTTP-statuskod 412 – Förhandsvillkoret misslyckades).

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

Målets 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

Målmatchningsvillkoret 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.

source_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 källresursen har ändrats sedan den angivna tiden.

source_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 källresursen inte har ändrats sedan det angivna datumet/tiden.

source_etag
str

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

source_match_condition
MatchConditions

Källmatchningsvillkoret som ska användas på etag.

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.

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.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för strängen source_authorization.

clear_page

Rensar ett antal sidor.

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

Parametrar

offset
int
Obligatorisk

Start av byteintervall som ska användas för att skriva till ett avsnitt i bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int
Obligatorisk

Antal byte som ska användas för att skriva till ett avsnitt i bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

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_sequence_number_lte
int

Om blobens sekvensnummer är mindre än eller lika med det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_lt
int

Om blobens sekvensnummer är mindre än det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_eq
int

Om blobens sekvensnummer är lika med det angivna värdet fortsätter begäran. annars misslyckas det.

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.

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

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

Returtyp

close

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

close()

commit_block_list

Åtgärden Checka in blockeringslista skriver en blob genom att ange listan över block-ID:t som utgör bloben.

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

Parametrar

block_list
list
Obligatorisk

Lista över Blockblobs.

content_settings
ContentSettings
Obligatorisk

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

metadata
dict[str, str]
Obligatorisk

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

tags
dict(str, str)

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklarna måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

Nytt i version 12.4.0.

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.

immutability_policy
ImmutabilityPolicy

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

legal_hold
bool

Anges om ett bevarande av juridiska skäl ska anges på bloben.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

validate_content
bool

Om det är sant beräknar du en MD5-hash för sidinnehållet. 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.

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 fungera på målbloben med ett matchande värde.

Nytt i version 12.4.0.

standard_blob_tier
StandardBlobTier

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

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.

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 hanterings-API:et 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.

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

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

Returtyp

create_append_blob

Skapar en ny tilläggsblob. Den här åtgärden skapar en ny tilläggsblob med 0 längder. Innehållet i en befintlig blob skrivs över med den nyligen initierade tilläggsbloben. Om du vill lägga till innehåll i tilläggsbloben anropar append_block du metoden eller append_block_from_url .

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

Parametrar

content_settings
ContentSettings
Obligatorisk

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

metadata
dict(str, str)
Obligatorisk

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

tags
dict(str, str)

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklarna måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

Nytt i version 12.4.0.

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.

immutability_policy
ImmutabilityPolicy

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

legal_hold
bool

Anges om ett bevarande av juridiska skäl ska anges på bloben.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

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.

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.

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 hanterings-API:et 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.

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

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

Returtyp

create_page_blob

Skapar en ny sidblob med den angivna storleken.

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

Parametrar

size
int
Obligatorisk

Detta anger den maximala storleken för sidbloben, upp till 1 TB. Sidblobens storlek måste justeras till en gräns på 512 byte.

content_settings
ContentSettings
Obligatorisk

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

metadata
dict(str, str)
Obligatorisk

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

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.

tags
dict(str, str)

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklarna måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

Nytt i version 12.4.0.

sequence_number
int

Endast för sidblobar. Sekvensnumret är ett användarstyrt värde som du kan använda för att spåra begäranden. Värdet för sekvensnumret måste vara mellan 0 och 2^63 – 1. Standardvärdet är 0.

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.

immutability_policy
ImmutabilityPolicy

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

legal_hold
bool

Anges om ett bevarande av juridiska skäl ska anges på bloben.

Ny i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

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.

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.

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 hanterings-API:et 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.

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

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

Returtyp

create_snapshot

Skapar en ögonblicksbild av bloben.

En ögonblicksbild är en skrivskyddad version av en blob som tas vid en tidpunkt. Den kan läsas, kopieras eller tas bort, men inte ändras. Ögonblicksbilder är ett sätt att säkerhetskopiera en blob som den visas just nu.

En ögonblicksbild av en blob har samma namn som den basblob som ögonblicksbilden tas från, med ett DateTime-värde som anger tidpunkten då ögonblicksbilden togs.

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

Parametrar

metadata
dict(str, str)
Obligatorisk

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

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 fungera på målbloben med ett matchande värde.

Nytt i version 12.4.0.

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.

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.

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 hanterings-API:et 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.

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

Blob-uppdaterad egenskapsdikt (ögonblicksbilds-ID, Etag och senast ändrad).

Returtyp

delete_blob

Markerar den angivna bloben 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 blobben och behåller bloben under ett angivet antal dagar. Efter det angivna antalet dagar tas blobens data bort från tjänsten under skräpinsamlingen. Mjuk borttagen blob är tillgänglig genom list_blobs att ange alternativet include=['deleted'] . Mjuk borttagen blob kan återställas med hjälp av <xref:azure.storage.blob.undelete> åtgärden.

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

Parametrar

delete_snapshots
str
Obligatorisk

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

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

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

version_id
str

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

Nytt 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. Om det anges lyckas delete_blob bara 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.

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_immutability_policy

Åtgärden Ta bort oföränderlighetsprincip tar bort principen för oföränderlighet på blobben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

delete_immutability_policy(**kwargs: Any) -> None

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

Nyckelvärdepar med blobtaggar.

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(offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Parametrar

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 blob med de definierade parametrarna och returnerar Annars falskt.

exists(**kwargs: Any) -> bool

Parametrar

version_id
str

Parametern versions-ID är ett ogenomskinliga DateTime-värde som när det finns anger versionen av blobben för att kontrollera om den finns.

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

from_blob_url

Skapa BlobClient från en blob-URL. Detta stöder inte anpassad blob-URL med "/" i blobnamn.

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

Parametrar

blob_url
str
Obligatorisk

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

credential
Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
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äng redan har nyckelvärden för delad åtkomst. 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.
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. Om det anges åsidosätter detta ögonblicksbilden i URL:en.

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 Blob-klient.

Returtyp

from_connection_string

Skapa BlobClient från en anslutningssträng.

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

Parametrar

conn_str
str
Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

container_name
str
Obligatorisk

Containernamnet för bloben.

blob_name
str
Obligatorisk

Namnet på 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.

credential
Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
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äng redan har nyckelvärden för delad åtkomst. 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äng. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

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 Blob-klient.

Returtyp

get_account_information

Hämtar information om lagringskontot där bloben finns.

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_properties

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parametrar

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.

version_id
str

Parametern versions-ID är ett ogenomskinliga DateTime-värde som när det finns anger versionen av blobben för att hämta egenskaper.

Nytt i version 12.4.0.

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

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.

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

BlobEgenskaper

Returtyp

get_blob_tags

Åtgärden Hämta taggar gör det möjligt för användare att hämta taggar på en blob eller specifik blobversion eller ögonblicksbild.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

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

Parametrar

version_id
str

Parametern versions-ID är ett ogenomskinliga DateTime-värde som när det finns anger den version av bloben som taggar ska läggas till i.

if_tags_match_condition
str

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

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.

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

Nyckelvärdepar med blobtaggar.

Returtyp

get_block_list

Åtgärden Hämta blocklista hämtar listan över block som har laddats upp som en del av en blockblob.

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

Parametrar

block_list_type
str
Obligatorisk

Anger om listan över bekräftade block, listan över icke-bekräftade block eller båda listorna ska returneras tillsammans. Möjliga värden är: "committed", "uncommitted", "all"

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_tags_match_condition
str

Ange en SQL where-sats för blobtaggar som endast ska fungera på målbloben med ett matchande värde.

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.

Returer

En tuppeln med två listor – incheckade och ej bekräftade block

Returtyp

get_page_range_diff_for_managed_disk

Returnerar listan över giltiga sidintervall för en hanterad disk eller ögonblicksbild.

Anteckning

Den här åtgärden är endast tillgänglig för hanterade diskkonton.

Ny i version 12.2.0: Den här åtgärden introducerades i API-versionen "2019-07-07".

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

Parametrar

previous_snapshot_url
Obligatorisk

Anger URL:en för en tidigare ögonblicksbild av den hanterade disken. Svaret innehåller bara sidor som har ändrats mellan målbloben och dess tidigare ögonblicksbild.

offset
int
Obligatorisk

Start av byteintervall som ska användas för att hämta giltiga sidintervall. Om ingen längd anges genomsöks alla byte efter förskjutningen. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int
Obligatorisk

Antal byte som ska användas för att hämta giltiga sidintervall. Om längden anges måste förskjutningen anges. Det här intervallet returnerar giltiga sidintervall från förskjutningens start till den angivna längden. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

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

En tuppeln med två listor med sidintervall som ordlistor med "start- och slutnycklar". Det första elementet är ifyllda sidintervall. Det andra elementet är rensade sidintervall.

Returtyp

get_page_ranges

INAKTUELL: Returnerar listan över giltiga sidintervall för en sidblob eller en ögonblicksbild av en sidblob.

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

Parametrar

offset
int
Obligatorisk

Start av byteintervall som ska användas för att hämta giltiga sidintervall. Om ingen längd anges genomsöks alla byte efter förskjutningen. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int
Obligatorisk

Antal byte som ska användas för att hämta giltiga sidintervall. Om längden anges måste förskjutningen anges. Det här intervallet returnerar giltiga sidintervall från förskjutningens start till den angivna längden. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

previous_snapshot_diff
str
Obligatorisk

Parametern för ögonblicksbildsavgränsning som innehåller ett ogenomskinligt DateTime-värde som anger att en tidigare blobögonblicksbild ska jämföras med en nyare ögonblicksbild eller den aktuella bloben.

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 ä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.

Returer

En tuppeln med två listor med sidintervall som ordlistor med "start- och slutnycklar". Det första elementet är ifyllda sidintervall. Det andra elementet är rensade sidintervall.

Returtyp

list_page_ranges

Returnerar listan över giltiga sidintervall för en sidblob eller en ögonblicksbild av en sidblob. Om previous_snapshot anges blir resultatet en skillnad mellan målbloben och den tidigare ögonblicksbilden.

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

Parametrar

offset
int

Start av byteintervall som ska användas för att hämta giltiga sidintervall. Om ingen längd anges genomsöks alla byte efter förskjutningen. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int

Antal byte som ska användas för att hämta giltiga sidintervall. Om längden anges måste förskjutningen anges. Det här intervallet returnerar giltiga sidintervall från förskjutningens start till den angivna längden. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

previous_snapshot
str eller Dict[str, Any]

Ett värde för ögonblicksbilder som anger att svaret endast innehåller sidor som har ändrats mellan målbloben och den tidigare ögonblicksbilden. Ändrade sidor innehåller både uppdaterade och rensade sidor. Målbloben kan vara en ögonblicksbild, förutsatt att ögonblicksbilden som anges av previous_snapshot är äldre av de två.

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 ä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.

results_per_page
int

Det maximala antalet sidintervall som ska hämtas per API-anrop.

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 iterabel (automatisk sidindelning) av PageRange.

Returtyp

query_blob

Gör det möjligt för användare att välja/projicera på blob-/eller blobögonblicksdata genom att tillhandahålla enkla frågeuttryck. De här åtgärderna returnerar en BlobQueryReader, användarna måste använda readall() eller readinto() för att hämta frågedata.

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

Parametrar

query_expression
str
Obligatorisk

Krävs. en frågeuttryck. Mer information finns i: https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error
Callable[BlobQueryError]

En funktion som ska anropas för alla bearbetningsfel som returneras av tjänsten.

blob_format
DelimitedTextDialect eller DelimitedJsonDialect eller QuickQueryDialect eller str

Valfritt. Definierar serialiseringen av de data som för närvarande lagras i bloben. Standardvärdet är att behandla blobdata som CSV-data formaterade i standarddialekten. Detta kan åsidosättas med en anpassad DelimitedTextDialect eller DelimitedJsonDialect eller "ParquetDialect" (skickas som en sträng eller uppräkning). Dessa dialekter kan skickas genom deras respektive klasser, QuickQueryDialect-uppräkningen eller som en sträng

output_format
DelimitedTextDialect eller DelimitedJsonDialect eller list[ArrowDialect] eller QuickQueryDialect eller str

Valfritt. Definierar utdataserialiseringen för dataströmmen. Som standard returneras data som de representeras i bloben (Parquet-format är som standard DelimitedTextDialect). Genom att tillhandahålla ett utdataformat formateras blobdata om enligt den profilen. Det här värdet kan vara en AvgränsadTextDialect eller en DelimitedJsonDialect eller ArrowDialect. Dessa dialekter kan skickas genom deras respektive klasser, QuickQueryDialect-uppräkningen eller som en sträng

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 ä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.

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.

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 strömmande objekt (BlobQueryReader)

Returtyp

resize_blob

Ändrar storlek på en sidblob till den angivna storleken.

Om det angivna värdet är mindre än blobens aktuella storlek rensas alla sidor ovanför det angivna värdet.

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

Parametrar

size
int
Obligatorisk

Storlek som används för att ändra storlek på blob. Maximal storlek för en sidblob är upp till 1 TB. Sidblobstorleken måste justeras till en gräns på 512 byte.

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 ä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.

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.

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

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

Returtyp

seal_append_blob

Seal-åtgärden förseglar tilläggsbloben så att den blir skrivskyddad.

Ny i version 12.4.0.

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

Parametrar

appendpos_condition
int

Valfritt villkorsstyrt huvud, som endast används för åtgärden Lägg till block. Ett tal som anger byteförskjutningen som ska jämföras. Tilläggsblocket lyckas bara om tilläggspositionen är lika med det här talet. Om den inte är det misslyckas begäran med felet AppendPositionConditionNotMet (HTTP-statuskod 412 – Förhandsvillkoret misslyckades).

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

Blob-uppdaterad egenskapsdikt (Etag, senast ändrad, tilläggsförskjutning, bekräftat blockantal).

Returtyp

set_blob_metadata

Anger användardefinierade metadata för bloben som ett eller flera namn/värde-par.

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

Parametrar

metadata
dict(str, str)
Obligatorisk

Diktamen innehåller namn- och värdepar. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till bloben. Om du vill ta bort alla metadata från bloben anropar du den här åtgärden utan metadatarubriker.

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 ä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.

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.

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

Blob-uppdaterad egenskapsdikt (Etag och senast ändrad)

set_blob_tags

Åtgärden Ange taggar gör det möjligt för användare att ange taggar för en blob eller specifik blobversion, men inte ögonblicksbilder. Varje anrop till den här åtgärden ersätter alla befintliga taggar som är kopplade till bloben. Om du vill ta bort alla taggar från bloben anropar du den här åtgärden utan att några taggar har angetts.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

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

Parametrar

tags
dict(str, str)
Obligatorisk

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

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 taggar ska läggas till i.

validate_content
bool

Om det är sant beräknas en MD5-hash för taggarnas innehåll. 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.

if_tags_match_condition
str

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

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.

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

Blob-uppdaterad egenskapsdikt (Etag och senast ändrad)

Returtyp

set_http_headers

Anger systemegenskaper för bloben.

Om en egenskap anges för content_settings åsidosätts alla egenskaper.

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

Parametrar

content_settings
ContentSettings
Obligatorisk

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.

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 ä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.

Returer

Blob-uppdaterad egenskapsdikt (Etag och senast ändrad)

Returtyp

set_immutability_policy

Åtgärden Ange oföränderlighetsprincip anger oföränderlighetsprincipen för bloben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

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

Parametrar

immutability_policy
ImmutabilityPolicy
Obligatorisk

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion.

Nytt i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

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

Nyckelvärdepar för blobtaggar.

Returtyp

Åtgärden Ange bevarande av juridiska skäl anger ett juridiskt undantag för bloben.

Ny i version 12.10.0: Den här åtgärden introducerades i API-versionen "2020-10-02".

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

Parametrar

legal_hold
bool
Obligatorisk

Anges om ett bevarande av juridiska skäl ska anges för bloben.

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

Nyckelvärdepar med blobtaggar.

Returtyp

set_premium_page_blob_tier

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

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

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.

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.

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.

Returtyp

set_sequence_number

Anger blobsekvensnumret.

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

Parametrar

sequence_number_action
str
Obligatorisk

Den här egenskapen anger hur tjänsten ska ändra blobens sekvensnummer. Mer information finns i SequenceNumberAction.

sequence_number
str
Obligatorisk

Den här egenskapen anger blobens sekvensnummer. Sekvensnumret är en användarkontrollerad egenskap som du kan använda för att spåra begäranden och hantera samtidighetsproblem.

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.

Returer

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

Returtyp

set_standard_blob_tier

Den här åtgärden anger nivån på en blockblob.

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

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

Parametrar

standard_blob_tier
str eller StandardBlobTier
Obligatorisk

Anger den nivå som ska anges på bloben. Alternativen är "Hot", "Cool", "Archive". Frekvent nivå är optimerad för lagring av data som används ofta. Lågfrekvent lagringsnivå är optimerad för lagring av data som inte används sällan och som lagras i minst en månad. Arkivnivån är optimerad för lagring av data som sällan används och lagras i minst sex månader med flexibla svarstider.

rehydrate_priority
RehydratePriority

Anger med vilken prioritet en arkiverad blob ska extraheras

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".

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.

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.

Returtyp

stage_block

Skapar ett nytt block som ska checkas in som en del av en blob.

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

Parametrar

block_id
str
Obligatorisk

Ett strängvärde som identifierar blocket. Strängen ska vara mindre än eller lika med 64 byte i storlek. För en viss blob måste block_id ha samma storlek för varje block.

data
Obligatorisk

Blobdata.

length
int
Obligatorisk

Storleken på blocket.

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. Värdet kan vara ett BlobLeaseClient-objekt eller låne-ID:t som en sträng.

encoding
str

Standardvärdet ÄR UTF-8.

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.

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 hanterings-API:et 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.

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

Diktering av blobegenskap.

Returtyp

stage_block_from_url

Skapar ett nytt block som ska checkas in som en del av en blob där innehållet läse från en URL.

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

Parametrar

block_id
str
Obligatorisk

Ett strängvärde som identifierar blocket. Strängen ska vara mindre än eller lika med 64 byte i storlek. För en viss blob måste block_id ha samma storlek för varje block.

source_url
str
Obligatorisk

URL:en.

source_offset
int
Obligatorisk

Start av byteintervall som ska användas för blocket. Måste anges om källlängden anges.

source_length
int
Obligatorisk

Storleken på blocket i byte.

source_content_md5
bytearray
Obligatorisk

Ange md5 som beräknas för det byteintervall som måste läsas från kopieringskällan.

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.

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.

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.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för strängen source_authorization.

Returer

Blobegenskapsdikt.

Returtyp

start_copy_from_url

Kopierar en blob från den angivna URL:en.

Den här åtgärden returnerar en ordlista som innehåller copy_status och copy_id, som kan användas för att kontrollera status för eller avbryta kopieringsåtgärden. copy_status "lyckas" om kopian har slutförts synkront eller "väntar" om kopian har startats asynkront. För asynkrona kopior kan statusen kontrolleras genom att metoden avsöks get_blob_properties och kopieringsstatusen kontrolleras. Ange requires_sync till True för att tvinga kopiappen att vara synkron. Blob-tjänsten kopierar blobar efter bästa förmåga.

Källbloben för en kopieringsåtgärd kan vara en blockblob, en tilläggsblob eller en sidblob. Om målbloben redan finns måste den vara av samma blobtyp som källbloben. Alla befintliga målblobar skrivs över. Det går inte att ändra målbloben när en kopieringsåtgärd pågår.

När du kopierar från en sidblob skapar Blob Service en målsideblob med källblobens längd, som ursprungligen innehåller alla nolla. Sedan räknas källsidans intervall upp och icke-tomma intervall kopieras.

För en blockblob eller en tilläggsblob skapar Blob Service en allokerad blob med noll längd innan den returneras från den här åtgärden. När du kopierar från en blockblob kopieras alla incheckade block och deras block-ID:t. Ogenomförda block kopieras inte. I slutet av kopieringsåtgärden har målbloben samma bekräftade blockantal som källan.

När du kopierar från en tilläggsblob kopieras alla incheckade block. I slutet av kopieringsåtgärden har målbloben samma bekräftade blockantal som källan.

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

Parametrar

source_url
str
Obligatorisk

En URL på upp till 2 kB som anger en fil eller blob. Värdet ska vara URL-kodat som det skulle visas i en begärande-URI. Om källan finns i ett annat konto måste källan antingen vara offentlig eller autentiseras via en signatur för delad åtkomst. Om källan är offentlig krävs ingen autentisering. Exempel: https://myaccount.blob.core.windows.net/mycontainer/myblob

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

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

metadata
dict(str, str)
Obligatorisk

Namn/värde-par som är associerade med bloben som metadata. Om inga namn/värde-par anges kopierar åtgärden metadata från källbloben eller -filen till målbloben. Om ett eller flera namn/värde-par anges skapas målbloben med angivna metadata och metadata kopieras inte från källbloben eller -filen.

incremental_copy
bool
Obligatorisk

Kopierar ögonblicksbilden av källsidans blob till en målsidesblob. Ögonblicksbilden kopieras så att endast de differentiella ändringarna mellan den tidigare kopierade ögonblicksbilden överförs till målet. De kopierade ögonblicksbilderna är fullständiga kopior av den ursprungliga ögonblicksbilden och kan läsas eller kopieras från som vanligt. Standardvärdet är False.

tags
dict(str, str) eller Literal["COPY"]

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_).

Den (skiftlägeskänsliga) literalen "COPY" kan i stället skickas för att kopiera taggar från källbloben. Det här alternativet är endast tillgängligt när incremental_copy=Falskt och requires_sync=Sant.

Ny i version 12.4.0.

immutability_policy
ImmutabilityPolicy

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion.

Nytt i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

legal_hold
bool

Anges om ett bevarande av juridiska skäl ska anges för bloben.

Nytt i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

source_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 den här villkorliga rubriken för att kopiera bloben endast om källbloben har ändrats sedan det angivna datumet/tiden.

source_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 den här villkorliga rubriken för att kopiera bloben endast om källbloben inte har ändrats sedan det angivna datumet/tiden.

source_etag
str

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

source_match_condition
MatchConditions

Källmatchningsvillkoret som ska användas på etag.

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 den här villkorliga rubriken för att kopiera bloben endast om målbloben har ändrats sedan det angivna datumet/tiden. Om målbloben inte har ändrats returnerar Blob Service statuskod 412 (Förhandsvillkoret misslyckades).

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 den här villkorliga rubriken för att kopiera bloben endast om målbloben inte har ändrats sedan det angivna datumet/tiden. Om målbloben har ändrats returnerar Blob Service statuskod 412 (förhandsvillkoret misslyckades).

etag
str

Målets 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

Målmatchningsvillkoret som ska användas på etag.

destination_lease
BlobLeaseClient eller str

Låne-ID:t som angetts för den här rubriken måste matcha låne-ID:t för målbloben. Om begäran inte innehåller låne-ID:t eller om det inte är giltigt misslyckas åtgärden med statuskod 412 (Förhandsvillkoret misslyckades).

source_lease
BlobLeaseClient eller str

Ange detta för att endast utföra åtgärden Kopiera blob om det angivna låne-ID:t matchar källblobens aktiva låne-ID.

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.

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.

rehydrate_priority
RehydratePriority

Anger med vilken prioritet en arkiverad blob ska extraheras

seal_destination_blob
bool

Försegla mål-tilläggsbloben. Den här åtgärden gäller endast för tilläggsblob.

Ny i version 12.4.0.

requires_sync
bool

Framtvingar att tjänsten inte returnerar ett svar förrän kopian har slutförts.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för strängen source_authorization. Det här alternativet är endast tillgängligt när incremental_copy är inställt på Falskt och requires_sync är inställt på Sant.

Ny i version 12.9.0.

encryption_scope
str

Ett fördefinierat krypteringsomfång som används för att kryptera data i den synkroniseringskopierade bloben. 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.10.0.

Returer

En ordlista med kopieringsegenskaper (etag, last_modified, copy_id, copy_status).

Returtyp

undelete_blob

Återställer mjukt borttagna blobar eller ögonblicksbilder.

Åtgärden lyckas endast om den används inom det angivna antalet dagar som anges i kvarhållningsprincipen för borttagning.

Om versionshantering av blob är aktiverat går det inte att återställa basbloben med den här metoden. Använd start_copy_from_url i stället med URL:en för den blobversion som du vill flytta upp till den aktuella versionen.

undelete_blob(**kwargs: Any) -> None

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.

Returtyp

upload_blob

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

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

Parametrar

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.

tags
dict(str, str)

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

Ny i version 12.4.0.

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 bloben har ett aktivt lån. Om det anges lyckas upload_blob bara 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 ä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.

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.

immutability_policy
ImmutabilityPolicy

Anger oföränderlighetsprincipen för en blob- eller blobögonblicksbild eller blobversion. För närvarande är den här parametern för upload_blob() API endast för BlockBlob.

Nytt i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

legal_hold
bool

Anges om ett bevarande av juridiska skäl ska anges för bloben. För närvarande är den här parametern för upload_blob() API endast för BlockBlob.

Nytt i version 12.10.0: Detta introducerades i API-versionen "2020-10-02".

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.

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.

Returer

Blob-uppdaterad egenskapsdikt (Etag och senast ändrad)

Returtyp

upload_blob_from_url

Skapar en ny blockblob där innehållet i bloben läse från en viss URL. Innehållet i en befintlig blob skrivs över med den nya bloben.

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

Parametrar

source_url
str
Obligatorisk

En URL på upp till 2 kB som anger en fil eller blob. Värdet ska vara URL-kodat som det skulle visas i en begärande-URI. Om källan finns i ett annat konto måste källan antingen vara offentlig eller autentiseras via en signatur för delad åtkomst. Om källan är offentlig krävs ingen autentisering. Exempel: https://myaccount.blob.core.windows.net/mycontainer/myblob

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

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

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.

include_source_blob_properties
bool

Anger om egenskaper från källbloben ska kopieras. Standardvärdet är True.

tags
dict(str, str)

Namn/värde-par som är associerade med bloben som tagg. Taggar är skiftlägeskänsliga. Tagguppsättningen kan innehålla högst 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken och taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken är: gemener och versaler, siffror (0–9), blanksteg ( >><<), plus (+), minus (-), punkt (.), solidus (/), kolon (:), lika med (=), understreck (_)

source_content_md5
bytearray

Ange den md5 som används för att verifiera integriteten för källbytena.

source_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 källresursen har ändrats sedan den angivna tiden.

source_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 källresursen inte har ändrats sedan det angivna datumet/tiden.

source_etag
str

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

source_match_condition
MatchConditions

Källmatchningsvillkoret som ska användas på etag.

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

Målets 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

Målmatchningsvillkoret som ska användas på etag.

destination_lease
BlobLeaseClient eller str

Låne-ID:t som angetts för den här rubriken måste matcha låne-ID:t för målbloben. Om begäran inte innehåller låne-ID:t eller om det inte är giltigt misslyckas åtgärden med statuskod 412 (Förhandsvillkoret misslyckades).

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.

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.

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.

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.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för strängen source_authorization.

upload_page

Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob.

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

Parametrar

page
bytes
Obligatorisk

Innehållet på sidan.

offset
int
Obligatorisk

Start av byteintervall som ska användas för att skriva till ett avsnitt i bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int
Obligatorisk

Antal byte som ska användas för att skriva till ett avsnitt i bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

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.

validate_content
bool

Om det är sant beräknas en MD5-hash för sidinnehållet. 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.

if_sequence_number_lte
int

Om blobens sekvensnummer är mindre än eller lika med det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_lt
int

Om blobens sekvensnummer är mindre än det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_eq
int

Om blobens sekvensnummer är lika med det angivna värdet fortsätter begäran. annars misslyckas det.

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.

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 hanterings-API:et 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.

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

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

Returtyp

upload_pages_from_url

Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob där innehållet läse från en URL.

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

Parametrar

source_url
str
Obligatorisk

URL:en för källdata. Den kan peka på valfri Azure-blob eller -fil, som antingen är offentlig eller har en signatur för delad åtkomst kopplad.

offset
int
Obligatorisk

Start av byteintervall som ska användas för att skriva till en del av bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

length
int
Obligatorisk

Antal byte som ska användas för att skriva till ett avsnitt i bloben. Sidorna måste vara justerade med gränser på 512 byte, startförskjutningen måste vara en modulus på 512 och längden måste vara en modulus på 512.

source_offset
int
Obligatorisk

Detta anger början på intervallet byte (inklusive) som måste tas från kopieringskällan. Tjänsten läser samma antal byte som målintervallet (längdförskjutning).

source_content_md5
bytes

Om det anges beräknar tjänsten MD5-hashen för blockinnehållet och jämför med det här värdet.

source_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 källresursen har ändrats sedan den angivna tiden.

source_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 källresursen inte har ändrats sedan det angivna datumet/tiden.

source_etag
str

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

source_match_condition
MatchConditions

Källmatchningsvillkoret som ska användas på etag.

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_sequence_number_lte
int

Om blobens sekvensnummer är mindre än eller lika med det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_lt
int

Om blobens sekvensnummer är mindre än det angivna värdet fortsätter begäran. annars misslyckas det.

if_sequence_number_eq
int

Om blobens sekvensnummer är lika med det angivna värdet fortsätter begäran. annars misslyckas det.

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

Målets 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

Målmatchningsvillkoret 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.

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 hanterings-API:et 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.

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.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för source_authorization sträng.

Attribut

api_version

Den version av lagrings-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 det 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