Megosztás a következőn keresztül:


ContainerClient Osztály

Egy adott tárolóval kommunikáló ügyfél, bár előfordulhat, hogy ez a tároló még nem létezik.

A tárolón belül egy adott blobhoz kapcsolódó műveletek esetén a blobügyfél lekérhető a get_blob_client függvénnyel.

További választható konfigurációért kattintson ide.

Öröklődés
azure.storage.blob._shared.base_client.StorageAccountHostsMixin
ContainerClient
azure.storage.blob._encryption.StorageEncryptionMixin
ContainerClient

Konstruktor

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

Paraméterek

account_url
str
Kötelező

A tárfiók URI-ja. A tároló teljes URI-jának megfelelő ügyfél létrehozásához használja a from_container_url classmethod osztályt.

container_name
str
Kötelező

A blob tárolójának neve.

credential
alapértelmezett érték: None

A hitelesítéshez használt hitelesítő adatok. Ez nem kötelező, ha a fiók URL-címe már rendelkezik SAS-jogkivonattal. Az érték lehet SAS-jogkivonat-sztring, egy AzureSasCredential vagy AzureNamedKeyCredential példánya az azure.core.credentials-ből, egy fiók megosztott hozzáférési kulcsa vagy az azure.identity tokencredentials osztályának egy példánya. Ha az erőforrás URI-ja már tartalmaz SAS-jogkivonatot, a rendszer ezt figyelmen kívül hagyja egy explicit hitelesítő adat javára.

  • kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. Ha azureNamedKeyCredential-példányt használ, a "név" a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.
api_version
str

A kérésekhez használandó Storage API-verzió. Az alapértelmezett érték az aktuális SDK-val kompatibilis legújabb szolgáltatásverzió. A régebbi verzióra való beállítás csökkentett funkciókompatibilitást eredményezhet.

Új a 12.2.0-s verzióban.

secondary_hostname
str

A másodlagos végpont állomásneve.

max_block_size
int

A blokkblobok adattömbökben való feltöltésének maximális adatmennyisége. Alapértelmezés szerint 4*1024*1024 vagy 4 MB.

max_single_put_size
int

Ha a blob mérete kisebb vagy egyenlő max_single_put_size, akkor a blob feltöltése csak egy HTTP PUT kéréssel történik. Ha a blob mérete nagyobb, mint max_single_put_size, a blob adattömbökbe lesz feltöltve. Alapértelmezés szerint 64*1024*1024 vagy 64 MB.

min_large_block_upload_threshold
int

A blokkblob feltöltésekor a memóriahatékony algoritmus használatához szükséges minimális adattömbméret. Alapértelmezés szerint 4*1024*1024+1.

use_byte_buffer
bool

Használjon bájtpuffert a blokkblobok feltöltéséhez. Alapértelmezés szerint Hamis.

max_page_size
int

Az oldalblobok feltöltésének maximális adattömbmérete. Alapértelmezés szerint 4*1024*1024 vagy 4 MB.

max_single_get_size
int

Az egyetlen hívásban letöltendő blob maximális mérete, a túllépett rész adattömbökben lesz letöltve (párhuzamos lehet). Alapértelmezés szerint 32*1024*1024 vagy 32 MB.

max_chunk_get_size
int

A blob letöltéséhez használt maximális adattömbméret. Alapértelmezés szerint 4*1024*1024 vagy 4 MB.

Metódusok

acquire_lease

Új bérletet kér. Ha a tároló nem rendelkezik aktív bérletekkel, a Blob szolgáltatás létrehoz egy bérletet a tárolón, és egy új bérletazonosítót ad vissza.

close

Ezzel a módszerrel zárja be az ügyfél által megnyitott szoftvercsatornákat. A környezetkezelővel való használathoz nem szükséges használni.

create_container

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, a művelet meghiúsul.

delete_blob

Megjelöli a megadott blobot vagy pillanatképet törlésre.

A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A delete_blob művelettel egyidejűleg mindkettő törölhető.

Ha a szolgáltatáshoz engedélyezve van a törlési adatmegőrzési szabályzat, akkor ez a művelet helyreállítható módon törli a blobot vagy a pillanatképet, és megőrzi a blobot vagy a pillanatképet megadott számú napig. A megadott számú nap elteltével a blob adatai el lesznek távolítva a szolgáltatásból a szemétgyűjtés során. A helyreállíthatóan törölt blob vagy pillanatkép az include=["deleted"] beállítás megadásával érhető ellist_blobs. A helyreállíthatóan törölt blobok vagy pillanatképek a következő használatával állíthatók vissza: <xref:azure.storage.blob.BlobClient.undelete>

delete_blobs

Megjelöli a megadott blobokat vagy pillanatképeket törlésre.

A blobok később törlődnek a szemétgyűjtés során. Vegye figyelembe, hogy a blobok törléséhez törölnie kell az összes pillanatképüket. A delete_blobs művelettel egyidejűleg mindkettő törölhető.

Ha a szolgáltatáshoz engedélyezve van a törlési adatmegőrzési szabályzat, akkor ez a művelet helyreállítható módon törli a blobokat vagy pillanatképeket, és adott számú napig megőrzi a blobokat vagy pillanatképeket. A megadott számú nap elteltével a blobok adatai el lesznek távolítva a szolgáltatásból a szemétgyűjtés során. A helyreállíthatóan törölt blobok vagy pillanatképek az include=["deleted"] beállítással list_blobs érhetők el. A helyreállíthatóan törölt blobok vagy pillanatképek az paranccsal állíthatók vissza<xref:azure.storage.blob.BlobClient.undelete>

Az egyetlen kérelemben törölhető blobok maximális száma 256.

delete_container

Megjelöli a megadott tárolót törlésre. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

download_blob

Letölt egy blobot a StorageStreamDownloaderbe. A readall() metódust kell használni az összes tartalom olvasásához, vagy a blob streambe való letöltéséhez a readinto() metódust kell használni. Az adattömbök() használatával egy iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbök tartalma fölött iteráljon.

exists

Igaz értéket ad vissza, ha egy tároló létezik, és hamis értéket ad vissza.

find_blobs_by_tags

Egy generátort ad vissza a megadott tároló alatti blobok listázásához, amelynek címkéi megegyeznek a megadott keresési kifejezéssel. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

from_connection_string

ContainerClient létrehozása kapcsolati sztringből.

from_container_url

ContainerClient létrehozása tároló URL-címéből.

get_account_information

Lekéri a tárfiókkal kapcsolatos információkat.

Az információk akkor is lekérhetők, ha a felhasználó SAS-sel rendelkezik egy tárolóhoz vagy blobhoz. A visszaadott szótárban található kulcsok közé tartozik a "sku_name" és a "account_kind".

get_blob_client

Kérje le az ügyfelet, hogy használja a megadott blobot.

A blobnak még nem kell léteznie.

get_container_access_policy

Lekéri a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóadatok nyilvánosan elérhetők-e.

get_container_properties

A felhasználó által definiált metaadatokat és rendszertulajdonságokat adja vissza a megadott tárolóhoz. A visszaadott adatok nem tartalmazzák a tároló bloblistáját.

list_blob_names

Egy generátort ad vissza a megadott tároló alatti blobok nevének listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

Vegye figyelembe, hogy az API használatakor a rendszer nem ad vissza további tulajdonságokat vagy metaadatokat. Ezen kívül ez az API nem tartalmaz további blobokat, például pillanatképeket, verziókat, helyreállíthatóan törölt blobokat stb. Ezen adatok lekéréséhez használja a következőt list_blobs: .

list_blobs

Egy generátort ad vissza a megadott tároló alatti blobok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

set_container_access_policy

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható megadott tárolóra vagy tárolt hozzáférési szabályzatokra vonatkozó engedélyeket. Az engedélyek azt jelzik, hogy a tárolóban lévő blobok nyilvánosan elérhetők-e.

set_container_metadata

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott tárolóhoz. A művelet minden hívása lecseréli a tárolóhoz csatolt összes meglévő metaadatot. Ha az összes metaadatot el szeretné távolítani a tárolóból, hívja meg ezt a műveletet metaadat-diktálás nélkül.

set_premium_page_blob_tier_blobs

Beállítja az oldalblobszinteket az összes blobon. Ez az API csak prémium szintű fiókok lapblobjainak esetében támogatott.

Az egyetlen kérelemben frissíthető blobok maximális száma 256.

set_standard_blob_tier_blobs

Ez a művelet blokkblobokra állítja be a szintet.

A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét.

Az egyetlen kérelemben frissíthető blobok maximális száma 256.

upload_blob

Új blobot hoz létre egy adatforrásból automatikus adattömbökkel.

walk_blobs

Egy generátort ad vissza a megadott tároló alatti blobok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat. Ez a művelet a blobokat egy hierarchia szerint listázja, a megadott elválasztó karakterrel elválasztva.

acquire_lease

Új bérletet kér. Ha a tároló nem rendelkezik aktív bérletekkel, a Blob szolgáltatás létrehoz egy bérletet a tárolón, és egy új bérletazonosítót ad vissza.

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

Paraméterek

lease_duration
int
Kötelező

Megadja a bérlet időtartamát másodpercben, vagy negatívat (-1) egy olyan bérlethez, amely soha nem jár le. A nem végtelen bérlet 15 és 60 másodperc között lehet. A bérlet időtartama nem módosítható megújítással vagy módosítással. Az alapértelmezett érték -1 (végtelen bérlet).

lease_id
str
Kötelező

Javasolt bérletazonosító GUID sztringformátumban. A Blob szolgáltatás 400(Érvénytelen kérelem) értéket ad vissza, ha a javasolt bérletazonosító nem a megfelelő formátumú.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition
MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Egy BlobLeaseClient objektum, amely egy környezetkezelőben futtatható.

Visszatérési típus

close

Ezzel a módszerrel zárja be az ügyfél által megnyitott szoftvercsatornákat. A környezetkezelővel való használathoz nem szükséges használni.

close()

create_container

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, a művelet meghiúsul.

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

