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üli adott blobokkal kapcsolatos műveletek esetén a blobügyfél lekérhető a get_blob_client függvénnyel.
- Öröklődés
-
azure.storage.blob._shared.base_client_async.AsyncStorageAccountHostsMixinContainerClientazure.storage.blob._container_client.ContainerClientContainerClientazure.storage.blob._encryption.StorageEncryptionMixinContainerClient
Konstruktor
ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | AsyncTokenCredential | None = None, **kwargs: Any)
Paraméterek
- account_url
- str
A tárfiók URI-ja. Ahhoz, hogy létrehozhasson egy ügyfelet a tároló teljes URI-jának megadva, használja a from_container_url classmethod parancsot.
- credential
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, az AzureSasCredential vagy az 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 mellett.
- kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. Ha az AzureNamedKeyCredential egy példányát használja, a "name" legyen 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.
A 12.2.0-s verzió újdonságai.
- secondary_hostname
- str
A másodlagos végpont állomásneve.
- max_block_size
- int
A blokkblobok adattömbökbe való feltöltésének maximális adattömbmérete.
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 csak egy HTTP PUT kéréssel lesz feltöltve. Ha a blob mérete nagyobb, mint max_single_put_size, a blob darabokban lesz feltöltve. Alapértelmezés szerint 64*1024*1024
vagy 64 MB.
- min_large_block_upload_threshold
- int
A memóriahatékony algoritmus használatához szükséges minimális adattömbméret blokkblobok feltöltésekor. 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
A blobok egyetlen hívásban való letöltésének maximális mérete, a túllépett rész adattömbökbe lesz letöltve (párhuzamos is lehet). Alapértelmezés szerint 32*1024*1024
vagy 32 MB.
- max_chunk_get_size
- int
A blobok 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ónak nincs aktív bérlete, 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. 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 sikertelen lesz. |
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 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 a következő használatával állíthatók vissza:<xref:azure.storage.blob.aio.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.aio.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. A chunks() használatával egy aszinkron iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbökben lévő tartalom fölé 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 a lapblobszinteket a blobokon. 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 beállítja a réteget a blokkblobokon. 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óban lévő 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ónak nincs aktív bérlete, a Blob szolgáltatás létrehoz egy bérletet a tárolón, és egy új bérletazonosítót ad vissza.
async acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> BlobLeaseClient
Paraméterek
- lease_duration
- int
Megadja a bérlet időtartamát másodpercben vagy negatív (-1) egy olyan bérlet esetén, 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
Javasolt bérletazonosító GUID sztringformátumban. A Blob szolgáltatás 400-et (érvénytelen kérést) 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 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.
- 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
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. Környezetkezelővel való használathoz nem szükséges használni.
async 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 sikertelen lesz.
async create_container(metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]
Paraméterek
A tárolóhoz metaadatként társítandó name_value párokkal rendelkező diktálás. Példa:{'Category':'test'}
- 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ó.
A 12.2.0-s verzió újdonságai.
- 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á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 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 a következő használatával állíthatók vissza:<xref:azure.storage.blob.aio.BlobClient.undelete>
async delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None
Paraméterek
- blob
- str vagy BlobProperties
Az a blob, amellyel kommunikálni szeretne. 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
Akkor szükséges, ha a blob rendelkezik társított pillanatképekkel. 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.
- 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.
A 12.4.0-s verzió újdonsága.
Ez a kulcsszóargumentum a "2019-12-12" API-verzióban jelent meg.
- lease
- BlobLeaseClient vagy str
Akkor szükséges, ha a blob rendelkezik aktív bérlettal. Az érték lehet bérletobjektum 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.aio.BlobClient.undelete>
Az egyetlen kérelemben törölhető blobok maximális száma 256.
async delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> AsyncIterator[AsyncHttpResponse]
Paraméterek
- blobs
- str vagy dict(str, Any) vagy BlobProperties
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
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. Az optimális teljesítmény érdekében ezt False (Hamis) értékre kell állítani.
- 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
Válaszok aszinkron iterátora, minden blobhoz egy-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.
async 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álandó egyezé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. A chunks() használatával egy aszinkron iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbökben lévő tartalom fölé iteráljon.
async download_blob(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]
Paraméterek
- blob
- str vagy BlobProperties
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
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
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.
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.
Aszinkron 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
Streamelési objektum. (StorageStreamDownloader)
Visszatérési típus
exists
Igaz értéket ad vissza, ha egy tároló létezik, és hamis értéket ad vissza.
async 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) -> AsyncItemPaged[FilteredBlob]
Paraméterek
- filter_expression
- str
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
- credential
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
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
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".
async 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: BlobProperties | str, snapshot: str = None, *, version_id: str | None = None) -> BlobClient
Paraméterek
- snapshot
- str
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.
async 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.
async 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) -> AsyncItemPaged[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) -> AsyncItemPaged[BlobProperties]
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.
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.
async set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs: Any) -> Dict[str, str | datetime]
Paraméterek
- signed_identifiers
- dict[str, AccessPolicy]
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.
- 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.
async set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]
Paraméterek
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.
- 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).
set_premium_page_blob_tier_blobs
Beállítja a lapblobszinteket a blobokon. 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.
async set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> AsyncIterator[AsyncHttpResponse]
Paraméterek
- premium_page_blob_tier
- PremiumPageBlobTier
Egy lapblobszint-érték, amely az összes blobra be van állítva. 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
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, a rendszer kivételt hoz létre, még akkor is, ha egyetlen művelethiba történik. Az optimális teljesítmény érdekében ezt False (Hamis) értékre kell állítani.
Válaszok
Válaszok aszinkron iterátora, minden blobhoz egy-egy sorrendben
Visszatérési típus
set_standard_blob_tier_blobs
Ez a művelet beállítja a réteget a blokkblobokon.
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.
async set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> AsyncIterator[AsyncHttpResponse]
Paraméterek
- standard_blob_tier
- str vagy StandardBlobTier
Az összes blobon beállítandó szintet jelzi. A lehetőségek közé tartozik a "Gyakori elérésű", a "Ritka elérésű" é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 olyan adatok tárolására van optimalizálva, amelyekhez legalább egy hónapig ritkán férnek hozzá és tárolnak. Az archív szint olyan adatok tárolására van optimalizálva, amelyek ritkán érhetők el és legalább hat hónapig tárolhatók 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 blobszintet figyelembe vesz.
- blobs
- str vagy dict(str, Any) vagy BlobProperties
Azok a blobok, amelyekkel kommunikálni szeretne. 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
standard blobszint:
key: "blob_tier", értéktípus: StandardBlobTier
rehidratálás prioritása:
key: "rehydrate_priority", értéktípus: RehydratePriority
Bérleti:
key: "lease_id", értéktípus: Union[str, LeaseClient]
a címkék megfelelnek a feltételnek:
key: "if_tags_match_condition", értéktípus: str
a részkérés időtúllépése:
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 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.
- 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. Az optimális teljesítmény érdekében ezt False (Hamis) értékre kell állítani.
Válaszok
Válaszok aszinkron iterátora, minden blobhoz egy-egy sorrendben
Visszatérési típus
upload_blob
Új blobot hoz létre egy adatforrásból automatikus adattömbökkel.
async upload_blob(name: str | BlobProperties, data: bytes | str | Iterable | AsyncIterable | 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
Az a blob, amellyel kommunikálni szeretne. Ha meg van adva, ez az érték felülbírálja a blob URL-címében megadott blobértéket.
- data
A feltöltendő blobadatok.
- blob_type
- BlobType
A blob típusa. Ez lehet BlockBlob, PageBlob vagy AppendBlob. Az alapértelmezett érték a BlockBlob.
- length
- int
A streamből beolvasandó bájtok száma. Ez nem kötelező, de az optimális teljesítmény érdekében kell megadni.
- overwrite
- bool
Azt határozza meg, 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 ResourceExistsError értékkel meghiúsul. A fentiek alól kivételt képeznek a Hozzáfűző blobtípusok: ha False (Hamis) értékre van állítva, és az adatok már léteznek, a rendszer nem ad hibát, és az adatok hozzá lesznek fűzve a meglévő blobhoz. Ha a set overwrite=True értékre van állítva, 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, kiszámít egy MD5-kivonatot a blob minden egyes darabjára. A tárolási szolgáltatás ellenőrzi annak a tartalomnak a kivonatát, amely az elküldött kivonattal érkezett. Ez elsősorban akkor hasznos, ha bitflipeket észlel a vezetéken, ha https helyett HTTP-t használ, 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 blokkok pufferelésére van szükség, és ez nem teszi lehetővé a memóriahatékony algoritmus használatát.
- lease
- BlobLeaseClient vagy str
Kötelező, ha a tároló aktív bérletet kapott. 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. Ez a metódus több hívást is indíthat a szolgáltatás felé, és az időtúllépés minden hívásra külön-külön vonatkozik. 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 vonatkozik.
- premium_page_blob_tier
- PremiumPageBlobTier
Egy lapblobréteg-érték, amely a blobot értékre állítja. 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ókokban található lapblobokra vonatkozik.
- standard_blob_tier
- StandardBlobTier
Egy standard blobszint-érték, amely a blobot értékre állítja. A kódtár ezen verziójára ez csak a standard tárfiókokon található blokkblobokra vonatkozik.
- maxsize_condition
- int
Nem kötelező feltételes fejléc. A hozzáfűző blob megengedett maximális hossza bájtban. Ha a Hozzáfűzési blokk művelet miatt a blob túllépné 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étel sikertelen).
- max_concurrency
- int
A párhuzamos kapcsolatok maximális száma, ha a blob mérete meghaladja a 64 MB-ot.
A szolgáltatásoldali 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 gombra. Ha a tárolóban alapértelmezett titkosítási hatókör van meghatározva, ez az érték felülbírálja azt, ha a tárolószintű hatókör úgy van konfigurálva, hogy engedélyezze a felülbírálásokat. Ellenkező esetben hiba lép fel.
A 12.2.0-s verzió újdonságai.
- encoding
- str
Alapértelmezés szerint UTF-8.
Aszinkron 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(aktuális: int, összeg: Nem kötelező[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óban lévő 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) -> AsyncItemPaged[BlobProperties]
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.
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
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 sztringgel kezdődik, egészen az elválasztó karakter megjelenéséhez. Az elválasztó karakter lehet egy karakter vagy egy sztring.
- 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 BlobProperties iterable (automatikus lapozás) 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 helyalapú mód.
Alapértelmezés szerint ez az "elsődleges" lesz. A lehetőségek 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
Ha konfigurálva van, a teljes másodlagos végpont URL-címe.
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, akkor a Nincs érték jelenik meg. 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
Azure SDK for Python
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: