azure.storage.filedatalake.DataLakeFileClient class

Pede uma nova concessão. Se o ficheiro ou diretório não tiver uma concessão ativa, o serviço DataLake cria uma concessão no ficheiro/diretório e devolve um novo ID de concessão.

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

Parâmetros

lease_duration: int

Necessário

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ser entre 15 e 60 segundos. Não é possível alterar a duração da concessão através da renovação ou alteração. A predefinição é -1 (concessão infinita).

lease_id: str

Necessário

ID de concessão proposto, num formato de cadeia GUID. O serviço DataLake devolve 400 (Pedido inválido) se o ID de concessão proposto não estiver no formato correto.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

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

Devoluções

Um objeto DataLakeLeaseClient, que pode ser executado num gestor de contexto.

Tipo de retorno

DataLakeLeaseClient

Anexe dados ao ficheiro.

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

Parâmetros

data

Necessário

Conteúdo a acrescentar ao ficheiro

offset

Necessário

posição inicial dos dados a acrescentar.

length

Necessário

Tamanho dos dados em bytes.

flush: bool

Se for verdadeiro, consolidará os dados depois de anexados.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 do conteúdo do bloco. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https como https (a predefinição) já for validada. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro.

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

Utilizado para realizar operações de concessão juntamente com dados pendentes.

"adquirir" – adquirir uma concessão. "renovação automática" – volte a criar uma concessão existente. "release" - Liberte a concessão assim que a operação estiver concluída. Requer flush=True. "acquire-release" – adquira uma concessão e solte-a assim que as operações estiverem concluídas. Requer flush=True.

lease_duration: int

Válido se lease_action estiver definido como "adquirir" ou "adquirir versão".

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ser entre 15 e 60 segundos. Não é possível alterar a duração da concessão através da renovação ou alteração. A predefinição é -1 (concessão infinita).

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro tiver uma concessão ativa ou se lease_action estiver definido como "adquirir" ou "adquirir versão". Se o ficheiro tiver uma concessão existente, será utilizado para aceder ao ficheiro. Se adquirir uma nova concessão, esta será utilizada como o novo ID de concessão. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS.

Devoluções

dict do cabeçalho de resposta

Exemplos

Anexe dados ao ficheiro.


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

Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.

close() -> None

Criar um novo ficheiro.

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

Parâmetros

content_settings: ContentSettings

Necessário

Objeto ContentSettings utilizado para definir propriedades do caminho.

metadata: Optional[Dict[str, str]]

Necessário

Pares nome-valor associados ao ficheiro como metadados.

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

umask: str

Opcional e válido apenas se o Espaço de Nomes Hierárquico estiver ativado para a conta. Ao criar um ficheiro ou diretório e a pasta principal não tiver uma ACL predefinida, a umask restringe as permissões do ficheiro ou diretório a criar. A permissão resultante é dada por p & ^u, em que p é a permissão e o utilizador é a umask. Por exemplo, se p for 0777 e for 0057, a permissão resultante será 0720. A permissão predefinida é 0777 para um diretório e 0666 para um ficheiro. A umask predefinida é 0027. A umask tem de ser especificada em notação octal de 4 dígitos (por exemplo, 0766).

owner: str

O proprietário do ficheiro ou diretório.

group: str

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

acl: str

Define direitos de controlo de acesso POSIX em ficheiros e diretórios. O valor é uma lista separada por vírgulas de entradas de controlo de acesso. Cada entrada de controlo de acesso (ACE) consiste num âmbito, um tipo, um identificador de utilizador ou grupo e permissões no formato "[scope:][type]:[id]:[permissions]".

lease_id: str

ID de concessão proposto, num formato de cadeia GUID. O serviço DataLake devolve 400 (Pedido inválido) se o ID de concessão proposto não estiver no formato correto.

lease_duration: int

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ser entre 15 e 60 segundos. Não é possível alterar a duração da concessão através da renovação ou alteração.

expires_on: datetime ou int

A hora de definir o ficheiro para expirar. Se o tipo de expires_on for um int, o tempo de expiração será definido como o número de milissegundos decorridos da hora de criação. Se o tipo de expires_on for datetime, a hora de expiração será definida como absoluta para a hora fornecida. Se não forem fornecidas informações de fuso horário, isto será interpretado como UTC.

permissions: str

Opcional e válido apenas se o Espaço de Nomes Hierárquico estiver ativado para a conta. Define permissões de acesso POSIX para o proprietário do ficheiro, o grupo proprietário do ficheiro e outros. Pode ser concedida permissão de leitura, escrita ou execução a cada classe. O sticky bit também é suportado. Tanto a notação octal simbólica (rwxrw-rw-) como a notação octal de 4 dígitos (por exemplo, 0766) são suportadas.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS.

timeout: int

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

encryption_context: str

Especifica o contexto de encriptação a definir no ficheiro.

Devoluções

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

Exemplos

Criar ficheiro.


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

Marca o ficheiro especificado para eliminação.

delete_file(**kwargs) -> None

Parâmetros

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

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

Devoluções

Nenhuma

Exemplos

Eliminar ficheiro.


   new_client.delete_file()

Transfere um ficheiro para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou o método readinto() tem de ser utilizado para transferir o ficheiro para um fluxo. A utilização de segmentos() devolve um iterador que permite ao utilizador iterar sobre o conteúdo em segmentos.

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

Parâmetros

offset: int

Necessário

Início do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Tem de ser definido se o comprimento for fornecido.

length: int

Necessário

Número de bytes a ler a partir da transmissão em fluxo. Isto é opcional, mas deve ser fornecido para um desempenho ideal.

lease: DataLakeLeaseClient ou str

Se especificado, a transferência só será efetuada com êxito se a concessão do ficheiro estiver ativa e corresponder a este ID. Necessário se o ficheiro tiver uma concessão ativa.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Desencripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Necessário se o ficheiro tiver sido criado com uma Chave de Customer-Provided.

max_concurrency: int

O número de ligações paralelas com as quais transferir.

timeout: int

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

Devoluções

Um objeto de transmissão em fluxo (StorageStreamDownloader)

Tipo de retorno

StorageStreamDownloader

Exemplos

Devolver os dados transferidos.


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

Devolve Verdadeiro se existir um ficheiro e devolve Falso de outra forma.

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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Verdadeiro se existir um ficheiro, caso contrário, devolve Falso.

Tipo de retorno

bool

Consolidar os dados anexados anteriores.

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

Parâmetros

offset

Necessário

o desvio é igual ao comprimento do ficheiro depois de consolidar os dados anexados anteriores.

retain_uncommitted_data: bool

Necessário

Válido apenas para operações de descarga. Se "verdadeiro", os dados não comprometidos são retidos após a conclusão da operação de remoção; caso contrário, os dados não comprometidos são eliminados após a operação de remoção. A predefinição é falsa. Os dados em deslocamentos inferiores à posição especificada são escritos no ficheiro quando a descarga for bem-sucedida, mas este parâmetro opcional permite que os dados após a posição de remoção sejam retidos para uma operação de remoção futura.

content_settings: ContentSettings

Objeto ContentSettings utilizado para definir propriedades de caminho.

close: bool

Os Eventos de Armazenamento do Azure permitem que as aplicações recebam notificações quando os ficheiros são alterados. Quando os Eventos de Armazenamento do Azure estão ativados, é gerado um evento alterado de ficheiro. Este evento tem uma propriedade que indica se esta é a alteração final para distinguir a diferença entre uma descarga intermédia para um fluxo de ficheiros e o fecho final de um fluxo de ficheiros. O parâmetro fechar consulta só é válido quando a ação é "flush" e as notificações de alteração estão ativadas. Se o valor de fechar for "verdadeiro" e a operação de remoção for concluída com êxito, o serviço emitirá uma notificação de alteração de ficheiro com uma propriedade que indica que esta é a atualização final (o fluxo de ficheiros foi fechado). Se "falso" for levantada uma notificação de alteração que indique que o ficheiro foi alterado. A predefinição é falsa. Este parâmetro de consulta está definido como verdadeiro pelo controlador do Hadoop ABFS para indicar que o fluxo de ficheiros foi fechado."

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

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

Utilizado para efetuar operações de concessão juntamente com dados pendentes.

"acquire" - Adquirir uma concessão. "renovação automática" – volte a criar uma concessão existente. "release" - Liberte a concessão assim que a operação estiver concluída. "acquire-release" – adquira uma concessão e solte-a assim que as operações estiverem concluídas.

lease_duration: int

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

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ter entre 15 e 60 segundos. Não é possível alterar a duração da concessão com renovação ou alteração. A predefinição é -1 (concessão infinita).

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro tiver uma concessão ativa ou se lease_action estiver definido como "adquirir" ou "adquirir-lançamento". Se o ficheiro tiver uma concessão existente, será utilizado para aceder ao ficheiro. Se adquirir uma nova concessão, esta será utilizada como o novo ID de concessão. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

cpk: CustomerProvidedEncryptionKey

Encripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS.

Devoluções

cabeçalho de resposta no ditado

Exemplos

Consolidar os dados anexados anteriores.


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

Crie DataLakeFileClient a partir de uma Cadeia de Ligaçã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

Necessário

Uma cadeia de ligação a uma conta de Armazenamento do Azure.

file_system_name: str

Necessário

O nome do sistema de ficheiros com o qual interagir.

file_path: str

Necessário

Todo o caminho do ficheiro, de modo a interagir com um ficheiro específico. Por exemplo, "{directory}/{subdiretório}/{file}"

credential

valor predefinido: None

As credenciais com as quais se autenticar. Isto é opcional se o URL da conta já tiver um token de SAS ou se a cadeia de ligação já tiver valores de chave de acesso partilhados. O valor pode ser uma cadeia de token de SAS, uma instância de uma AzureSasCredential ou AzureNamedKeyCredential a partir de azure.core.credentials, uma chave de acesso partilhada de conta ou uma instância de uma classe TokenCredentials a partir de azure.identity. As credenciais aqui fornecidas terão precedência sobre as da cadeia de ligação. Se utilizar uma instância do AzureNamedKeyCredential, "name" deve ser o nome da conta de armazenamento e "chave" deve ser a chave da conta de armazenamento.

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

Parâmetros

upn: bool

Necessário

Opcional. Válido apenas quando o Espaço de Nomes Hierárquico está ativado para a conta. Se "verdadeiro", os valores de identidade de utilizador devolvidos nos cabeçalhos de resposta x-ms-owner, x-ms-group e x-ms-acl serão transformados dos IDs de Objeto do Azure Active Directory para Nomes Principais de Utilizador. Se for "falso", os valores serão devolvidos como IDs de Objeto do Azure Active Directory. O valor predefinido é false. Tenha em atenção que os IDs de objeto de grupo e de aplicação não são traduzidos porque não têm nomes amigáveis exclusivos.

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

response dict

dict de resposta.

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Não devolve o conteúdo do ficheiro.

get_file_properties(**kwargs: Any) -> FileProperties

Parâmetros

lease

Necessário se o diretório ou ficheiro tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Desencripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Necessário se o ficheiro tiver sido 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro.

Tipo de retorno

FileProperties

Exemplos

Obter as propriedades de um ficheiro.


   properties = file_client.get_file_properties()

Permite que os utilizadores selecionem/projectem dados de ficheiros datalake ao fornecer expressões de consulta simples. Estas operações devolvem um DataLakeFileQueryReader, os utilizadores têm de utilizar readall() ou readinto() para obter dados de consulta.

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

Parâmetros

query_expression: str

Necessário

Obrigatório. uma instrução de consulta. Por exemplo, Selecione * em DataLakeStorage

on_error: Callable[DataLakeFileQueryError]

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

file_format: DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

Opcional. Define a serialização dos dados atualmente armazenados no ficheiro. A predefinição é tratar os dados de ficheiros como dados CSV formatados no dialeto predefinido. Isto pode ser substituído por um DelimitadoTextDialect personalizado ou DelimitedJsonDialect ou "ParquetDialect" (transmitido como uma cadeia ou enum). Estes dialetos podem ser transmitidos através das respetivas classes, da enum quickQueryDialect ou como uma cadeia.

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 predefinição, os dados serão devolvidos tal como estão representados no ficheiro. Ao fornecer um formato de saída, os dados do ficheiro serão reformatados de acordo com esse perfil. Este valor pode ser delimitadoTextDialect ou DelimitedJsonDialect ou ArrowDialect. Estes dialetos podem ser transmitidos através das respetivas classes, da enum quickQueryDialect ou como uma cadeia.

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Desencripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Necessário se o ficheiro tiver sido criado com uma Chave de Customer-Provided.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Um objeto de transmissão em fluxo (DataLakeFileQueryReader)

Tipo de retorno

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Exemplos

selecione/projecte em dados de ficheiros datalake ao fornecer 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 Controlo de Acesso num caminho e sub-caminhos.

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

Parâmetros

acl: str

Necessário

Remove os direitos de controlo de acesso POSIX em ficheiros e diretórios. O valor é uma lista separada por vírgulas de entradas de controlo de acesso. Cada entrada de controlo de acesso (ACE) é constituída por um âmbito, um tipo e um identificador de utilizador ou grupo no formato "[âmbito:][tipo]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Chamada de retorno onde o autor da chamada pode controlar o progresso da operação, bem como recolher caminhos que não foram alterados Controlo de Acesso.

continuation_token: str

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

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em vários pedidos para que o progresso possa ser monitorizado. O tamanho do lote deve estar entre 1 e 2000. A predefinição quando não especificada é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que a única alteração Controlo de Acesso operação pode ser executada. Se o máximo for atingido antes de todos os sub-caminhos serem processados, o token de continuação pode ser utilizado para retomar a operação. O valor vazio indica que o número máximo de lotes não vinculados e a operação continua até ao fim.

continue_on_failure: bool

Se estiver definida como Falso, a operação terminará rapidamente ao deparar-se com erros de utilizador (4XX). Se For Verdadeiro, a operação ignorará os erros do utilizador e prosseguirá com a operação noutras sub entidades do diretório. O token de continuação só será devolvido quando continue_on_failure for Verdadeiro em caso de erros de utilizador. Se não definir o valor predefinido é Falso para isto.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

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

Tipo de retorno

AccessControlChangeResult

Exceções

AzureError

O utilizador pode reiniciar a operação com continuation_token campo do AzureError se o token estiver disponível.

Mude o nome do ficheiro de origem.

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

Parâmetros

new_name: str

Necessário

o novo nome de ficheiro para o qual o utilizador quer mudar o nome. O valor tem de ter o seguinte formato: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

Objeto ContentSettings utilizado para definir propriedades de caminho.

source_lease: DataLakeLeaseClient ou str

Um ID de concessão para o caminho de origem. Se especificado, o caminho de origem tem de ter uma concessão ativa e o ID de concessão tem de corresponder.

lease

Necessário se o ficheiro/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

source_if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor ETag de origem ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

o cliente de ficheiro com o nome mudado

Tipo de retorno

DataLakeFileClient

Exemplos

Mude o nome do ficheiro de origem.


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

Defina o proprietário, grupo, permissões ou lista de controlo de acesso para um caminho.

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

Necessário

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

group: str

Necessário

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

permissions: str

Necessário

Opcional e apenas válido se o Espaço de Nomes Hierárquico estiver ativado para a conta. Define as permissões de acesso POSIX para o proprietário do ficheiro, o grupo proprietário do ficheiro e outros. A cada classe pode ser concedida permissão de leitura, escrita ou execução. A bit autocolante também é suportada. Ambos os símbolos (rwxrw-rw-) e notação octal de 4 dígitos (por exemplo, 0766) são suportados. as permissões e acl são mutuamente exclusivas.