Paraméterek

metadata
dict[str, str]
Kötelező

A tárolóhoz metaadatként társítandó name_value párokkal rendelkező diktálás. Példa:{'Category':'test'}

public_access
PublicAccess
Kötelező

A lehetséges értékek a következők: "tároló", "blob".

container_encryption_scope
dict vagy ContainerEncryptionScope

Megadja a tárolón beállítandó alapértelmezett titkosítási hatókört, és az összes jövőbeli íráshoz használható.

Új a 12.2.0-s verzióban.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Válaszfejlécek szótára.

Visszatérési típus

delete_blob

Megjelöli a megadott blobot vagy pillanatképet törlésre.

A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A delete_blob művelettel egyidejűleg mindkettő törölhető.

Ha a szolgáltatáshoz engedélyezve van a törlési adatmegőrzési szabályzat, akkor ez a művelet helyreállítható módon törli a blobot vagy a pillanatképet, és megőrzi a blobot vagy a pillanatképet megadott számú napig. A megadott számú nap elteltével a blob adatai el lesznek távolítva a szolgáltatásból a szemétgyűjtés során. A helyreállíthatóan törölt blob vagy pillanatkép az include=["deleted"] beállítás megadásával érhető ellist_blobs. A helyreállíthatóan törölt blobok vagy pillanatképek a következő használatával állíthatók vissza: <xref:azure.storage.blob.BlobClient.undelete>

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

Paraméterek

blob
str vagy BlobProperties
Kötelező

Az a blob, amellyel interakciót kell létesíteni. Ha meg van adva, ez az érték felülbírálja a blob URL-címében megadott blobértéket.

delete_snapshots
str
Kötelező

Akkor szükséges, ha a blobhoz társított pillanatképek tartoznak. Az értékek többek között az alábbiak lehetnek:

  • "csak": Csak a blobok pillanatképeit törli.

  • "include": Törli a blobot és az összes pillanatképet.

version_id
str

A verzióazonosító paraméter egy átlátszatlan DateTime érték, amely jelen esetben meghatározza a törölni kívánt blob verzióját.

Új a 12.4.0-s verzióban.

Ez a kulcsszóargumentum a "2019-12-12" API-verzióban lett bevezetve.

lease
BlobLeaseClient vagy str

Akkor szükséges, ha a blob rendelkezik aktív bérlettal. Az érték lehet BlobLeaseClient objektum vagy sztringként megadott bérletazonosító.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Adja meg ezt a fejlécet a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.

match_condition
MatchConditions

Az etagen használandó egyezési feltétel.

if_tags_match_condition
str

Adjon meg egy SQL where záradékot a blobcímkéken, hogy csak egyező értékkel rendelkező blobon működjön. például: "\"tagname\"='my tag'"

A 12.4.0-s verzió újdonsága.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Visszatérési típus

delete_blobs

Megjelöli a megadott blobokat vagy pillanatképeket törlésre.

A blobok később törlődnek a szemétgyűjtés során. Vegye figyelembe, hogy a blobok törléséhez törölnie kell az összes pillanatképüket. A delete_blobs művelettel egyidejűleg mindkettő törölhető.

Ha a szolgáltatáshoz engedélyezve van a törlési adatmegőrzési szabályzat, akkor ez a művelet helyreállítható módon törli a blobokat vagy pillanatképeket, és adott számú napig megőrzi a blobokat vagy pillanatképeket. A megadott számú nap elteltével a blobok adatai el lesznek távolítva a szolgáltatásból a szemétgyűjtés során. A helyreállíthatóan törölt blobok vagy pillanatképek az include=["deleted"] beállítással list_blobs érhetők el. A helyreállíthatóan törölt blobok vagy pillanatképek az paranccsal állíthatók vissza<xref:azure.storage.blob.BlobClient.undelete>

Az egyetlen kérelemben törölhető blobok maximális száma 256.

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

Paraméterek

blobs
str vagy dict(str, Any) vagy BlobProperties
Kötelező

A törölni kívánt blobok. Ez lehet egy blob, vagy több érték is megadható, ahol minden érték a blob (str) vagy a BlobProperties neve.

Megjegyzés

Ha a blob típusa diktálás, az alábbi lista tartalmazza a kulcsokat és az értékszabályokat.

blob neve:

key: 'name', value type: str

törölni kívánt pillanatkép:

key: 'snapshot', value type: str

verzióazonosító:

key: "version_id", értéktípus: str

a blob törlésekor törölje-e a pillanatképeket:

key: "delete_snapshots", érték: "include" vagy "only"

ha a blob módosult vagy sem:

key: "if_modified_since", "if_unmodified_since", értéktípus: datetime

Etag:

key: "etag", érték típusa: str

egyezzen az etagel, vagy sem:

key: "match_condition", értéktípus: MatchConditions

a címkék megfelelnek a feltételnek:

key: "if_tags_match_condition", értéktípus: str

Bérleti:

key: "lease_id", értéktípus: Union[str, LeaseClient]

a részkérés időtúllépése:

key: 'timeout', value type: int

delete_snapshots
str

Akkor szükséges, ha egy blobhoz társított pillanatképek tartoznak. Az értékek többek között az alábbiak lehetnek:

  • "only": Csak a blobok pillanatképeit törli.

  • "include": Törli a blobot és az összes pillanatképet.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Adja meg ezt a fejlécet a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

if_tags_match_condition
str

Adjon meg egy SQL where záradékot a blobcímkéken, hogy csak egyező értékkel rendelkező blobon működjön. például: "\"tagname\"='my tag'"

A 12.4.0-s verzió újdonsága.

raise_on_any_failure
bool

Ez egy logikai paraméter, amely alapértelmezés szerint Igaz. Ha ez be van állítva, a rendszer kivételt hoz létre, még akkor is, ha egyetlen művelethiba történik.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Válaszok

A válaszok iterátora, minden blobhoz egy sorrendben

Visszatérési típus

delete_container

Megjelöli a megadott tárolót törlésre. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

delete_container(**kwargs: Any) -> None

Paraméterek

lease
BlobLeaseClient vagy str

Ha meg van adva, delete_container csak akkor sikeres, ha a tároló bérlete aktív, és megfelel ennek az azonosítónak. Kötelező, ha a tároló aktív bérletet kapott.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Adja meg ezt a fejlécet a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.

match_condition
MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Visszatérési típus

download_blob

Letölt egy blobot a StorageStreamDownloaderbe. A readall() metódust kell használni az összes tartalom olvasásához, vagy a blob streambe való letöltéséhez a readinto() metódust kell használni. Az adattömbök() használatával egy iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbök tartalma fölött iteráljon.

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

Paraméterek

blob
str vagy BlobProperties
Kötelező

Az a blob, amellyel interakciót kell létesíteni. Ha meg van adva, ez az érték felülbírálja a blob URL-címében megadott blobértéket.

offset
int
Kötelező

A blob egy szakaszának letöltéséhez használandó bájttartomány kezdete. Meg kell adni, ha a hossz meg van adva.

length
int
Kötelező

A streamből beolvasandó bájtok száma. Ez nem kötelező, de az optimális teljesítmény érdekében kell megadni.

version_id
str

A verzióazonosító paraméter egy átlátszatlan DateTime érték, amely jelen esetben megadja a letöltendő blob verzióját.

Új a 12.4.0-s verzióban.

Ez a kulcsszóargumentum a "2019-12-12" API-verzióban lett bevezetve.

validate_content
bool

Ha igaz, egy MD5-kivonatot számít ki a blob minden egyes darabjára. A tárolási szolgáltatás ellenőrzi az elküldött kivonattal érkezett tartalom kivonatát. Ez elsősorban akkor hasznos, ha bitflipeket észlel a vezetéken, ha http-t használ a https helyett, mivel a https (alapértelmezett) már érvényesíti. Vegye figyelembe, hogy ez az MD5-kivonat nem a blobban van tárolva. Azt is vegye figyelembe, hogy ha engedélyezve van, a memóriahatékony feltöltési algoritmust nem fogja használni a rendszer, mert az MD5-kivonat kiszámításához teljes blokkok pufferelése szükséges, és ez nem teszi lehetővé a memóriahatékony algoritmus célját.

lease
BlobLeaseClient vagy str

Akkor szükséges, ha a blob rendelkezik aktív bérlettal. Ha meg van adva, download_blob csak akkor lesz sikeres, ha a blob bérlete aktív, és megfelel ennek az azonosítónak. Az érték lehet BlobLeaseClient objektum vagy sztringként a bérletazonosító.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition
MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

if_tags_match_condition
str

Adjon meg egy SQL-t, ahol a blobcímkék záradéka csak egyező értékkel rendelkező blobokon működik. például: "\"tagname\"='my tag'"

Új a 12.4.0-s verzióban.

cpk
CustomerProvidedEncryptionKey

A szolgáltatás oldalán lévő adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni. Mivel maga a titkosítási kulcs szerepel a kérelemben, biztonságos kapcsolatot kell létesíteni a kulcs átviteléhez.

max_concurrency
int

Azoknak a párhuzamos kapcsolatoknak a száma, amelyekkel le kell tölteni.

encoding
str

Kódolás a letöltött bájtok dekódolásához. Az alapértelmezett érték Nincs, azaz nincs dekódolás.

progress_hook
Callable[[int, int], None]

Visszahívás egy hosszú ideig futó letöltés előrehaladásának nyomon követéséhez. Az aláírás függvény (current: int, total: int), ahol az aktuális az eddig átvitt bájtok száma, az összeg pedig a letöltés teljes mérete.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt. Ez a metódus több hívást is indíthat a szolgáltatáshoz, és az időtúllépés minden hívásra külön-külön érvényes lesz. több hívás az Azure-szolgáltatásba, és az időtúllépés minden hívásra külön-külön érvényes.

Válaszok

Streamobjektum (StorageStreamDownloader)

Visszatérési típus

exists

Igaz értéket ad vissza, ha egy tároló létezik, és hamis értéket ad vissza.

exists(**kwargs: Any) -> bool

Paraméterek

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

boolean

Visszatérési típus

find_blobs_by_tags

Egy generátort ad vissza a megadott tároló alatti blobok listázásához, amelynek címkéi megegyeznek a megadott keresési kifejezéssel. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

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

Paraméterek

filter_expression
str
Kötelező

Az a kifejezés, amely megkeresi azokat a blobokat, amelyek címkéi megegyeznek a megadott feltétellel. például: ""yourtagname"='firsttag' és "yourtagname2"='secondtag'"

results_per_page
int

Oldalszámozáskor az oldalenkénti maximális eredmény.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A FilteredBlob iterable (automatikus lapozó) válasza.

Visszatérési típus

from_connection_string

ContainerClient létrehozása kapcsolati sztringből.

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

Paraméterek

conn_str
str
Kötelező

Egy Azure Storage-fiókhoz kapcsolati sztring.

container_name
str
Kötelező

A blob tárolóneve.

credential
alapértelmezett érték: None

A hitelesítéshez használt hitelesítő adatok. Ez nem kötelező, ha a fiók URL-címe már rendelkezik SAS-jogkivonattal, vagy a kapcsolati sztring már rendelkezik közös hozzáférési kulcsértékekkel. Az érték lehet SAS-jogkivonat-sztring, egy AzureSasCredential vagy AzureNamedKeyCredential példánya az azure.core.credentials-ből, egy fiók megosztott hozzáférési kulcsa vagy az azure.identity tokencredentials osztályának egy példánya. Az itt megadott hitelesítő adatok elsőbbséget élveznek a kapcsolati sztring. Ha azureNamedKeyCredential-példányt használ, a "név" a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.

Válaszok

Egy tárolóügyfél.

Visszatérési típus

from_container_url

ContainerClient létrehozása tároló URL-címéből.

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

Paraméterek

container_url
str
Kötelező

A tároló teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják. Ez lehet az elsődleges végpont vagy a másodlagos végpont az aktuális location_mode függően.

credential
alapértelmezett érték: None

A hitelesítéshez használt hitelesítő adatok. Ez nem kötelező, ha a fiók URL-címe már rendelkezik SAS-jogkivonattal, vagy a kapcsolati sztring már rendelkezik közös hozzáférési kulcsértékekkel. Az érték lehet SAS-jogkivonat-sztring, egy AzureSasCredential vagy AzureNamedKeyCredential példánya az azure.core.credentials-ből, egy fiók megosztott hozzáférési kulcsa vagy az azure.identity tokencredentials osztályának egy példánya. Ha az erőforrás URI-ja már tartalmaz SAS-jogkivonatot, a rendszer ezt figyelmen kívül hagyja egy explicit hitelesítő adat javára.

  • kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. Ha azureNamedKeyCredential-példányt használ, a "név" a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.

Válaszok

Egy tárolóügyfél.

Visszatérési típus

get_account_information

Lekéri a tárfiókkal kapcsolatos információkat.

Az információk akkor is lekérhetők, ha a felhasználó SAS-sel rendelkezik egy tárolóhoz vagy blobhoz. A visszaadott szótárban található kulcsok közé tartozik a "sku_name" és a "account_kind".

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

Válaszok

A fiókadatok (termékváltozat és fiók típusa) diktálása.

Visszatérési típus

get_blob_client

Kérje le az ügyfelet, hogy használja a megadott blobot.

A blobnak még nem kell léteznie.

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

Paraméterek

blob
str vagy BlobProperties
Kötelező

Az a blob, amellyel interakciót kell létesíteni.

snapshot
str
alapértelmezett érték: None

Az opcionális blob-pillanatkép, amelyen működni szeretne. Ez lehet a pillanatkép-azonosító sztringje vagy a következőtől create_snapshotkapott válasz: .

version_id
str

A verzióazonosító paraméter egy átlátszatlan DateTime érték, amely jelen esetben meghatározza a blob azon verzióját, amelyen működni szeretne.

Válaszok

Egy BlobClient.

Visszatérési típus

get_container_access_policy

Lekéri a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóadatok nyilvánosan elérhetők-e.

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

Paraméterek

lease
BlobLeaseClient vagy str

Ha meg van adva, get_container_access_policy csak akkor lesz sikeres, ha a tároló bérlete aktív, és megfelel ennek az azonosítónak.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Hozzáférési szabályzat adatai a diktálásban.

Visszatérési típus

get_container_properties

A felhasználó által definiált metaadatokat és rendszertulajdonságokat adja vissza a megadott tárolóhoz. A visszaadott adatok nem tartalmazzák a tároló bloblistáját.

get_container_properties(**kwargs: Any) -> ContainerProperties

Paraméterek

lease
BlobLeaseClient vagy str

Ha meg van adva, get_container_properties csak akkor sikerül, ha a tároló bérlete aktív, és megfelel ennek az azonosítónak.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A megadott tároló tulajdonságai egy tárolóobjektumon belül.

Visszatérési típus

list_blob_names

Egy generátort ad vissza a megadott tároló alatti blobok nevének listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

Vegye figyelembe, hogy az API használatakor a rendszer nem ad vissza további tulajdonságokat vagy metaadatokat. Ezen kívül ez az API nem tartalmaz további blobokat, például pillanatképeket, verziókat, helyreállíthatóan törölt blobokat stb. Ezen adatok lekéréséhez használja a következőt list_blobs: .

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

Paraméterek

name_starts_with
str

Az eredményeket úgy szűri, hogy csak azokat a blobokat adja vissza, amelyeknek a neve a megadott előtaggal kezdődik.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A blobnevek sztringként való iteráló (automatikus lapozású) válasza.

Visszatérési típus

list_blobs

Egy generátort ad vissza a megadott tároló alatti blobok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

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

Paraméterek

name_starts_with
str
Kötelező

Az eredményeket úgy szűri, hogy csak azokat a blobokat adja vissza, amelyeknek a neve a megadott előtaggal kezdődik.

include
list[str] vagy str
Kötelező

Egy vagy több további adatkészletet ad meg, amely szerepel a válaszban. A lehetőségek közé tartoznak a következők: "pillanatképek", "metaadatok", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A BlobProperties iterable (automatikus lapozó) válasza.

Visszatérési típus

set_container_access_policy

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható megadott tárolóra vagy tárolt hozzáférési szabályzatokra vonatkozó engedélyeket. Az engedélyek azt jelzik, hogy a tárolóban lévő blobok nyilvánosan elérhetők-e.

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

Paraméterek

signed_identifiers
dict[str, AccessPolicy]
Kötelező

A tárolóhoz társítandó hozzáférési szabályzatok szótára. A szótár legfeljebb 5 elemet tartalmazhat. Egy üres szótár törli a szolgáltatásban beállított hozzáférési szabályzatokat.

public_access
PublicAccess
Kötelező

A lehetséges értékek a következők: "tároló", "blob".

lease
BlobLeaseClient vagy str

Akkor szükséges, ha a tároló rendelkezik aktív bérletel. Az érték lehet BlobLeaseClient objektum vagy sztringként a bérletazonosító.

if_modified_since
datetime

Dátum/idő érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott dátum/idő óta módosult.

if_unmodified_since
datetime

Dátum/idő érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Tárolóban frissített tulajdonság diktálja (Etag és utolsó módosítás).

Visszatérési típus

set_container_metadata

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott tárolóhoz. A művelet minden hívása lecseréli a tárolóhoz csatolt összes meglévő metaadatot. Ha az összes metaadatot el szeretné távolítani a tárolóból, hívja meg ezt a műveletet metaadat-diktálás nélkül.

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

Paraméterek

metadata
dict[str, str]
Kötelező

A tárolóhoz metaadatként társítandó név-érték párokat tartalmazó diktálás. Példa: {'category':'test'}

lease
BlobLeaseClient vagy str

Ha meg van adva, set_container_metadata csak akkor sikerül, ha a tároló bérlete aktív, és megfelel ennek az azonosítónak.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Tárolóban frissített tulajdonság diktálja (Etag és utolsó módosítás).

Visszatérési típus

set_premium_page_blob_tier_blobs

Beállítja az oldalblobszinteket az összes blobon. Ez az API csak prémium szintű fiókok lapblobjainak esetében támogatott.

Az egyetlen kérelemben frissíthető blobok maximális száma 256.

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

Paraméterek

premium_page_blob_tier
PremiumPageBlobTier
Kötelező

Egy lapblobszint-érték, amely a blob értékét állítja be. A szint a blob méretével és az engedélyezett IOPS számával korrelál. Ez csak a prémium szintű tárfiókokon található lapblobokra vonatkozik.

Megjegyzés

Ha különböző szinteket szeretne beállítani különböző blobokon, állítsa ezt a pozícióparamétert Nincs értékre.

Ezután minden BlobProperties blobszintje meg fog jelenni.

blobs
str vagy dict(str, Any) vagy BlobProperties
Kötelező

Azok a blobok, amelyekkel interakciót kell létesíteni. Ez lehet egy blob, vagy több érték is megadható, ahol minden érték a blob (str) vagy a BlobProperties neve.

Megjegyzés

Ha a blob típusa diktált, az alábbi lista tartalmazza a kulcsokat és az értékszabályokat.

blob neve:

key: 'name', value type: str

prémium blobszint:

key: "blob_tier", értéktípus: PremiumPageBlobTier

Bérleti:

key: "lease_id", értéktípus: Union[str, LeaseClient]

időtúllépés a lekéréshez:

key: "timeout", value type: int

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

raise_on_any_failure
bool

Ez egy logikai paraméter, amely alapértelmezés szerint Igaz. Ha ez be van állítva, akkor is kivétel keletkezik, ha egyetlen művelet meghiúsul.

Válaszok

A válaszok iterátora, minden blobhoz egy sorrendben

Visszatérési típus

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Ez a művelet blokkblobokra állítja be a szintet.

A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét.

Az egyetlen kérelemben frissíthető blobok maximális száma 256.

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

Paraméterek

standard_blob_tier
str vagy StandardBlobTier
Kötelező

