azure.storage.filedatalake.aio.DataLakeFileClient class

Solicita uma nova concessão. Se o arquivo ou diretório não tiver uma concessão ativa, o serviço DataLake criará uma concessão no arquivo/diretório e retornará uma nova ID de concessão.

async acquire_lease(lease_duration: int | None = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient

Parâmetros

lease_duration: int

Obrigatório

Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).

lease_id: str

Obrigatório

ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço DataLake retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Um objeto DataLakeLeaseClient, que pode ser executado em um gerenciador de contexto.

Tipo de retorno

DataLakeLeaseClient

Acrescente dados ao arquivo.

async append_data(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], offset: int, length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parâmetros

data

Obrigatório

Conteúdo a ser acrescentado ao arquivo

offset

Obrigatório

posição inicial dos dados a serem acrescentados.

length

Obrigatório

Tamanho dos dados em bytes.

flush: bool

Se for true, confirmará os dados depois que eles forem acrescentados.

validate_content: bool

Se for true, calculará um hash MD5 do conteúdo do bloco. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que esse hash MD5 não é armazenado com o arquivo .

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

Usado para executar operações de concessão junto com o acréscimo de dados.

"acquire" – adquirir uma concessão. "renovação automática" – reinsira uma concessão existente. "release" – libere a concessão depois que a operação for concluída. Requer flush=True. "acquire-release" – adquira uma concessão e libere-a depois que as operações forem concluídas. Requer flush=True.

lease_duration: int

Válido se lease_action estiver definido como "acquire" ou "acquire-release".

Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo tiver uma concessão ativa ou se lease_action estiver definido como "adquirir" ou "acquire-release". Se o arquivo tiver uma concessão existente, ele será usado para acessar o arquivo. Se adquirir uma nova concessão, ela será usada como a nova ID de concessão. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

cpk: CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS.

Retornos

dict do cabeçalho de resposta

Exemplos

Acrescente dados ao arquivo.


   await file_client.append_data(data=file_content[2048:3072], offset=2048, length=1024)

Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.

async close() -> None

Crie um arquivo.

