AbstractAzureStorageDatastore クラス
Azure Blob と Azure File ストレージへの接続情報を保存するデータストアの基底クラスを表します。
このクラスを直接操作することはできません。 データストアを作成するには、register_azure_blob_container など、Datastore クラスの register*
メソッドのいずれかを使用します。
注: データストアを使用してデータにアクセスする場合は、データにアクセスする権限が必要です。必要な権限は、データストアに登録されている資格情報によって異なります。
Class AbstractAzureStorageDatastore コンストラクター。
- 継承
-
AbstractAzureStorageDatastore
コンストラクター
AbstractAzureStorageDatastore(workspace, name, datastore_type, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint=None)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
このデータストアが属しているワークスペース。 |
name
必須
|
データストアの名前。 使用できるのは英数字または - または _ のみです。 |
datastore_type
必須
|
このデータストアの種類 (AzureBlob または AzureFile)。 |
container_name
必須
|
コンテナーの名前。 |
account_name
必須
|
ストレージ アカウント名。 |
sas_token
|
str, <xref:optional>
このコンテナーにアクセスするための SAS トークン。既定値は None です。 規定値: None
|
account_key
|
str, <xref:optional>
ストレージ アカウント キー。既定値は None です。 規定値: None
|
protocol
|
str, <xref:optional>
ストレージ アカウントへの接続に使用するプロトコル。 None の場合、既定値は https です。 規定値: None
|
endpoint
|
str, <xref:optional>
BLOB コンテナーのエンドポイント。 None の場合、既定値は core.windows.net です。 規定値: None
|
workspace
必須
|
このデータストアが属しているワークスペース。 |
name
必須
|
データストアの名前。 使用できるのは英数字または - または _ のみです。 |
datastore_type
必須
|
このデータストアの種類 (AzureBlob または AzureFile)。 |
container_name
必須
|
コンテナーの名前。 |
account_name
必須
|
ストレージ アカウント名。 |
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 です。 |
メソッド
as_download |
データ参照オブジェクトをダウンロード モードで返します。 注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに |
as_mount |
データ参照オブジェクトをマウント モードで返します。 注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに |
as_upload |
データ参照オブジェクトをアップロード モードで返します。 注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに、データセットを使用してアップロードすることをお勧めします。 |
download |
プレフィックス付きのパスを target_path にダウンロードします。 |
path |
対応するデータ参照オブジェクトを返します。 |
upload |
src_dir を target_path にアップロードします。 |
upload_files |
ファイルを target_path にアップロードします。 |
as_download
データ参照オブジェクトをダウンロード モードで返します。
注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに file_dataset.as_download
を使用することをお勧めします。
as_download(path_on_compute=None)
パラメーター
名前 | 説明 |
---|---|
path_on_compute
必須
|
コンピューティングでの相対パス。 |
戻り値
型 | 説明 |
---|---|
データ参照オブジェクト。 |
as_mount
データ参照オブジェクトをマウント モードで返します。
注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに file_dataset.as_mount
を使用することをお勧めします。
as_mount()
パラメーター
名前 | 説明 |
---|---|
path_on_compute
必須
|
コンピューティングでの相対パス。 |
戻り値
型 | 説明 |
---|---|
データ参照オブジェクト。 |
as_upload
データ参照オブジェクトをアップロード モードで返します。
注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに、データセットを使用してアップロードすることをお勧めします。
as_upload(path_on_compute=None)
パラメーター
名前 | 説明 |
---|---|
path_on_compute
必須
|
コンピューティングでの相対パス。 |
戻り値
型 | 説明 |
---|---|
データ参照オブジェクト。 |
download
プレフィックス付きのパスを target_path にダウンロードします。
abstract download(target_path, prefix=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
target_path
必須
|
|
prefix
|
規定値: None
|
overwrite
|
規定値: False
|
show_progress
|
規定値: True
|
path
対応するデータ参照オブジェクトを返します。
path(path=None, data_reference_name=None)
パラメーター
名前 | 説明 |
---|---|
path
|
データストアの相対パス。 規定値: None
|
data_reference_name
|
データ参照の名前。 規定値: None
|
戻り値
型 | 説明 |
---|---|
データ参照オブジェクト。 |
upload
src_dir を target_path にアップロードします。
abstract upload(src_dir, target_path=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
src_dir
必須
|
|
target_path
|
規定値: None
|
overwrite
|
規定値: False
|
show_progress
|
規定値: True
|
upload_files
ファイルを target_path にアップロードします。
abstract upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
files
必須
|
|
relative_root
|
ターゲットでの相対パス。 規定値: None
|
target_path
|
規定値: None
|
overwrite
|
規定値: False
|
show_progress
|
規定値: True
|
属性
is_sas
credential_type
プロパティを使用します。
このプロパティは非推奨となっています。資格情報の種類を確認するには、credential_type
プロパティを使用してください。