Az összes blobon beállítandó szintet jelzi. A beállítások közé tartozik a "Gyakori elérésű", a "Ritka elérésű", az "Archív". A gyakori elérésű szint a gyakran használt adatok tárolására van optimalizálva. A ritka elérésű tárolási szint a ritkán elért és legalább egy hónapig tárolt adatok tárolására van optimalizálva. Az archív szint olyan adatok tárolására van optimalizálva, amelyeket ritkán érnek el és tárolnak legalább hat hónapig rugalmas késési követelményekkel.

Megjegyzés

Ha különböző szinteket szeretne beállítani különböző blobokon, állítsa ezt a pozícióparamétert Nincs értékre.

Ezután minden BlobProperties blobszintje meg fog jelenni.

blobs
str vagy dict(str, Any) vagy BlobProperties
Kötelező

Azok a blobok, amelyekkel interakciót kell létesíteni. Ez lehet egy blob, vagy több érték is megadható, ahol minden érték a blob (str) vagy a BlobProperties neve.

Megjegyzés

Ha a blob típusa diktált, az alábbi lista tartalmazza a kulcsokat és az értékszabályokat.

blob neve:

key: 'name', value type: str

standard blobszint:

key: "blob_tier", értéktípus: StandardBlobTier

rehidratálási prioritás:

key: "rehydrate_priority", érték típusa: RehidratátPriority

Bérleti:

key: "lease_id", értéktípus: Union[str, LeaseClient]

Pillanatkép:

key: "snapshot", value type: str

verzióazonosító:

key: "version_id", érték típusa: str

a címkék megfelelnek a feltételnek:

key: "if_tags_match_condition", érték típusa: str

időtúllépés a lekéréshez:

key: "timeout", value type: int

rehydrate_priority
RehydratePriority

Azt a prioritást jelzi, amellyel egy archivált blobot rehidratálhat

if_tags_match_condition
str

Adjon meg egy SQL-t, ahol a blobcímkék záradéka csak egyező értékkel rendelkező blobokon működik. például: "\"tagname\"='my tag'"

Új a 12.4.0-s verzióban.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

raise_on_any_failure
bool

Ez egy logikai paraméter, amely alapértelmezés szerint Igaz. Ha ez be van állítva, akkor is kivétel keletkezik, ha egyetlen művelet meghiúsul.

Válaszok

A válaszok iterátora, minden blobhoz egy sorrendben

Visszatérési típus

upload_blob

Új blobot hoz létre egy adatforrásból automatikus adattömbökkel.

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

Paraméterek

name
str vagy BlobProperties
Kötelező

Az a blob, amellyel interakciót kell létesíteni. Ha meg van adva, ez az érték felülbírálja a blob URL-címében megadott blobértéket.

data
Kötelező

A feltöltendő blobadatok.

blob_type
BlobType
Kötelező

A blob típusa. Ez lehet BlockBlob, PageBlob vagy AppendBlob. Az alapértelmezett érték a BlockBlob.

length
int
Kötelező

A streamből beolvasandó bájtok száma. Ez nem kötelező, de az optimális teljesítmény érdekében kell megadni.

metadata
dict(str, str)
Kötelező

A blobhoz metaadatként társított név-érték párok.

overwrite
bool

Azt jelzi, hogy a feltöltendő blob felülírja-e az aktuális adatokat. Ha igaz, upload_blob felülírja a meglévő adatokat. Ha False (Hamis) értékre van állítva, a művelet a ResourceExistsError művelettel meghiúsul. A fentiek alól kivételt képeznek a Hozzáfűző blobtípusok: ha a False (Hamis) értékre van állítva, és az adatok már léteznek, a rendszer nem hoz létre hibát, és az adatok hozzá lesznek fűzve a meglévő blobhoz. Ha az overwrite=True értéket állítja be, akkor a meglévő hozzáfűző blob törlődik, és létrejön egy új. Alapértelmezés szerint Hamis.

content_settings
ContentSettings

A blobtulajdonságok beállításához használt ContentSettings objektum. A tartalomtípus, a kódolás, a nyelv, a diszpozíció, az md5 és a gyorsítótár-vezérlés beállítására szolgál.

validate_content
bool

Ha igaz, egy MD5-kivonatot számít ki a blob minden egyes darabjára. A tárolási szolgáltatás ellenőrzi az elküldött kivonattal érkezett tartalom kivonatát. Ez elsősorban akkor hasznos, ha bitflipeket észlel a vezetéken, ha http-t használ a https helyett, mivel a https (alapértelmezett) már érvényesíti. Vegye figyelembe, hogy ez az MD5-kivonat nem a blobban van tárolva. Azt is vegye figyelembe, hogy ha engedélyezve van, a memóriahatékony feltöltési algoritmus nem lesz használva, mivel az MD5 kivonatának kiszámításához teljes blokkokat kell pufferelni, és ez megakadályozza a memóriahatékony algoritmus célját.

lease
BlobLeaseClient vagy str

