aio Pakiet

Klasy

BlobClient

Klient do interakcji z określonym obiektem blob, chociaż ten obiekt blob może jeszcze nie istnieć.

BlobLeaseClient

Tworzy nowy obiekt BlobLeaseClient.

Ten klient udostępnia operacje dzierżawy w obiekcie BlobClient lub ContainerClient.

BlobPrefix

Iterable właściwości obiektu blob.

Zwracany z walk_blobs, gdy jest używany ogranicznik. Można traktować jako katalog obiektów blob wirtualnych.

BlobServiceClient

Klient do interakcji z usługą Blob Service na poziomie konta.

Ten klient udostępnia operacje pobierania i konfigurowania właściwości konta, a także tworzenia i usuwania kontenerów w ramach konta. W przypadku operacji związanych z określonym kontenerem lub obiektem blob klienci dla tych jednostek można również pobrać przy użyciu funkcji get_client .

ContainerClient

Klient korzystający z określonego kontenera może jeszcze nie istnieć.

W przypadku operacji związanych z określonym obiektem blob w tym kontenerze get_blob_client można pobrać klienta obiektu blob przy użyciu funkcji .

ExponentialRetry

Ponów próbę wykładniczą.

Tworzy obiekt ponawiania wykładniczego. Initial_backoff służy do pierwszego ponawiania próby. Kolejne próby są ponawiane po initial_backoff + increment_power^retry_count sekundach. Na przykład pierwsza ponowna próba występuje domyślnie po 15 sekundach, drugi po (15+3^1) = 18 sekund, a trzeci po (15+3^2) = 24 sekundy.

LinearRetry

Ponów próbę liniową.

Tworzy obiekt ponawiania liniowego.

StorageStreamDownloader

Obiekt przesyłania strumieniowego do pobrania z usługi Azure Storage.

Funkcje

download_blob_from_url

Pobierz zawartość obiektu blob do lokalnego pliku lub strumienia.

async download_blob_from_url(blob_url: str, output: str, credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> None

Parametry

blob_url
str
Wymagane

Pełny identyfikator URI obiektu blob. Może to również obejmować token SAS.

output
str lub <xref:<xref:writable stream>>
Wymagane

Gdzie należy pobrać dane. Może to być ścieżka pliku do zapisu lub otwarta dojście we/wy do zapisu.

credential
wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL obiektu blob ma już token SAS lub obiekt blob jest publiczny. Wartość może być ciągiem tokenu sygnatury dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy azure.identity. Jeśli identyfikator URI zasobu zawiera już token sygnatury dostępu współdzielonego, zostanie on zignorowany na rzecz jawnego poświadczenia

  • z wyjątkiem przypadków usługi AzureSasCredential, gdzie powodujące konflikty tokeny SYGNATURy dostępu współdzielonego spowodują podniesienie wartościError. Jeśli używasz wystąpienia elementu AzureNamedKeyCredential, wartość "name" powinna być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.
overwrite
bool

Czy plik lokalny powinien zostać zastąpiony, jeśli już istnieje. Wartość domyślna to False — w tym przypadku wartośćError zostanie podniesiona, jeśli plik już istnieje. Jeśli ustawiono wartość True, zostanie podjęta próba zapisania w istniejącym pliku. Jeśli dojście strumienia jest przekazywane, ta wartość jest ignorowana.

max_concurrency
int

Liczba połączeń równoległych do pobrania.

offset
int

Początek zakresu bajtów do użycia podczas pobierania sekcji obiektu blob. Należy ustawić, jeśli jest podana długość.

length
int

Liczba bajtów do odczytu ze strumienia. Jest to opcjonalne, ale powinno być dostarczane w celu uzyskania optymalnej wydajności.

validate_content
bool

Jeśli wartość true, oblicza skrót MD5 dla każdego fragmentu obiektu blob. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https jako https (wartość domyślna) będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob. Należy również pamiętać, że w przypadku włączenia algorytm przekazywania wydajnego w pamięci nie będzie używany, ponieważ przetwarzanie skrótu MD5 wymaga buforowania całych bloków i w ten sposób pokonuje cel algorytmu wydajnego w pamięci.

Typ zwracany

upload_blob_to_url

Przekazywanie danych do danego adresu URL

Dane zostaną przekazane jako blokowy obiekt blob.

parametrm str blob_url: pełny identyfikator URI obiektu blob. Może to również obejmować token SAS.

dane param: dane do przekazania. Może to być bajty, tekst, iterowalny lub obiekt podobny do pliku.

typ danych: bajty lub str lub iterable

async upload_blob_to_url(blob_url: str, data: Union[Iterable[AnyStr], IO[AnyStr]], credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> dict[str, Any]

Parametry

credential
wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL obiektu blob ma już token SAS. Wartość może być ciągiem tokenu sygnatury dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy azure.identity. Jeśli identyfikator URI zasobu zawiera już token sygnatury dostępu współdzielonego, zostanie on zignorowany na rzecz jawnego poświadczenia

  • z wyjątkiem przypadków usługi AzureSasCredential, gdzie powodujące konflikty tokeny SYGNATURy dostępu współdzielonego spowodują podniesienie wartościError. Jeśli używasz wystąpienia elementu AzureNamedKeyCredential, wartość "name" powinna być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

paramtype credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long

Zastąpienie słowa kluczowego bool: czy obiekt blob, który ma zostać przekazany, powinien zastąpić bieżące dane. Jeśli prawda, upload_blob_to_url zastąpi wszystkie istniejące dane. Jeśli ustawiono wartość False, operacja zakończy się niepowodzeniem z błędem ResourceExistsError.

int słowa kluczowego max_concurrency: liczba połączeń równoległych do pobrania.

długość int słowa kluczowego: liczba bajtów do odczytu ze strumienia. Jest to opcjonalne, ale powinno być dostarczane w celu uzyskania optymalnej wydajności.

metadane dict(str,str) słowa kluczowego: pary name-value skojarzone z obiektem blob jako metadanymi.

wartość logiczna słowa kluczowego validate_content: jeśli wartość true, oblicza skrót MD5 dla każdego fragmentu obiektu blob. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https jako https (wartość domyślna) będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob. Należy również pamiętać, że w przypadku włączenia algorytm przekazywania wydajnego w pamięci nie będzie używany, ponieważ przetwarzanie skrótu MD5 wymaga buforowania całych bloków i w ten sposób pokonuje cel algorytmu wydajnego w pamięci.

Kodowanie str słów kluczowych: kodowanie, aby użyć, jeśli tekst jest dostarczany jako dane wejściowe. Wartość domyślna to UTF-8.

zwraca: właściwość zaktualizowana przez obiekt blob (Etag i ostatnia modyfikacja)

rtype: dict(str, Any)

blob_url
data