acl: str

Necessário

Define os direitos de controlo de acesso POSIX em ficheiros e diretórios. O valor é uma lista separada por vírgulas de entradas de controlo de acesso. Cada entrada de controlo de acesso (ACE) consiste num âmbito, um tipo, um identificador de utilizador ou grupo e permissões no formato "[âmbito:][tipo]:[id]:[permissões]". as permissões e acl são mutuamente exclusivas.

lease: DataLakeLeaseClient ou str

Necessário se o ficheiro/diretório tiver uma concessão ativa. O valor pode ser um objeto LeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

response dict

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

Define o Controlo de Acesso num caminho e sub-caminhos.

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

Parâmetros

acl: str

Necessário

Define os direitos de controlo de acesso POSIX em ficheiros e diretórios. O valor é uma lista separada por vírgulas de entradas de controlo de acesso. Cada entrada de controlo de acesso (ACE) consiste num âmbito, um tipo, um identificador de utilizador ou grupo e permissões no formato "[âmbito:][tipo]:[id]:[permissões]".

progress_hook: <xref:func>(AccessControlChanges)

Chamada de retorno onde o autor da chamada pode controlar o progresso da operação, bem como recolher caminhos que não foram alterados Controlo de Acesso.

continuation_token: str

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

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em vários pedidos para que o progresso possa ser monitorizado. O tamanho do lote deve estar entre 1 e 2000. A predefinição quando não especificada é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que a única alteração Controlo de Acesso operação pode ser executada. Se o máximo for atingido antes de todos os sub-caminhos serem processados, o token de continuação pode ser utilizado para retomar a operação. O valor vazio indica que o número máximo de lotes não vinculados e a operação continua até ao fim.

continue_on_failure: bool

Se estiver definida como Falso, a operação terminará rapidamente ao deparar-se com erros de utilizador (4XX). Se For Verdadeiro, a operação ignorará os erros do utilizador e prosseguirá com a operação noutras sub entidades do diretório. O token de continuação só será devolvido quando continue_on_failure for Verdadeiro em caso de erros de utilizador. Se não definir o valor predefinido é Falso para isto.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

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

Tipo de retorno

AccessControlChangeResult

Exceções

AzureError

O utilizador pode reiniciar a operação com continuation_token campo do AzureError se o token estiver disponível.

Define a hora em que um ficheiro irá expirar e ser eliminado.

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

Parâmetros

expiry_options: str

Necessário

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

expires_on: datetime ou int

Necessário

A hora de definir o ficheiro para expirar. Quando expiry_options é RelativeTo*, expires_on deve ser um int em milissegundos. Se o tipo de expires_on for datetime, deve estar na hora UTC.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Tipo de retorno

None

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

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

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

Parâmetros

content_settings: ContentSettings

Necessário

Objeto ContentSettings utilizado para definir propriedades de ficheiro/diretório.

lease: DataLakeLeaseClient ou str

Se especificado, set_file_system_metadata só é bem-sucedido se a concessão do sistema de ficheiros estiver ativa e corresponder a este ID.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

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

Devoluções

file/directory-updated property dict (Etag and last modified)

Tipo de retorno

Dict[str, Any]

Define um ou mais pares nome-valor definidos pelo utilizador para o sistema de ficheiros especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao sistema de ficheiros. Para remover todos os metadados do sistema de ficheiros, chame esta operação sem dict de metadados.

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

Parâmetros

metadata: Dict[str, str]

Necessário

Um ditado que contém pares nome-valor para associar ao sistema de ficheiros como metadados. Exemplo: {'category':'test'}

lease: DataLakeLeaseClient ou str

Se for especificado, set_file_system_metadata só será bem-sucedida se a concessão do sistema de ficheiros estiver ativa e corresponder a este ID.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS.

timeout: int

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

Devoluções

file system-updated property dict (Etag and last modified).

Modifica o Controlo de Acesso num caminho e sub-caminhos.

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