Akkor szükséges, ha a tároló rendelkezik aktív bérletel. Az érték lehet BlobLeaseClient objektum vagy sztringként a bérletazonosító.

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag
str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition
MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

if_tags_match_condition
str

Adjon meg egy SQL-t, ahol a blobcímkék záradéka csak egyező értékkel rendelkező blobokon működik. például: "\"tagname\"='my tag'"

Új a 12.4.0-s verzióban.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt. Ez a metódus több hívást is indíthat a szolgáltatáshoz, és az időtúllépés minden hívásra külön-külön érvényes lesz.

premium_page_blob_tier
PremiumPageBlobTier

Egy lapblobszint-érték, amely a blob értékét állítja be. A szint a blob méretével és az engedélyezett IOPS számával korrelál. Ez csak a prémium szintű tárfiókokon található lapblobokra vonatkozik.

standard_blob_tier
StandardBlobTier

Standard blobszint-érték a blob értékének beállításához. A kódtár ezen verziójához ez csak a standard tárfiókokon lévő blobok blokkolására vonatkozik.

maxsize_condition
int

Nem kötelező feltételes fejléc. A hozzáfűző blob számára engedélyezett bájtok maximális hossza. Ha a Hozzáfűzési blokk művelet miatt a blob túllépi ezt a korlátot, vagy ha a blob mérete már nagyobb, mint az ebben a fejlécben megadott érték, a kérés MaxBlobSizeConditionNotMet hibával meghiúsul (HTTP-állapotkód: 412 – Az előfeltétele nem sikerült).

max_concurrency
int

A párhuzamos kapcsolatok maximális száma, ha a blob mérete meghaladja a 64 MB-ot.

cpk
CustomerProvidedEncryptionKey

A szolgáltatás oldalán lévő adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni. Mivel maga a titkosítási kulcs szerepel a kérelemben, biztonságos kapcsolatot kell létesíteni a kulcs átviteléhez.

encryption_scope
str

A szolgáltatásban lévő adatok titkosításához használt előre definiált titkosítási hatókör. A titkosítási hatókör a Felügyeleti API használatával hozható létre, és itt név alapján hivatkozhat rá. Ha a tárolóban alapértelmezett titkosítási hatókör van definiálva, ez az érték felülbírálja azt, ha a tárolószintű hatókör a felülbírálások engedélyezésére van konfigurálva. Ellenkező esetben hibaüzenet jelenik meg.

Új a 12.2.0-s verzióban.

encoding
str

Alapértelmezés szerint UTF-8.

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

Visszahívás egy hosszú ideig futó feltöltés előrehaladásának nyomon követéséhez. Az aláírás függvény (current: int, total: Optional[int]), ahol az aktuális az eddig átvitt bájtok száma, az összeg pedig a blob mérete vagy Nincs, ha a méret ismeretlen.

Válaszok

Egy BlobClient, amely az újonnan feltöltött blobot használja.

Visszatérési típus

walk_blobs

Egy generátort ad vissza a megadott tároló alatti blobok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat. Ez a művelet a blobokat egy hierarchia szerint listázja, a megadott elválasztó karakterrel elválasztva.

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

Paraméterek

name_starts_with
str
Kötelező

Az eredményeket úgy szűri, hogy csak azokat a blobokat adja vissza, amelyeknek a neve a megadott előtaggal kezdődik.

include
list[str] vagy str
Kötelező

Egy vagy több további adatkészletet ad meg, amely szerepel a válaszban. A lehetőségek közé tartoznak a következők: "pillanatképek", "metaadatok", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

delimiter
str
Kötelező

Ha a kérelem tartalmazza ezt a paramétert, a művelet egy BlobPrefix elemet ad vissza a választörzsben, amely helyőrzőként szolgál az összes olyan blobhoz, amelynek a neve ugyanazzal a részszúrással kezdődik a határoló karakter megjelenésével. A határoló egy karakterből vagy egy sztringből állhat.

timeout
int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A BlobProperties iterable (automatikus lapozó) válasza.

Visszatérési típus

Attribútumok

api_version

A kérésekhez használt Storage API verziója.

location_mode

Az ügyfél által jelenleg használt hely mód.

Alapértelmezés szerint ez lesz az "elsődleges". A beállítások közé tartozik az "elsődleges" és a "másodlagos".

primary_endpoint

A teljes elsődleges végpont URL-címe.

primary_hostname

Az elsődleges végpont állomásneve.

secondary_endpoint

A teljes másodlagos végpont URL-címe, ha konfigurálva van.

Ha nem érhető el, a rendszer létrehoz egy ValueError értéket. Másodlagos állomásnév explicit megadásához használja az opcionális secondary_hostname kulcsszóargumentumot a példányosításkor.

Kivételek

secondary_hostname

A másodlagos végpont állomásneve.

Ha nem érhető el, ez Nem lesz. Másodlagos állomásnév explicit megadásához használja az opcionális secondary_hostname kulcsszóargumentumot a példányosításkor.

url

Az entitás teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják.

Ez lehet az elsődleges végpont vagy a másodlagos végpont az aktuálistól location_modefüggően. :returns: Az entitás teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják. :rtype: str