AzureFileDatastore クラス
Azure File Storage への接続情報を保存するデータストアを表します。
このクラスを直接操作することはできません。 この種類のデータストアを作成するには、Datastore の register_azure_file_share メソッドを使用します。
注: データストアを使用してデータにアクセスする場合、そのデータにアクセスする権限が必要です。権限は、データストアに登録されている資格情報に依存します。
新しい Azure ファイル共有データストアを初期化します。
- 継承
-
AzureFileDatastore
コンストラクター
AzureFileDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint='core.windows.net', request_session=None)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
このデータストアが属しているワークスペース。 |
name
必須
|
データストアの名前。 使用できるのは英数字または - または _ のみです。 |
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 です。 規定値: core.windows.net
|
request_session
|
<xref:requests.sessions.Session>, <xref:optional>
http 要求に使用するセッション オブジェクト。 既定値は None です。 規定値: None
|
workspace
必須
|
このデータストアが属しているワークスペース。 |
name
必須
|
データストアの名前。 使用できるのは英数字または - または _ のみです。 |
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 です。 |
request_session
必須
|
<xref:requests.sessions.Session>, <xref:optional>
http 要求に使用するセッション オブジェクト。 既定値は None です。 |
メソッド
download |
ファイル共有からローカル ファイル システムにデータをダウンロードします。 |
upload |
ローカル ファイル システムから、このデータストアが指しているファイル共有に、データをアップロードします。 注: このメソッドを機能させるには、データストア オブジェクトにアカウント キーまたは SAS トークン プロパティが設定されている必要があります。 データストア オブジェクトにどの形式の資格情報も含まれていない場合、このメソッドは失敗します。
さらに、このメソッドは非推奨になっており、今後削除される可能性があります。
|
upload_files |
ローカル ファイル システムから、このデータストアが指しているファイル共有に、データをアップロードします。 注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに |
download
ファイル共有からローカル ファイル システムにデータをダウンロードします。
download(target_path, prefix=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
target_path
必須
|
ファイルのダウンロード先であるローカル ディレクトリ。 |
prefix
|
str, <xref:optional>
ダウンロードするファイル共有内のフォルダーのパス。 None に設定すると、Azure Machine Learning はファイル共有内のすべてのものをダウンロードします。 規定値: None
|
overwrite
|
bool, <xref:optional>
既存のファイルを上書きするかどうかを示します。 規定値: False
|
show_progress
|
bool, <xref:optional>
コンソールにダウンロードの進行状況を表示するかどうかを示します。 規定値: True
|
戻り値
型 | 説明 |
---|---|
正常にダウンロードされたファイルの数。 |
upload
ローカル ファイル システムから、このデータストアが指しているファイル共有に、データをアップロードします。
注: このメソッドを機能させるには、データストア オブジェクトにアカウント キーまたは SAS トークン プロパティが設定されている必要があります。 データストア オブジェクトにどの形式の資格情報も含まれていない場合、このメソッドは失敗します。
さらに、このメソッドは非推奨になっており、今後削除される可能性があります。
Dataset.File.upload_directory
メソッドを使用してローカル ディレクトリからファイルをアップロードし、1 回のメソッド呼び出しで FileDataset を作成することをお勧めします。
upload(src_dir, target_path=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
src_dir
必須
|
アップロードするローカル ディレクトリ。 |
target_path
必須
|
アップロード先のファイル共有内の場所。 None の場合は、ルートにアップロードされます。 |
overwrite
必須
|
bool, <xref:optional>
既存のファイルを上書きするかどうかを示します。 |
show_progress
必須
|
bool, <xref:optional>
コンソールにアップロードの進行状況を表示するかどうかを示します。 |
戻り値
型 | 説明 |
---|---|
アップロードされたターゲット パスの DataReference インスタンス。 |
upload_files
ローカル ファイル システムから、このデータストアが指しているファイル共有に、データをアップロードします。
注: このメソッドは非推奨となっており、今後はサポートされなくなります。 代わりに FileDatasetFactory.upload_directory
を使用することをお勧めします。
upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)
パラメーター
名前 | 説明 |
---|---|
files
必須
|
アップロードするファイルの絶対パスの一覧。 |
relative_root
必須
|
str, <xref:optional>
ファイル共有内のファイルのパスを決定するために使用されるベース パス。 たとえば、/path/to/file.txt をアップロードし、ベース パスとして /path を定義した場合、file.txt をファイル共有にアップロードすると、そのパスは /to/file.txt になります。
|
target_path
必須
|
str, <xref:optional>
データのアップロード先であるファイル共有内の場所。 既定値は None でルートです。 |
overwrite
必須
|
bool, <xref:optional>
既存のファイルを上書きするかどうかを示します。 |
show_progress
必須
|
bool, <xref:optional>
コンソールにアップロードの進行状況を表示するかどうかを示します。 |
戻り値
型 | 説明 |
---|---|
アップロードされたターゲット パスの DataReference インスタンス。 |