Parâmetros

acl: str

Necessário

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

progress_hook: <xref:func>(AccessControlChanges)

Chamada de retorno onde o autor da chamada pode controlar o progresso da operação, bem como recolher caminhos que não foram alterados Controlo de Acesso.

continuation_token: str

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

batch_size: int

Opcional. Se o tamanho do conjunto de dados exceder o tamanho do lote, a operação será dividida em vários pedidos para que o progresso possa ser controlado. O tamanho do lote deve estar entre 1 e 2000. A predefinição quando não especificado é 2000.

max_batches: int

Opcional. Define o número máximo de lotes que uma única alteração Controlo de Acesso operação pode ser executada. Se o máximo for atingido antes de todos os subpassos serem processados, o token de continuação pode ser utilizado para retomar a operação. O valor vazio indica que o número máximo de lotes em desvinculados e a operação continua até ao fim.

continue_on_failure: bool

Se estiver definida como Falso, a operação terminará rapidamente ao deparar-se com erros de utilizador (4XX). Se For Verdadeiro, a operação ignorará os erros do utilizador e prosseguirá com a operação noutras sub entidades do diretório. O token de continuação só será devolvido quando continue_on_failure for Verdadeiro em caso de erros do utilizador. Se não for definido, o valor predefinido é Falso para esta opção.

timeout: int

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

Devoluções

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

Tipo de retorno

AccessControlChangeResult

Exceções

AzureError

O utilizador pode reiniciar a operação com continuation_token campo do AzureError se o token estiver disponível.

Carregar dados para um ficheiro.

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

Parâmetros

data

Necessário

Conteúdo a carregar para o ficheiro

length: int

Necessário

Tamanho dos dados em bytes.

overwrite: bool

Necessário

para substituir um ficheiro existente ou não.

content_settings: ContentSettings

Objeto ContentSettings utilizado para definir propriedades do caminho.

metadata: Optional[Dict[str, str]]

Pares nome-valor associados ao blob como metadados.

lease: DataLakeLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto DataLakeLeaseClient ou o ID de concessão como uma cadeia.

umask: str

Opcional e válido apenas se o Espaço de Nomes Hierárquico estiver ativado para a conta. Ao criar um ficheiro ou diretório e a pasta principal não tiver uma ACL predefinida, a umask restringe as permissões do ficheiro ou diretório a criar. A permissão resultante é dada por p & ^u, em que p é a permissão e o utilizador é a umask. Por exemplo, se p for 0777 e for 0057, a permissão resultante será 0720. A permissão predefinida é 0777 para um diretório e 0666 para um ficheiro. A umask predefinida é 0027. A umask tem de ser especificada em notação octal de 4 dígitos (por exemplo, 0766).

permissions: str

Opcional e válido apenas se o Espaço de Nomes Hierárquico estiver ativado para a conta. Define permissões de acesso POSIX para o proprietário do ficheiro, o grupo proprietário do ficheiro e outros. Pode ser concedida permissão de leitura, escrita ou execução a cada classe. O sticky bit também é suportado. Tanto a notação octal simbólica (rwxrw-rw-) como a notação octal de 4 dígitos (por exemplo, 0766) são suportadas.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 para cada segmento do ficheiro. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https, como https (a predefinição), já for validada. Note que este Hash MD5 não está armazenado com a bolha. Tenha também em atenção que, se estiver ativado, o algoritmo de carregamento com eficiência de memória não será utilizado porque a computação do hash MD5 requer a colocação em memória intermédia de blocos inteiros e, ao fazê-lo, irá derrotar a finalidade do algoritmo com eficiência de memória.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui. Este 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 do segmento para carregar um ficheiro em segmentos. A predefinição é100 10241024 ou 100 MB.

encryption_context: str

Especifica o contexto de encriptação a definir no ficheiro.

Devoluções

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

A versão da API de Armazenamento utilizada para pedidos.

O modo de localização que o cliente está a utilizar atualmente.

Por predefinição, será "principal". As opções incluem "principal" e "secundário".

