AzureBlobDatastore クラス

  • リファレンス

Azure Blob Storage に接続情報を保存するデータストアを表します。

このクラスを直接操作することはできません。 この種類のデータストアを作成するには、Datastore の register_azure_blob_container メソッドを使用します。

注: データストアを使用してデータにアクセスする場合、そのデータにアクセスする権限が必要です。権限は、データストアに登録されている資格情報に依存します。

新しい Azure Blob データストアを初期化します。

継承
AbstractAzureStorageDatastore
AzureBlobDatastore

コンストラクター

AzureBlobDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint=None, request_session=None, workspace_msi_has_access=False, subscription_id=None, resource_group=None, service_data_access_auth_identity=None)

パラメーター

workspace
Workspace
必須

このデータストアが属しているワークスペース。

name
str
必須

データストアの名前。 使用できるのは英数字または - または _ のみです。

container_name
str
必須

BLOB コンテナー名。

account_name
str
必須

ストレージ アカウント名。

sas_token
str, <xref:optional>
既定値: None

このコンテナーにアクセスするための SAS トークン。 既定値は None です。

account_key
str, <xref:optional>
既定値: None

ストレージ アカウント キー。 既定値は None です。

protocol
str, <xref:optional>
既定値: None

ストレージ アカウントへの接続に使用するプロトコル。 None の場合、既定値は https です。

endpoint
str, <xref:optional>
既定値: None

BLOB コンテナーのエンドポイント。 None の場合、既定値は core.windows.net です。

request_session
<xref:requests.Session>, <xref:optional>
既定値: None

http 要求に使用するセッション オブジェクト。 既定値は None です。

workspace
Workspace
必須

このデータストアが属しているワークスペース。

name
str
必須

データストアの名前。 使用できるのは英数字または - または _ のみです。

container_name
str
必須

BLOB コンテナー名。

account_name
str
必須

ストレージ アカウント名。

sas_token
str, <xref:optional>
必須

このコンテナーにアクセスするための SAS トークン。 既定値は None です。

account_key
str, <xref:optional>
必須

ストレージ アカウント キー。 既定値は None です。

protocol
str, <xref:optional>
必須

ストレージ アカウントへの接続に使用するプロトコル。 None の場合、既定値は https です。

endpoint
str, <xref:optional>
必須

BLOB コンテナーのエンドポイント。 None の場合、既定値は core.windows.net です。

request_session
<xref:requests.Session>, <xref:optional>
必須

http 要求に使用するセッション オブジェクト。 既定値は None です。

workspace_msi_has_access
bool, <xref:optional>
既定値: False

ワークスペース MSI がこのストレージ アカウントにアクセスできるかどうか。(非推奨)

subscription_id
str, <xref:optional>
既定値: None

ストレージ アカウントのサブスクリプション ID。

resource_group
str, <xref:optional>
既定値: None

ストレージ アカウントのリソース グループ。

service_data_access_auth_identity
str または <xref:_restclient.models.ServiceDataAccessAuthIdentity>
既定値: None

顧客のストレージへのサービス データ アクセスを認証するために使用する ID を示します。 指定できる値は、"None"、"WorkspaceSystemAssignedIdentity"、"WorkspaceUserAssignedIdentity" です

メソッド

download

BLOB コンテナーからローカル ファイル システムにデータをダウンロードします。
upload

データをローカル ファイル システムから、このデータ ストアが参照する BLOB コンテナーにアップロードします。

注: このメソッドを機能させるには、データストア オブジェクトにアカウント キーまたは SAS トークン プロパティが設定されている必要があります。 データストア オブジェクトにどの形式の資格情報も含まれていない場合、このメソッドは失敗します。 さらに、このメソッドは非推奨になっており、今後削除される可能性があります。 Dataset.File.upload_directory メソッドを使用してローカル ディレクトリからファイルをアップロードし、1 回のメソッド呼び出しで FileDataset を作成することをお勧めします。
upload_files

データをローカル ファイル システムから、このデータストアが参照する BLOB コンテナーにアップロードします。

注: このメソッドは非推奨とされており、サポートされなくなりました。 代わりに FileDatasetFactory.upload_directory を使用することをお勧めします。

download

BLOB コンテナーからローカル ファイル システムにデータをダウンロードします。

download(target_path, prefix=None, overwrite=False, show_progress=True)

パラメーター

target_path
str
必須

ファイルのダウンロード先であるローカル ディレクトリ。

prefix
str, <xref:optional>
既定値: None

ダウンロードする BLOB コンテナー内のフォルダーへのパス。 None に設定すると、すべてを BLOB 内にダウンロードします。 既定値は None です。

overwrite
bool, <xref:optional>
既定値: False

既存のファイルを上書きするかどうかを示します。 既定値は False です。

show_progress
bool, <xref:optional>
既定値: True

コンソールにダウンロードの進行状況を表示するかどうかを示します。 既定値は True です。

戻り値

正常にダウンロードされたファイルの数。

の戻り値の型 :

int

upload

データをローカル ファイル システムから、このデータ ストアが参照する BLOB コンテナーにアップロードします。

注: このメソッドを機能させるには、データストア オブジェクトにアカウント キーまたは SAS トークン プロパティが設定されている必要があります。 データストア オブジェクトにどの形式の資格情報も含まれていない場合、このメソッドは失敗します。 さらに、このメソッドは非推奨になっており、今後削除される可能性があります。 Dataset.File.upload_directory メソッドを使用してローカル ディレクトリからファイルをアップロードし、1 回のメソッド呼び出しで FileDataset を作成することをお勧めします。

upload(src_dir, target_path=None, overwrite=False, show_progress=True)

パラメーター

src_dir
str
必須

アップロードするローカル ディレクトリ。

target_path
str
必須

アップロード先の BLOB コンテナー内の場所。 None の場合は、ルートにアップロードします。 既定値は None です。

overwrite
bool, <xref:optional>
必須

既存のファイルを上書きするかどうかを示します。 既定値は False です。

show_progress
bool, <xref:optional>
必須

コンソールにアップロードの進行状況を表示するかどうかを示します。 既定値は True です。

戻り値

アップロードされたターゲット パスの DataReference インスタンス。

の戻り値の型 :

DataReference

upload_files

データをローカル ファイル システムから、このデータストアが参照する BLOB コンテナーにアップロードします。

注: このメソッドは非推奨とされており、サポートされなくなりました。 代わりに FileDatasetFactory.upload_directory を使用することをお勧めします。

upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)

パラメーター

files
list[str]
必須

アップロードするファイルの絶対パスの一覧。

relative_root
str, <xref:optional>
必須

BLOB 内のファイルのパスを決定するために使用するルート。 たとえば、/path/to/file.txt をアップロードし、基本パスを /path に定義した場合、file.txt が BLOB ストレージにアップロードされると、そのパスは /to/file.txt になります。 target_path も指定されている場合は、上の派生パスのプレフィックスとして使用されます。 ベース パスは、すべてのファイルの共通パスである必要があります。そうしないと、例外がスローされます。 既定値は None であり、この場合は共通パスが検索されます。

target_path
str, <xref:optional>
必須

データのアップロード先である BLOB コンテナー内の場所。 既定値は None (ルート) です。

overwrite
bool, <xref:optional>
必須

既存のファイルを上書きするかどうかを示します。 既定値は False です。

show_progress
bool, <xref:optional>
必須

コンソールにアップロードの進行状況を表示するかどうかを示します。 既定値は True です。

戻り値

アップロードされたターゲット パスの DataReference インスタンス。

の戻り値の型 :

DataReference