aio パッケージ

  • リファレンス

クラス

BlobClient

特定の BLOB と対話するクライアント。ただし、その BLOB はまだ存在しない可能性があります。
BlobLeaseClient

新しい BlobLeaseClient を作成します。

このクライアントは、BlobClient または ContainerClient に対するリース操作を提供します。
BlobPrefix

BLOB プロパティの Iterable。

区切り記号が使用されている場合にwalk_blobsから返されます。 仮想 BLOB ディレクトリと考えることができます。
BlobServiceClient

アカウント レベルで BLOB サービスと対話するクライアント。

このクライアントは、アカウントのプロパティの取得と構成、およびアカウント内のコンテナーの一覧表示、作成、削除を行う操作を提供します。 特定のコンテナーまたは BLOB に関連する操作の場合、これらのエンティティのクライアントは 、get_client 関数を使用して取得することもできます。
ContainerClient

特定のコンテナーと対話するクライアント。ただし、そのコンテナーはまだ存在しない可能性があります。

このコンテナー内の特定の BLOB に関連する操作では、 関数を使用して BLOB クライアントを get_blob_client 取得できます。
ExponentialRetry

指数関数的再試行。

指数再試行オブジェクトを構築します。 initial_backoffは、最初の再試行に使用されます。 後続の再試行は、initial_backoff + increment_power^retry_count 秒後に再試行されます。 たとえば、既定では、最初の再試行は 15 秒後、2 回目の再試行は (15+3^1) = 18 秒、3 回目の再試行は (15 + 3^2) = 24 秒後に行われます。
LinearRetry

線形再試行。

Linear 再試行オブジェクトを構築します。
StorageStreamDownloader

Azure Storage からダウンロードするストリーミング オブジェクト。

機能

download_blob_from_url

BLOB の内容をローカル ファイルまたはストリームにダウンロードします。

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

パラメーター

blob_url
str
必須

BLOB への完全な URI。 これには SAS トークンを含めることもできます。

output
str または <xref:<xref:writable stream>>
必須

データのダウンロード先。 これは、書き込み対象のファイル パス、または書き込み対象の開いている IO ハンドルのいずれかです。

credential
既定値: None

認証に使用する資格情報。 これは、BLOB URL に既に SAS トークンがある場合、または BLOB がパブリックである場合は省略可能です。 値には、SAS トークン文字列、azure.core.credentials の AzureSasCredential または AzureNamedKeyCredential のインスタンス、アカウント共有アクセス キー、または azure.identity の TokenCredentials クラスのインスタンスを指定できます。 リソース URI に SAS トークンが既に含まれている場合、明示的な資格情報を優先して無視されます

  • 競合する SAS トークンによって ValueError が発生する AzureSasCredential の場合を除きます。 AzureNamedKeyCredential のインスタンスを使用する場合は、"name" をストレージ アカウント名に、"key" をストレージ アカウント キーにする必要があります。
overwrite
bool

ローカル ファイルが既に存在する場合に上書きする必要があるかどうか。 既定値は False です。この場合、ファイルが既に存在する場合は ValueError が発生します。 True に設定すると、既存のファイルへの書き込みが試行されます。 ストリーム ハンドルが渡された場合、この値は無視されます。

max_concurrency
int

ダウンロードする並列接続の数。

offset
int

BLOB のセクションのダウンロードに使用するバイト範囲の開始。 length が指定されている場合は、 を設定する必要があります。

length
int

ストリームから読み取るバイト数。 これは省略可能ですが、最適なパフォーマンスを得るための指定が必要です。

validate_content
bool

true の場合、BLOB の各チャンクの MD5 ハッシュを計算します。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは BLOB と共に保存されません。 また、有効にすると、MD5 ハッシュを計算するにはブロック全体のバッファリングが必要であり、メモリ効率の高いアルゴリズムの目的が無効になるため、メモリ効率の高いアップロード アルゴリズムは使用されないことに注意してください。

の戻り値の型 :

None

upload_blob_to_url

特定の URL にデータをアップロードする

データはブロック BLOB としてアップロードされます。

param str blob_url: BLOB への完全な URI。 これには SAS トークンを含めることもできます。

param data: アップロードするデータ。 これには、バイト、テキスト、iterable、またはファイルに似たオブジェクトを指定できます。

型データ: bytes または str または 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]

パラメーター

credential
既定値: None

認証に使用する資格情報。 BLOB URL に SAS トークンが既に含まれている場合、これは省略可能です。 値には、SAS トークン文字列、azure.core.credentials の AzureSasCredential または AzureNamedKeyCredential のインスタンス、アカウント共有アクセス キー、または azure.identity の TokenCredentials クラスのインスタンスを指定できます。 リソース URI に SAS トークンが既に含まれている場合、明示的な資格情報を優先して無視されます

  • 競合する SAS トークンによって ValueError が発生する AzureSasCredential の場合を除きます。 AzureNamedKeyCredential のインスタンスを使用する場合は、"name" をストレージ アカウント名に、"key" をストレージ アカウント キーにする必要があります。

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

キーワード (keyword) bool overwrite: アップロードする BLOB が現在のデータを上書きするかどうかを指定します。 True の場合、upload_blob_to_urlは既存のデータを上書きします。 False に設定すると、ResourceExistsError で操作は失敗します。

キーワード (keyword) int max_concurrency: ダウンロードする並列接続の数。

キーワード (keyword) int の長さ: ストリームから読み取るバイト数。 これは省略可能ですが、最適なパフォーマンスを得るための指定が必要です。

dict(str,str) メタデータのキーワード (keyword): BLOB にメタデータとして関連付けられている名前と値のペア。

キーワード (keyword) bool validate_content: true の場合、BLOB の各チャンクの MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは BLOB と共に保存されません。 また、有効にすると、MD5 ハッシュを計算するにはブロック全体のバッファリングが必要であり、メモリ効率の高いアルゴリズムの目的が無効になるため、メモリ効率の高いアップロード アルゴリズムは使用されないことに注意してください。

キーワード (keyword) str エンコード: テキストが入力として指定されている場合に使用するエンコード。 既定値は UTF-8 です。

returns: Blob-updated プロパティ dict (Etag と最終変更)

rtype: dict(str, Any)

blob_url
data