AzureFileDatastore 類別

表示將資料存放區儲存至 Azure 檔案儲存體的連線資訊。

您不應該直接使用此類別。 若要建立此類型的資料存放區，請使用 register_azure_file_share 資料存放區的方法。

注意：使用資料存放區存取資料時，您必須具有存取該資料的許可權，這取決於向資料存放區註冊的認證。

初始化新的 Azure 檔案共用資料存放區。

繼承

AbstractAzureStorageDatastore

AzureFileDatastore

建構函式

AzureFileDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint='core.windows.net', request_session=None)

參數

workspace

Workspace

必要

此資料存放區所屬的工作區。

name

str

必要

資料存放區的名稱。 它只能包含英數位元或 - 或 _。

container_name

str

必要

檔案共用名稱

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>

預設值: core.windows.net

Blob 容器的端點。 如果為 None，則預設為 core.windows.net。

request_session

<xref:requests.sessions.Session>, <xref:optional>

預設值: None

要用於 HTTP 要求的會話物件。 預設值為 None。

workspace

Workspace

必要

此資料存放區所屬的工作區。

name

str

必要

資料存放區的名稱。 它只能包含英數位元或 - 或 _。

container_name

str

必要

檔案共用名稱

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.sessions.Session>, <xref:optional>

必要

要用於 HTTP 要求的會話物件。 預設值為 None。

方法

download	將資料從檔案共用下載到本機檔案系統。
upload	將資料從本機檔案系統上傳至此資料存放區所指向的檔案共用。 注意：若要讓這個方法運作，資料存放區物件必須已填入帳戶金鑰或 SAS 權杖屬性。 如果資料存放區物件未包含任何形式的認證，此方法將會失敗。 此外，這個方法已被取代，未來可能會移除。 建議您使用 Dataset.File.upload_directory 方法來從本機目錄上傳檔案，並在單一方法呼叫中建立 FileDataset。
upload_files	將資料從本機檔案系統上傳至此資料存放區所指向的檔案共用。 注意：這個方法已被取代，不再受到支援。 建議改用 FileDatasetFactory.upload_directory 。

download

將資料從檔案共用下載到本機檔案系統。

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

參數

target_path

str

必要

要下載檔案的本機目錄。

prefix

str, <xref:optional>

預設值: None

要下載之檔案共用中資料夾的路徑。 如果設定為 [無]，Azure Machine Learning 將會下載檔案共用中的所有內容。

overwrite

bool, <xref:optional>

預設值: False

指出是否要覆寫現有的檔案。

show_progress

bool, <xref:optional>

預設值: True

指出是否要在主控台中顯示下載進度。

傳回

已成功下載的檔案數目。

傳回類型

int

upload

將資料從本機檔案系統上傳至此資料存放區所指向的檔案共用。

注意：若要讓這個方法運作，資料存放區物件必須已填入帳戶金鑰或 SAS 權杖屬性。 如果資料存放區物件未包含任何形式的認證，此方法將會失敗。 此外，這個方法已被取代，未來可能會移除。 建議您使用 Dataset.File.upload_directory 方法來從本機目錄上傳檔案，並在單一方法呼叫中建立 FileDataset。

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

參數

src_dir

str

必要

要上傳的本機目錄。

target_path

str

必要

要上傳至之檔案共用中的位置。 如果為 None，則上傳至根目錄。

overwrite

bool, <xref:optional>

必要

指出是否要覆寫現有的檔案。

show_progress

bool, <xref:optional>

必要

指出是否要在主控台中顯示上傳的進度。

傳回

上傳目標路徑的 DataReference 實例。

傳回類型

DataReference

upload_files

將資料從本機檔案系統上傳至此資料存放區所指向的檔案共用。

注意：這個方法已被取代，不再受到支援。 建議改用 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>

必要

用來判斷檔案共用中檔案路徑的基底路徑。 例如，如果您上傳 /path/to/file.txt，而您將基底路徑定義為 /path，file.txt上傳至檔案共用時，其路徑會是 /to/file.txt。 如果 target_path 也指定 ，則會使用它作為上述衍生路徑的前置詞。 基底路徑必須是所有檔案的通用路徑，否則會擲回例外狀況。 預設值為 None，它會尋找常見的路徑。

target_path

str, <xref:optional>

必要

檔案共用中要上傳資料的位置。 預設值為 None，即根目錄。

overwrite

bool, <xref:optional>

必要

指出是否要覆寫現有的檔案。

show_progress

bool, <xref:optional>

必要

指出是否要在主控台中顯示上傳的進度。

傳回

上傳目標路徑的 DataReference 實例。

傳回類型

DataReference