async create_file(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parâmetros

content_settings: ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de caminho.

metadata: Optional[Dict[str, str]]

Obrigatório

Pares de nome-valor associados ao arquivo como metadados.

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

umask: str

Opcional e válido somente se o Namespace Hierárquico estiver habilitado para a conta. Ao criar um arquivo ou diretório e a pasta pai não tem uma ACL padrão, a umask restringe as permissões do arquivo ou diretório a serem criadas. A permissão resultante é fornecida por p & ^u, em que p é a permissão e você é a umask. Por exemplo, se p for 0777 e você for 0057, a permissão resultante será 0720. A permissão padrão é 0777 para um diretório e 0666 para um arquivo. A umask padrão é 0027. A umask deve ser especificada em notação octal de 4 dígitos (por exemplo, 0766).

owner: str

O proprietário do arquivo ou diretório.

group: str

O grupo proprietário do arquivo ou diretório.

acl: str

Define os direitos de controle de acesso POSIX em arquivos e diretórios. O valor é uma lista separada por vírgulas de entradas de controle de acesso. Cada ACE (entrada de controle de acesso) consiste em um escopo, um tipo, um identificador de usuário ou grupo e permissões no formato "[scope:][type]:[id]:[permissions]".

lease_id: str

ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço DataLake retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.

lease_duration: int

Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração.

expires_on: datetime ou int

O tempo para definir o arquivo como expirado. Se o tipo de expires_on for int, o tempo de expiração será definido como o número de milissegundos decorridos do tempo de criação. Se o tipo de expires_on for datetime, o tempo de validade será definido como absoluto à hora fornecida. Se nenhuma informação de fuso horário for fornecida, isso será interpretado como UTC.

permissions: str

Opcional e válido somente se o Namespace Hierárquico estiver habilitado para a conta. Define permissões de acesso POSIX para o proprietário do arquivo, o grupo proprietário do arquivo e outros. Cada classe pode receber permissão de leitura, gravação ou execução. Também há suporte para o bit sticky. Há suporte para notação octal simbólica (rwxrw-rw-) e octal de 4 dígitos (por exemplo, 0766).

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

encryption_context: str

Especifica o contexto de criptografia a ser definido no arquivo.

Retornos

dic de resposta (Etag e última modificação).

Exemplos

Criar arquivo.


   file_client = filesystem_client.get_file_client(file_name)
   await file_client.create_file()

Marca o arquivo especificado para exclusão.

async delete_file(**kwargs) -> None

Parâmetros

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Nenhum

Exemplos

Excluir arquivo.


   await new_client.delete_file()

Baixa um arquivo para o StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou o readinto() deve ser usado para baixar o arquivo em um fluxo. O uso de chunks() retorna um iterador assíncrono que permite que o usuário itere sobre o conteúdo em partes.

async download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Parâmetros

offset: int

Obrigatório

Início do intervalo de bytes a ser usado para baixar uma seção do arquivo. Deve ser definido se o comprimento for fornecido.

length: int

Obrigatório

Número de bytes a serem lidos do fluxo. Isso é opcional, mas deve ser fornecido para o desempenho ideal.

lease: DataLakeLeaseClient ou str

Se especificado, o download só terá êxito se a concessão do arquivo estiver ativa e corresponder a essa ID. Obrigatório se o arquivo tiver uma concessão ativa.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Obrigatório se o arquivo foi criado com uma chave de Customer-Provided.

max_concurrency: int

O número de conexões paralelas com as quais baixar.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui. Esse método pode fazer várias chamadas para o serviço e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um objeto de streaming (StorageStreamDownloader)

Tipo de retorno

StorageStreamDownloader

Exemplos

Retornar os dados baixados.


   download = await file_client.download_file()
   downloaded_bytes = await download.readall()

Retorna True se houver um arquivo e retornar False caso contrário.

async exists(**kwargs: Any) -> bool

Parâmetros

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

True se houver um arquivo, false caso contrário.

Tipo de retorno

bool

Confirme os dados acrescentados anteriormente.

async flush_data(offset: int, retain_uncommitted_data: bool | None = False, **kwargs) -> Dict[str, str | datetime]

Parâmetros

offset

Obrigatório

offset é igual ao comprimento do arquivo após confirmar os dados acrescentados anteriormente.

retain_uncommitted_data: bool

Obrigatório

Válido somente para operações de liberação. Se "true", os dados não confirmados serão retidos após a conclusão da operação de liberação; caso contrário, os dados não confirmados serão excluídos após a operação de liberação. O padrão é false. Os dados em deslocamentos menores que a posição especificada são gravados no arquivo quando a liberação é bem-sucedida, mas esse parâmetro opcional permite que os dados após a posição de liberação sejam retidos para uma operação de liberação futura.

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

close: bool

Os Eventos de Armazenamento do Azure permitem que os aplicativos recebam notificações quando os arquivos são alterados. Quando os Eventos de Armazenamento do Azure estão habilitados, um evento de alteração de arquivo é gerado. Esse evento tem uma propriedade que indica se essa é a alteração final para distinguir a diferença entre uma liberação intermediária para um fluxo de arquivos e o fechamento final de um fluxo de arquivos. O parâmetro close query é válido somente quando a ação é "flush" e as notificações de alteração são habilitadas. Se o valor de close for "true" e a operação de liberação for concluída com êxito, o serviço gerará uma notificação de alteração de arquivo com uma propriedade indicando que essa é a atualização final (o fluxo de arquivos foi fechado). Se "false" uma notificação de alteração for gerada indicando que o arquivo foi alterado. O padrão é false. Esse parâmetro de consulta é definido como true pelo driver ABFS do Hadoop para indicar que o fluxo de arquivos foi fechado."

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

Usado para executar operações de concessão junto com a anexação de dados.

"acquire" - Adquirir uma concessão. "renovação automática" – reinsira uma concessão existente. "release" – libere a concessão depois que a operação for concluída. "acquire-release" – adquira uma concessão e libere-a assim que as operações forem concluídas.

lease_duration: int

Válido se lease_action estiver definido como "acquire" ou "acquire-release".

Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo tiver uma concessão ativa ou se lease_action estiver definido como "acquire" ou "acquire-release". Se o arquivo tiver uma concessão existente, isso será usado para acessar o arquivo. Se adquirir uma nova concessão, isso será usado como a nova ID de concessão. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

cpk: CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS.

Retornos

cabeçalho de resposta em dict

Exemplos

Confirme os dados acrescentados anteriormente.


   file_client = file_system_client.get_file_client("myfile")
   await file_client.create_file()
   with open(SOURCE_FILE, "rb") as data:
       length = data.tell()
       await file_client.append_data(data, 0)
       await file_client.flush_data(length)

Crie DataLakeFileClient a partir de uma cadeia de conexão.

:return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient

from_connection_string(conn_str: str, file_system_name: str, file_path: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parâmetros

conn_str: str

Obrigatório

Uma cadeia de conexão com uma conta de Armazenamento do Azure.

file_system_name: str

Obrigatório

O nome do sistema de arquivos com o qual interagir.

file_path: str

Obrigatório

O caminho do arquivo inteiro, de modo que interaja com um arquivo específico. ex. "{directory}/{subdirectory}/{file}"

credential

valor padrão: None

As credenciais com as quais autenticar. Isso é opcional se a URL da conta já tiver um token SAS ou a cadeia de conexão já tiver valores de chave de acesso compartilhado. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. As credenciais fornecidas aqui terão precedência sobre aquelas na cadeia de conexão. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.

Obtenha o proprietário, o grupo, as permissões ou a lista de controle de acesso para um caminho.

async get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Parâmetros

upn: bool

Obrigatório

Opcional. Válido somente quando o Namespace Hierárquico está habilitado para a conta. Se "true", os valores de identidade do usuário retornados nos cabeçalhos de resposta x-ms-owner, x-ms-group e x-ms-acl serão transformados de IDs de objeto do Azure Active Directory para Nomes de Entidade de Usuário. Se "false", os valores serão retornados como IDs de Objeto do Azure Active Directory. O valor padrão é false. Observe que as IDs de objeto de grupo e aplicativo não são convertidas porque não têm nomes amigáveis exclusivos.

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

response dict

dic de resposta.

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ela não retorna o conteúdo do arquivo.

async get_file_properties(**kwargs: Any) -> FileProperties

Parâmetros

lease: DataLakeLeaseClient ou str

Obrigatório se o diretório ou arquivo tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Obrigatório se o arquivo foi criado com uma chave fornecida pelo cliente.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Tipo de retorno

FileProperties

Exemplos

Obtendo as propriedades de um arquivo.


   properties = await file_client.get_file_properties()

Permite aos usuários selecionar/projetar dados de arquivo datalake fornecendo expressões de consulta simples. Essas operações retornam um DataLakeFileQueryReader, os usuários precisam usar readall() ou readinto() para obter dados de consulta.

query_file(query_expression: str, **kwargs: Any) -> DataLakeFileQueryReader

Parâmetros

query_expression: str

Obrigatório

Obrigatórios. uma instrução de consulta. ex. Selecione * de DataLakeStorage

on_error: Callable[DataLakeFileQueryError]

Uma função a ser chamada em quaisquer erros de processamento retornados pelo serviço.

file_format: DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

Opcional. Define a serialização dos dados armazenados atualmente no arquivo. O padrão é tratar os dados do arquivo como dados CSV formatados no dialeto padrão. Isso pode ser substituído por um DelimitedTextDialect personalizado ou DelimitedJsonDialect ou "ParquetDialect" (passado como uma cadeia de caracteres ou enumeração). Esses dialetos podem ser passados por suas respectivas classes, a enumeração QuickQueryDialect ou como uma cadeia de caracteres.

output_format: DelimitedTextDialect ou DelimitedJsonDialect ou list[ArrowDialect] ou QuickQueryDialect ou str

Opcional. Define a serialização de saída para o fluxo de dados. Por padrão, os dados serão retornados à medida que forem representados no arquivo. Ao fornecer um formato de saída, os dados do arquivo serão reformatados de acordo com esse perfil. Esse valor pode ser um DelimitedTextDialect ou um DelimitedJsonDialect ou ArrowDialect. Esses dialetos podem ser passados por suas respectivas classes, a enumeração QuickQueryDialect ou como uma cadeia de caracteres.

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Necessário se o arquivo foi criado com uma chave Customer-Provided.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Um objeto de streaming (DataLakeFileQueryReader)

Tipo de retorno

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Exemplos

selecione/projeto em dados de arquivo datalake fornecendo expressões de consulta simples.


   errors = []
   def on_error(error):
       errors.append(error)

   # upload the csv file
   file_client = datalake_service_client.get_file_client(filesystem_name, "csvfile")
   file_client.upload_data(CSV_DATA, overwrite=True)

   # select the second column of the csv file
   query_expression = "SELECT _2 from DataLakeStorage"
   input_format = DelimitedTextDialect(delimiter=',', quotechar='"', lineterminator='\n', escapechar="", has_header=False)
   output_format = DelimitedJsonDialect(delimiter='\n')
   reader = file_client.query_file(query_expression, on_error=on_error, file_format=input_format, output_format=output_format)
   content = reader.readall()

Remove o Controle de Acesso em um caminho e subcaminhos.

async remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parâmetros

acl: str

Obrigatório

Remove os direitos de controle de acesso POSIX em arquivos e diretórios. O valor é uma lista separada por vírgulas de entradas de controle de acesso. Cada ACE (entrada de controle de acesso) consiste em um escopo, um tipo e um identificador de usuário ou grupo no formato "[scope:][type]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Retorno de chamada em que o chamador pode acompanhar o progresso da operação, bem como coletar caminhos que não foram alterados Controle de Acesso.

continuation_token: str

Token de continuação opcional que pode ser usado para retomar a operação interrompida anteriormente.

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em várias solicitações para que o progresso possa ser acompanhado. O tamanho do lote deve estar entre 1 e 2000. O padrão quando não especificado é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que uma única alteração Controle de Acesso operação pode executar. Se o máximo for atingido antes que todos os subcaminhos sejam processados, o token de continuação poderá ser usado para retomar a operação. O valor vazio indica que o número máximo de lotes em não associados e a operação continua até o fim.

continue_on_failure: bool

Se definido como False, a operação terminará rapidamente ao encontrar erros de usuário (4XX). Se True, a operação ignorará os erros do usuário e prosseguirá com a operação em outras subentidades do diretório. O token de continuação só será retornado quando continue_on_failure for True em caso de erros do usuário. Se não for definido, o valor padrão será False para isso.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Um resumo das operações recursivas, incluindo a contagem de êxitos e falhas, bem como um token de continuação caso a operação tenha sido encerrada prematuramente.

Tipo de retorno

:~AccessControlChangeResult`

Exceções

AzureError

O usuário poderá reiniciar a operação usando continuation_token campo do AzureError se o token estiver disponível.

Renomeie o arquivo de origem.

async rename_file(new_name: str, **kwargs: Any) -> DataLakeFileClient

Parâmetros

new_name: str

Obrigatório

o novo nome de arquivo para o qual o usuário deseja renomear. O valor deve ter o seguinte formato: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

source_lease: DataLakeLeaseClient ou str

Uma ID de concessão para o caminho de origem. Se especificado, o caminho de origem deve ter uma concessão ativa e a ID de concessão deve corresponder.

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

source_if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

source_if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor de ETag de origem ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

source_match_condition: MatchConditions

A condição de correspondência de origem a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

o cliente de arquivo renomeado

Tipo de retorno

DataLakeFileClient

Exemplos

Renomeie o arquivo de origem.


   new_client = await file_client.rename_file(file_client.file_system_name + '/' + 'newname')

Defina a lista de proprietários, grupos, permissões ou controle de acesso para um caminho.

async set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Parâmetros

owner: str

Obrigatório

Opcional. O proprietário do arquivo ou diretório.

group: str

Obrigatório

Opcional. O grupo proprietário do arquivo ou diretório.

permissions: str

Obrigatório

Opcional e válido somente se o Namespace Hierárquico estiver habilitado para a conta. Define permissões de acesso POSIX para o proprietário do arquivo, o grupo proprietário do arquivo e outros. Cada classe pode receber permissão de leitura, gravação ou execução. Também há suporte para o bit sticky. Há suporte para notação octal simbólica (rwxrw-rw-) e octal de 4 dígitos (por exemplo, 0766). permissões e acl são mutuamente exclusivas.

acl: str

Obrigatório

Define os direitos de controle de acesso POSIX em arquivos e diretórios. O valor é uma lista separada por vírgulas de entradas de controle de acesso. Cada ACE (entrada de controle de acesso) consiste em um escopo, um tipo, um identificador de usuário ou grupo e permissões no formato "[scope:][type]:[id]:[permissions]". permissões e acl são mutuamente exclusivas.

lease: DataLakeLeaseClient ou str

Obrigatório se o arquivo/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

response dict

dic de resposta (Etag e última modificação).

Define o Controle de Acesso em um caminho e sub-caminhos.

async set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parâmetros

acl: str

Obrigatório

Define os direitos de controle de acesso POSIX em arquivos e diretórios. O valor é uma lista separada por vírgulas de entradas de controle de acesso. Cada ACE (entrada de controle de acesso) consiste em um escopo, um tipo, um identificador de usuário ou grupo e permissões no formato "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Retorno de chamada em que o chamador pode acompanhar o progresso da operação, bem como coletar caminhos que não foram alterados Controle de Acesso.

continuation_token: str

Token de continuação opcional que pode ser usado para retomar a operação interrompida anteriormente.

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em várias solicitações para que o progresso possa ser acompanhado. O tamanho do lote deve estar entre 1 e 2000. O padrão quando não especificado é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que uma única alteração Controle de Acesso operação pode ser executada. Se o máximo for atingido antes que todos os sub-caminhos sejam processados, o token de continuação poderá ser usado para retomar a operação. O valor vazio indica que o número máximo de lotes em não associados e a operação continua até o fim.

continue_on_failure: bool

Se definida como False, a operação será encerrada rapidamente ao encontrar erros de usuário (4XX). Se True, a operação ignorará os erros do usuário e prosseguirá com a operação em outras sub-entidades do diretório. O token de continuação só será retornado quando continue_on_failure for True em caso de erros do usuário. Se não definir o valor padrão, será False para isso.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Um resumo das operações recursivas, incluindo a contagem de êxitos e falhas, bem como um token de continuação caso a operação tenha sido encerrada prematuramente.

Tipo de retorno

:~AccessControlChangeResult`

Exceções

AzureError

O usuário poderá reiniciar a operação usando continuation_token campo do AzureError se o token estiver disponível.

Define a hora em que um arquivo expirará e será excluído.

async set_file_expiry(expiry_options: str, expires_on: datetime | int | None = None, **kwargs) -> None

Parâmetros

expiry_options: str

Obrigatório

Obrigatórios. Indica o modo da hora de expiração. Os valores possíveis incluem: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'

expires_on: datetime ou int

Obrigatório

O tempo para definir o arquivo como expirado. Quando expiry_options é RelativeTo*, expires_on deve ser um int em milissegundos

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Tipo de retorno

None

Define as propriedades do sistema no arquivo ou diretório.

Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.

async set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]

Parâmetros

content_settings: ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de arquivo/diretório.

lease: DataLakeLeaseClient ou str

Se especificado, set_file_system_metadata só terá êxito se a concessão do sistema de arquivos estiver ativa e corresponder a essa ID.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

dict de propriedade atualizado por arquivo/diretório (Etag e última modificação)

Tipo de retorno

Dict[str, Any]

Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado. Cada chamada a essa operação substitui todos os metadados existentes anexados ao sistema de arquivos. Para remover todos os metadados do sistema de arquivos, chame essa operação sem um ditado de metadados.

async set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Parâmetros

metadata: dict[str, str]

Obrigatório

Um ditado que contém pares nome-valor a serem associados ao sistema de arquivos como metadados. Exemplo: {'category':'test'}

lease: DataLakeLeaseClient ou str

Se especificado, set_file_system_metadata só terá êxito se a concessão do sistema de arquivos estiver ativa e corresponder a essa ID.

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

dict de propriedade atualizado pelo sistema de arquivos (Etag e última modificação).

Modifica o Controle de Acesso em um caminho e sub-caminhos.

async update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parâmetros

acl: str

Obrigatório

Modifica os direitos de controle de acesso POSIX em arquivos e diretórios. O valor é uma lista separada por vírgulas de entradas de controle de acesso. Cada ACE (entrada de controle de acesso) consiste em um escopo, um tipo, um identificador de usuário ou grupo e permissões no formato "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Retorno de chamada em que o chamador pode acompanhar o progresso da operação, bem como coletar caminhos que não foram alterados Controle de Acesso.

continuation_token: str

Token de continuação opcional que pode ser usado para retomar a operação interrompida anteriormente.

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em várias solicitações para que o progresso possa ser acompanhado. O tamanho do lote deve estar entre 1 e 2000. O padrão quando não especificado é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que uma única operação de alteração Controle de Acesso pode ser executada. Se o máximo for atingido antes que todos os sub-caminhos sejam processados, o token de continuação poderá ser usado para retomar a operação. O valor vazio indica que o número máximo de lotes em não associados e a operação continua até o fim.

continue_on_failure: bool

Se definida como False, a operação será encerrada rapidamente ao encontrar erros de usuário (4XX). Se True, a operação ignorará os erros do usuário e prosseguirá com a operação em outras sub-entidades do diretório. O token de continuação só será retornado quando continue_on_failure for True em caso de erros do usuário. Se não definir o valor padrão, será False para isso.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Um resumo das operações recursivas, incluindo a contagem de êxitos e falhas, bem como um token de continuação caso a operação tenha sido encerrada prematuramente.

Tipo de retorno

:~AccessControlChangeResult`

Exceções

AzureError

O usuário poderá reiniciar a operação usando continuation_token campo do AzureError se o token estiver disponível.

Carregar dados em um arquivo.

async upload_data(data: bytes | str | Iterable | AsyncIterable | IO, length: int | None = None, overwrite: bool | None = False, **kwargs) -> Dict[str, Any]

Parâmetros

data

Obrigatório

Conteúdo a ser carregado no arquivo

length: int

Obrigatório

Tamanho dos dados em bytes.

overwrite: bool

Obrigatório

para substituir um arquivo existente ou não.

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

metadata: Optional[Dict[str, str]]

Pares de nome-valor associados ao blob como metadados.

lease: DataLakeLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou a ID de concessão como uma cadeia de caracteres.

umask: str

Opcional e válido somente se o Namespace Hierárquico estiver habilitado para a conta. Ao criar um arquivo ou diretório e a pasta pai não tem uma ACL padrão, a umask restringe as permissões do arquivo ou diretório a ser criado. A permissão resultante é fornecida por p & ^u, em que p é a permissão e você é a umask. Por exemplo, se p for 0777 e você for 0057, a permissão resultante será 0720. A permissão padrão é 0777 para um diretório e 0666 para um arquivo. A umask padrão é 0027. A umask deve ser especificada em notação octal de 4 dígitos (por exemplo, 0766).

permissions: str

Opcional e válido somente se o Namespace Hierárquico estiver habilitado para a conta. Define permissões de acesso POSIX para o proprietário do arquivo, o grupo proprietário do arquivo e outros. Cada classe pode receber permissão de leitura, gravação ou execução. Também há suporte para o bit sticky. Há suporte para notação octal simbólica (rwxrw-rw-) e octal de 4 dígitos (por exemplo, 0766).

if_modified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since: datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

validate_content: bool

Se for true, calculará um hash MD5 para cada parte do arquivo. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips no fio se o uso de http em vez de https, como https (o padrão), já validará. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de carregamento com eficiência de memória não será usado porque a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.

etag: str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition: MatchConditions

A condição de correspondência a ser usada na etag.

cpk: CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui. Esse método pode fazer várias chamadas para o serviço e o tempo limite será aplicado a cada chamada individualmente.

chunk_size: int

O tamanho máximo da parte para carregar um arquivo em partes. O padrão é 100*1024*1024 ou 100 MB.

encryption_context: str

Especifica o contexto de criptografia a ser definido no arquivo.

Retornos

dict response (Etag e última modificação).

A versão da API de Armazenamento usada para solicitações.

O modo de localização que o cliente está usando no momento.

Por padrão, isso será "primário". As opções incluem "primário" e "secundário".

A URL completa do ponto de extremidade primário.

O nome do host do ponto de extremidade primário.

A URL completa do ponto de extremidade secundário, se configurada.

Se não estiver disponível, um ValueError será gerado. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.

Exceções

ValueError

O nome do host do ponto de extremidade secundário.

Se não estiver disponível, será Nenhum. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.

A URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado.

Isso pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do atual location_mode. :returns: a URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado. :rtype: str

acquire_lease	Solicita uma nova concessão. Se o arquivo ou diretório não tiver uma concessão ativa, o serviço DataLake criará uma concessão no arquivo/diretório e retornará uma nova ID de concessão.
append_data	Acrescente dados ao arquivo.
close	Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
create_file	Crie um arquivo.
delete_file	Marca o arquivo especificado para exclusão.
download_file	Baixa um arquivo para o StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou o readinto() deve ser usado para baixar o arquivo em um fluxo. O uso de chunks() retorna um iterador assíncrono que permite que o usuário itere sobre o conteúdo em partes.
exists	Retorna True se houver um arquivo e retornar False caso contrário.
flush_data	Confirme os dados acrescentados anteriormente.
from_connection_string	Crie DataLakeFileClient a partir de uma cadeia de conexão. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control	Obtenha o proprietário, o grupo, as permissões ou a lista de controle de acesso para um caminho.
get_file_properties	Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ela não retorna o conteúdo do arquivo.
query_file	Permite aos usuários selecionar/projetar dados de arquivo datalake fornecendo expressões de consulta simples. Essas operações retornam um DataLakeFileQueryReader, os usuários precisam usar readall() ou readinto() para obter dados de consulta.
remove_access_control_recursive	Remove o Controle de Acesso em um caminho e subcaminhos.
rename_file	Renomeie o arquivo de origem.
set_access_control	Defina a lista de proprietários, grupos, permissões ou controle de acesso para um caminho.
set_access_control_recursive	Define o Controle de Acesso em um caminho e sub-caminhos.
set_file_expiry	Define a hora em que um arquivo expirará e será excluído.
set_http_headers	Define as propriedades do sistema no arquivo ou diretório. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.
set_metadata	Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado. Cada chamada a essa operação substitui todos os metadados existentes anexados ao sistema de arquivos. Para remover todos os metadados do sistema de arquivos, chame essa operação sem um ditado de metadados.
update_access_control_recursive	Modifica o Controle de Acesso em um caminho e sub-caminhos.
upload_data	Carregar dados em um arquivo.

Compartilhar via

DataLakeFileClient Classe

Construtor

Parâmetros

Exemplos

Variáveis

Métodos

acquire_lease

Parâmetros

Retornos

Tipo de retorno

append_data

Parâmetros

Retornos

Exemplos

close

create_file

Parâmetros

Retornos

Exemplos

delete_file

Parâmetros

Retornos

Exemplos

download_file

Parâmetros

Retornos

Tipo de retorno

Exemplos

exists

Parâmetros

Retornos

Tipo de retorno

flush_data

Parâmetros

Retornos

Exemplos

from_connection_string

Parâmetros

get_access_control

Parâmetros

get_file_properties

Parâmetros

Tipo de retorno

Exemplos

query_file

Parâmetros

Retornos

Tipo de retorno

Exemplos

remove_access_control_recursive

Parâmetros

Retornos

Tipo de retorno

Exceções

rename_file

Parâmetros

Retornos

Tipo de retorno

Exemplos

set_access_control

Parâmetros

set_access_control_recursive

Parâmetros

Retornos

Tipo de retorno

Exceções

set_file_expiry

Parâmetros

Tipo de retorno

set_http_headers

Parâmetros

Retornos

Tipo de retorno

set_metadata

Parâmetros

Retornos

update_access_control_recursive

Parâmetros

Retornos