Compartilhar via


AzureFileDatastore Classe

Representa um armazenamento de dados que salva as informações de conexão no Armazenamento de Arquivos do Azure.

Você não deve trabalhar com essa classe diretamente. Para criar um armazenamento de dados desse tipo, use o método register_azure_file_share de Datastore.

Observação: ao usar um armazenamento de dados para acessar os dados, você deverá ter permissão para acessar os dados, o que depende das credenciais registradas no armazenamento de dados.

Inicialize um novo Armazenamento de Dados do Compartilhamento de Arquivos do Azure.

Herança
AzureFileDatastore

Construtor

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

Parâmetros

workspace
Workspace
Obrigatório

O workspace ao qual esse armazenamento de dados pertence.

name
str
Obrigatório

O nome do armazenamento de dados. Ele pode conter somente caracteres alfanuméricos, hifen e sublinhado.

container_name
str
Obrigatório

O nome do compartilhamento de arquivo

account_name
str
Obrigatório

O nome da conta de armazenamento

sas_token
str, <xref:optional>
valor padrão: None

O token SAS para acessar esse contêiner. A opção padrão é Nenhum.

account_key
str, <xref:optional>
valor padrão: None

A chave da conta de armazenamento. A opção padrão é Nenhum.

protocol
str, <xref:optional>
valor padrão: None

O protocolo a ser usado para se conectar à conta de armazenamento. Se for Nenhum, usará o valor padrão de https.

endpoint
str, <xref:optional>
valor padrão: core.windows.net

O ponto de extremidade do contêiner de blob. Se for Nenhum, usará o valor padrão de core.windows.net.

request_session
<xref:requests.sessions.Session>, <xref:optional>
valor padrão: None

O objeto de sessão a ser usado para solicitações HTTP. A opção padrão é Nenhum.

workspace
Workspace
Obrigatório

O workspace ao qual esse armazenamento de dados pertence.

name
str
Obrigatório

O nome do armazenamento de dados. Ele pode conter somente caracteres alfanuméricos, hifen e sublinhado.

container_name
str
Obrigatório

O nome do compartilhamento de arquivo

account_name
str
Obrigatório

O nome da conta de armazenamento

sas_token
str, <xref:optional>
Obrigatório

O token SAS para acessar esse contêiner. A opção padrão é Nenhum.

account_key
str, <xref:optional>
Obrigatório

A chave da conta de armazenamento. A opção padrão é Nenhum.

protocol
str, <xref:optional>
Obrigatório

O protocolo a ser usado para se conectar à conta de armazenamento. Se for Nenhum, usará o valor padrão de https.

endpoint
str, <xref:optional>
Obrigatório

O ponto de extremidade do contêiner de blob. Se for Nenhum, usará o valor padrão de core.windows.net.

request_session
<xref:requests.sessions.Session>, <xref:optional>
Obrigatório

O objeto de sessão a ser usado para solicitações HTTP. A opção padrão é Nenhum.

Métodos

download

Baixa os dados do compartilhamento de arquivo para o sistema de arquivos local.

upload

Carrega os dados do sistema de arquivos local para o compartilhamento de arquivo para o qual este armazenamento de dados aponta.

Observação: para que esse método funcione, o objeto de armazenamento de dados deve ter a chave de conta ou a propriedade do token SAS preenchida. Se o objeto do armazenamento de dados não contiver qualquer forma de credencial, esse método falhará. Além disso, esse método foi preterido e pode ser removido no futuro. Sugerimos que você use o método Dataset.File.upload_directory para carregar seus arquivos do diretório local e criar um FileDataset em uma única chamada de método.

upload_files

Carrega os dados do sistema de arquivos local para o compartilhamento de arquivo para o qual este armazenamento de dados aponta.

Observação: este método foi preterido e não terá mais suporte. Use FileDatasetFactory.upload_directory como alternativa.

download

Baixa os dados do compartilhamento de arquivo para o sistema de arquivos local.

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

Parâmetros

target_path
str
Obrigatório

O diretório local para o qual baixar o arquivo.

prefix
str, <xref:optional>
valor padrão: None

O caminho para a pasta no compartilhamento de arquivo a ser baixada. Se definido como Nenhum, o Azure Machine Learning baixará tudo no compartilhamento de arquivo.

overwrite
bool, <xref:optional>
valor padrão: False

Indica se o arquivo existente deve ser substituído.

show_progress
bool, <xref:optional>
valor padrão: True

Indica se o progresso do download deve ser mostrado no console.

Retornos

O número de arquivos baixados com êxito.

Tipo de retorno

int

upload

Carrega os dados do sistema de arquivos local para o compartilhamento de arquivo para o qual este armazenamento de dados aponta.

Observação: para que esse método funcione, o objeto de armazenamento de dados deve ter a chave de conta ou a propriedade do token SAS preenchida. Se o objeto do armazenamento de dados não contiver qualquer forma de credencial, esse método falhará. Além disso, esse método foi preterido e pode ser removido no futuro. Sugerimos que você use o método Dataset.File.upload_directory para carregar seus arquivos do diretório local e criar um FileDataset em uma única chamada de método.

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

Parâmetros

src_dir
str
Obrigatório

O diretório local para upload.

target_path
str
Obrigatório

O local no compartilhamento de arquivo para o qual carregar. Se definido como Nenhum, o upload é feito para a raiz.

overwrite
bool, <xref:optional>
Obrigatório

Indica se os arquivos existentes devem ser substituídos.

show_progress
bool, <xref:optional>
Obrigatório

Indica se é preciso mostrar o progresso do upload no console.

Retornos

A instância DataReference para o caminho de destino carregado.

Tipo de retorno

upload_files

Carrega os dados do sistema de arquivos local para o compartilhamento de arquivo para o qual este armazenamento de dados aponta.

Observação: este método foi preterido e não terá mais suporte. Use FileDatasetFactory.upload_directory como alternativa.

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

Parâmetros

files
list[str]
Obrigatório

Uma lista de caminho absoluto para arquivos a serem carregados.

relative_root
str, <xref:optional>
Obrigatório

O caminho base usado para determinar o caminho dos arquivos no compartilhamento de arquivo. Por exemplo, se você carregar /path/to/file.txt e você define o caminho base como /path, quando file.txt for carregado no compartilhamento de arquivo, ele terá o caminho /to/file.txt. Se target_path também for especificado, ele será usado como o prefixo para o caminho derivado daquele mostrado acima. O caminho base precisará ser um caminho comum de todos os arquivos, caso contrário, uma exceção será gerada. O padrão é Nenhum, que encontrará o caminho comum.

target_path
str, <xref:optional>
Obrigatório

O local no compartilhamento de arquivo para o qual carregar os dados. O padrão é Nenhum, a raiz.

overwrite
bool, <xref:optional>
Obrigatório

Indica se os arquivos existentes devem ser substituídos.

show_progress
bool, <xref:optional>
Obrigatório

Indica se é preciso mostrar o progresso do upload no console.

Retornos

A instância DataReference para o caminho de destino carregado.

Tipo de retorno