O URL completo do ponto final primário.

O nome do anfitrião do ponto final primário.

O URL completo do ponto final secundário, se configurado.

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

Exceções

ValueError

O nome do anfitrião do ponto final secundário.

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

O URL de ponto final completo para esta entidade, incluindo o token de SAS, se utilizado.

Este pode ser o ponto final primário ou o ponto final secundário, dependendo do atual location_mode. :returns: o URL de ponto final completo para esta entidade, incluindo o token de SAS, se utilizado. :rtype: str

acquire_lease	Pede uma nova concessão. Se o ficheiro ou diretório não tiver uma concessão ativa, o serviço DataLake cria uma concessão no ficheiro/diretório e devolve um novo ID de concessão.
append_data	Anexe dados ao ficheiro.
close	Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.
create_file	Criar um novo ficheiro.
delete_file	Marca o ficheiro especificado para eliminação.
download_file	Transfere um ficheiro para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou o método readinto() tem de ser utilizado para transferir o ficheiro para um fluxo. A utilização de segmentos() devolve um iterador que permite ao utilizador iterar sobre o conteúdo em segmentos.
exists	Devolve Verdadeiro se existir um ficheiro e devolve Falso de outra forma.
flush_data	Consolidar os dados anexados anteriores.
from_connection_string	Crie DataLakeFileClient a partir de uma Cadeia de Ligação. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Não devolve o conteúdo do ficheiro.
query_file	Permite que os utilizadores selecionem/projectem dados de ficheiros datalake ao fornecer expressões de consulta simples. Estas operações devolvem um DataLakeFileQueryReader, os utilizadores têm de utilizar readall() ou readinto() para obter dados de consulta.
remove_access_control_recursive	Remove o Controlo de Acesso num caminho e sub-caminhos.
rename_file	Mude o nome do ficheiro de origem.
set_access_control	Defina o proprietário, grupo, permissões ou lista de controlo de acesso para um caminho.
set_access_control_recursive	Define o Controlo de Acesso num caminho e sub-caminhos.
set_file_expiry	Define a hora em que um ficheiro irá expirar e ser eliminado.
set_http_headers	Define as propriedades do sistema no ficheiro ou diretório. Se uma propriedade estiver definida para o content_settings, todas as propriedades serão substituídas.
set_metadata	Define um ou mais pares nome-valor definidos pelo utilizador para o sistema de ficheiros especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao sistema de ficheiros. Para remover todos os metadados do sistema de ficheiros, chame esta operação sem dict de metadados.
update_access_control_recursive	Modifica o Controlo de Acesso num caminho e sub-caminhos.
upload_data	Carregar dados para um ficheiro.

Partilhar via

DataLakeFileClient Classe

Construtor

Parâmetros

Exemplos

Variáveis

Métodos

acquire_lease

Parâmetros

Devoluções

Tipo de retorno

append_data

Parâmetros

Devoluções

Exemplos

close

create_file

Parâmetros

Devoluções

Exemplos

delete_file

Parâmetros

Devoluções

Exemplos

download_file

Parâmetros

Devoluções

Tipo de retorno

Exemplos

exists

Parâmetros

Devoluções

Tipo de retorno

flush_data

Parâmetros

Devoluções

Exemplos

from_connection_string

Parâmetros

get_access_control

Parâmetros

get_file_properties

Parâmetros

Devoluções

Tipo de retorno

Exemplos

query_file

Parâmetros

Devoluções

Tipo de retorno

Exemplos

remove_access_control_recursive

Parâmetros

Devoluções

Tipo de retorno

Exceções

rename_file

Parâmetros

Devoluções

Tipo de retorno

Exemplos

set_access_control

Parâmetros

set_access_control_recursive

Parâmetros

Devoluções

Tipo de retorno

Exceções

set_file_expiry

Parâmetros

Tipo de retorno

set_http_headers

Parâmetros

Devoluções

Tipo de retorno

set_metadata

Parâmetros

Devoluções

update_access_control_recursive

Parâmetros