AzureBlobDatastore Classe

Representa um arquivo de dados que guarda informações de ligação ao armazenamento de Blobs do Azure.

Não deve trabalhar diretamente com esta classe. Para criar um arquivo de dados deste tipo, utilize o register_azure_blob_container método datastore.

Nota: ao utilizar um arquivo de dados para aceder aos dados, tem de ter permissão para aceder a esses dados, o que depende das credenciais registadas no arquivo de dados.

Inicialize um novo Arquivo de Dados de Blobs do Azure.

Herança
AzureBlobDatastore

Construtor

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)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho a que este arquivo de dados pertence.

name
str
Necessário

O nome do arquivo de dados. Só pode conter carateres alfanuméricos ou - ou _.

container_name
str
Necessário

O nome do contentor de blobs.

account_name
str
Necessário

O nome da conta de armazenamento.

sas_token
str, <xref:optional>
valor predefinido: None

O token de SAS para aceder a este contentor. Predefinições para Nenhum.

account_key
str, <xref:optional>
valor predefinido: None

A chave da conta de armazenamento. Predefinições para Nenhum.

protocol
str, <xref:optional>
valor predefinido: None

O protocolo a utilizar para ligar à conta de armazenamento. Se Nenhum, a predefinição é https.

endpoint
str, <xref:optional>
valor predefinido: None

O ponto final do contentor de blobs. Se Nenhum, a predefinição é core.windows.net.

request_session
<xref:requests.Session>, <xref:optional>
valor predefinido: None

o objeto de sessão a utilizar para pedidos http. Predefinições para Nenhum.

workspace
Workspace
Necessário

A área de trabalho a que este arquivo de dados pertence.

name
str
Necessário

O nome do arquivo de dados. Só pode conter carateres alfanuméricos ou - ou _.

container_name
str
Necessário

O nome do contentor de blobs.

account_name
str
Necessário

O nome da conta de armazenamento.

sas_token
str, <xref:optional>
Necessário

O token de SAS para aceder a este contentor. Predefinições para Nenhum.

account_key
str, <xref:optional>
Necessário

A chave da conta de armazenamento. Predefinições para Nenhum.

protocol
str, <xref:optional>
Necessário

O protocolo a utilizar para ligar à conta de armazenamento. Se Nenhum, a predefinição é https.

endpoint
str, <xref:optional>
Necessário

O ponto final do contentor de blobs. Se Nenhum, a predefinição é core.windows.net.

request_session
<xref:requests.Session>, <xref:optional>
Necessário

O objeto de sessão a utilizar para pedidos http. Predefinições para Nenhum.

workspace_msi_has_access
bool, <xref:optional>
valor predefinido: False

Se o MSI da Área de Trabalho tem acesso a esta conta de armazenamento. (Preterido)

subscription_id
str, <xref:optional>
valor predefinido: None

O ID da subscrição da conta de armazenamento.

resource_group
str, <xref:optional>
valor predefinido: None

O grupo de recursos da conta de armazenamento.

service_data_access_auth_identity
str ou <xref:_restclient.models.ServiceDataAccessAuthIdentity>
valor predefinido: None

Indica a identidade a utilizar para autenticar o acesso dos dados de serviço ao armazenamento do cliente. Os valores possíveis incluem: "None", "WorkspaceSystemAssignedIdentity", "WorkspaceUserAssignedIdentity"

Métodos

download

Transfira os dados do contentor de blobs para o sistema de ficheiros local.

upload

Carregue os dados do sistema de ficheiros local para o contentor de blobs para o qual este arquivo de dados aponta.

Nota: para que este método funcione, o objeto do arquivo de dados tem de ter a chave de conta ou a propriedade do token SAS preenchida. Se o objeto do arquivo de dados não contiver qualquer forma de credencial, este método falhará. Além disso, este método foi preterido, pode ser removido no futuro. Sugerimos que utilize o método para carregar os Dataset.File.upload_directory seus ficheiros a partir do diretório local e criar FileDataset numa única chamada de método.

upload_files

Carregue os dados do sistema de ficheiros local para o contentor de blobs para o qual este arquivo de dados aponta.

Nota: este método foi preterido e deixará de ser suportado. Em alternativa, recomendamos que utilize FileDatasetFactory.upload_directory .

download

Transfira os dados do contentor de blobs para o sistema de ficheiros local.

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

Parâmetros

target_path
str
Necessário

O diretório local para o quais transferir o ficheiro.

prefix
str, <xref:optional>
valor predefinido: None

O caminho para a pasta no contentor de blobs a transferir. Se estiver definido como Nenhum, transferirá tudo o que estiver no blob. Predefinições para Nenhum.

overwrite
bool, <xref:optional>
valor predefinido: False

Indica se deve substituir ficheiros existentes. Predefinições para Falso.

show_progress
bool, <xref:optional>
valor predefinido: True

Indica se pretende mostrar o progresso da transferência na consola do . Predefinições para Verdadeiro.

Devoluções

O número de ficheiros transferidos com êxito.

Tipo de retorno

int

upload

Carregue os dados do sistema de ficheiros local para o contentor de blobs para o qual este arquivo de dados aponta.

Nota: para que este método funcione, o objeto do arquivo de dados tem de ter a chave de conta ou a propriedade do token SAS preenchida. Se o objeto do arquivo de dados não contiver qualquer forma de credencial, este método falhará. Além disso, este método foi preterido, pode ser removido no futuro. Sugerimos que utilize o método para carregar os Dataset.File.upload_directory seus ficheiros a partir do diretório local e criar FileDataset numa única chamada de método.

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

Parâmetros

src_dir
str
Necessário

O diretório local a carregar.

target_path
str
Necessário

A localização no contentor de blobs para onde carregar. Se Não, carregue para a raiz. Predefinições para Nenhum.

overwrite
bool, <xref:optional>
Necessário

Indica se deve substituir ficheiros existentes. Predefinições para Falso.

show_progress
bool, <xref:optional>
Necessário

Indica se pretende mostrar o progresso do carregamento na consola. Predefinições para Verdadeiro.

Devoluções

A instância DataReference do caminho de destino carregado.

Tipo de retorno

upload_files

Carregue os dados do sistema de ficheiros local para o contentor de blobs para o qual este arquivo de dados aponta.

Nota: este método foi preterido e deixará de ser suportado. Em alternativa, recomendamos que utilize FileDatasetFactory.upload_directory .

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

Parâmetros

files
list[str]
Necessário

Uma lista de caminhos absolutos de ficheiros a carregar.

relative_root
str, <xref:optional>
Necessário

A raiz utilizada para determinar o caminho dos ficheiros no blob. Por exemplo, se carregarmos /path/to/file.txt e definirmos o caminho base para ser /path, quando file.txt for carregado para o armazenamento de blobs, terá o caminho de /para/file.txt. Se target_path também for dada, será utilizada como o prefixo do caminho derivado acima. O caminho base tem de ser um caminho comum de todos os ficheiros, caso contrário, será emitida uma exceção. A predefinição é Nenhuma, que encontrará o caminho comum.

target_path
str, <xref:optional>
Necessário

A localização no contentor de blobs para onde carregar os dados. A predefinição é Nenhuma, a raiz.

overwrite
bool, <xref:optional>
Necessário

Indica se deve substituir ficheiros existentes. Predefinições para Falso.

show_progress
bool, <xref:optional>
Necessário

Indica se pretende mostrar o progresso do carregamento na consola. Predefinições para Verdadeiro.

Devoluções

A instância DataReference do caminho de destino carregado.

Tipo de retorno