azure.storage.filedatalake.DataLakeDirectoryClient 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.

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 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

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

Tipo de retorno

DataLakeLeaseClient

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

close() -> None

Criará um novo diretório.

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

Parâmetros

metadata: dict(str, str)

Obrigatório

Pares de nome-valor associados ao arquivo como metadados.

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

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 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).

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.

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.

Retornos

Um dicionário de cabeçalhos de resposta.

Tipo de retorno

Dict[str, Union[str, datetime]]

Exemplos

Criar diretório.


   directory_client.create_directory()

Crie um novo arquivo e retorne o cliente de arquivo com o qual interagir.

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Parâmetros

file: str ou FileProperties

Obrigatório

O arquivo com o qual interagir. Isso pode ser o nome do arquivo ou uma instância de FileProperties.

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

metadata

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 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).

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.

Retornos

DataLakeFileClient

Crie um subdiretório e retorne o cliente subdiretório com o qual interagir.

create_sub_directory(sub_directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient

Parâmetros

sub_directory: str ou DirectoryProperties

Obrigatório

O diretório com o qual interagir. Isso pode ser o nome do diretório ou uma instância de DirectoryProperties.

metadata: dict(str, str)

Obrigatório

Pares de nome-valor associados ao arquivo como metadados.

content_settings: ContentSettings

Objeto ContentSettings usado para definir propriedades de caminho.

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 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).

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.

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.

Retornos

DataLakeDirectoryClient para o subdiretório.

Marca o diretório especificado para exclusão.

delete_directory(**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 diretório.


   new_directory.delete_directory()

Marca o subdiretório especificado para exclusão.

delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parâmetros

sub_directory: str ou DirectoryProperties

Obrigatório

O diretório com o qual interagir. Isso pode ser o nome do diretório ou uma instância de DirectoryProperties.

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

DataLakeDirectoryClient para o subdiretório

Retornará True se houver um diretório e retornar False caso contrário.

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 diretório, false caso contrário.

Tipo de retorno

bool

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

from_connection_string(conn_str: str, file_system_name: str, directory_name: 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.

credential

valor padrão: None

As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. 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. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita

exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. 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.

directory_name: str

Obrigatório

O nome do diretório com o qual interagir. O diretório está no sistema de arquivos.

credential

Obrigatório

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.

Retornos

a DataLakeDirectoryClient

Tipo de retorno

DataLakeDirectoryClient

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, as propriedades HTTP padrão e as propriedades do sistema para o diretório. Ele não retorna o conteúdo do diretório.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

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 diretório 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, confira aqui.

Tipo de retorno

DirectoryProperties

Exemplos

Obtendo as propriedades de um arquivo/diretório.


   props = new_directory.get_directory_properties()

Faça com que um cliente interaja com o arquivo especificado.

O arquivo ainda não precisa existir.

get_file_client(file: FileProperties | str) -> DataLakeFileClient

Parâmetros

file: str ou FileProperties

Obrigatório

O arquivo com o qual interagir. Isso pode ser o nome do arquivo ou uma instância de FileProperties. Eg. directory/subdirectory/file

Retornos

Um DataLakeFileClient.

Tipo de retorno

DataLakeFileClient

Faça com que um cliente interaja com o subdiretório especificado do diretório atual.

O subdiretório ainda não precisa existir.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parâmetros

sub_directory: str ou DirectoryProperties

Obrigatório

O diretório com o qual interagir. Isso pode ser o nome do diretório ou uma instância de DirectoryProperties.

Retornos

Um DataLakeDirectoryClient.

Tipo de retorno

DataLakeDirectoryClient

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

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 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.

Renomeie o diretório de origem.

rename_directory(new_name: str, **kwargs: Any) -> DataLakeDirectoryClient

Parâmetros

new_name: str

Obrigatório

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

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 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.

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, consulte aqui.

Retornos

DataLakeDirectoryClient

Exemplos

Renomeie o diretório de origem.


   new_dir_name = "testdir2"
   print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
   new_directory = directory_client\
       .rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)

Defina o proprietário, o grupo, as permissões ou a lista de controle 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

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. O bit autoadesiva também tem suporte. Há suporte para notação octal simbólica (rwxrw-rw-) e octal de 4 dígitos (por exemplo, 0766). as permissões e a 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]". as permissões e a 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 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.

response dict

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

Define o Controle de Acesso em um caminho e subcaminhos.

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 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.

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_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 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

dict de propriedade de arquivo/diretório atualizado (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 para 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 dict de metadados.

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 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

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.

Retornos

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

Modifica o Controle de Acesso em um caminho e subcaminhos.

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 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.

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, este 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.

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.
close	Esse método é fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
create_directory	Criará um novo diretório.
create_file	Crie um novo arquivo e retorne o cliente de arquivo com o qual interagir.
create_sub_directory	Crie um subdiretório e retorne o cliente subdiretório com o qual interagir.
delete_directory	Marca o diretório especificado para exclusão.
delete_sub_directory	Marca o subdiretório especificado para exclusão.
exists	Retornará True se houver um diretório e retornar False caso contrário.
from_connection_string	Crie DataLakeDirectoryClient a partir de uma cadeia de conexão.
get_access_control
get_directory_properties	Retorna todos os metadados definidos pelo usuário, as propriedades HTTP padrão e as propriedades do sistema para o diretório. Ele não retorna o conteúdo do diretório.
get_file_client	Faça com que um cliente interaja com o arquivo especificado. O arquivo ainda não precisa existir.
get_sub_directory_client	Faça com que um cliente interaja com o subdiretório especificado do diretório atual. O subdiretório ainda não precisa existir.
remove_access_control_recursive	Remove o Controle de Acesso em um caminho e sub-caminhos.
rename_directory	Renomeie o diretório de origem.
set_access_control	Defina o proprietário, o grupo, as permissões ou a lista de controle de acesso para um caminho.
set_access_control_recursive	Define o Controle de Acesso em um caminho e subcaminhos.
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 para 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 dict de metadados.
update_access_control_recursive	Modifica o Controle de Acesso em um caminho e subcaminhos.

Compartilhar via

DataLakeDirectoryClient Classe

Construtor

Parâmetros

Exemplos

Variáveis

Métodos

acquire_lease

Parâmetros

Retornos

Tipo de retorno

close

create_directory

Parâmetros

Retornos

Tipo de retorno

Exemplos

create_file

Parâmetros

Retornos

create_sub_directory

Parâmetros

Retornos

delete_directory

Parâmetros

Retornos

Exemplos

delete_sub_directory

Parâmetros

Retornos

exists

Parâmetros

Retornos

Tipo de retorno

from_connection_string

Parâmetros

Retornos

Tipo de retorno

get_access_control

Parâmetros

get_directory_properties

Parâmetros

Tipo de retorno

Exemplos

get_file_client

Parâmetros

Retornos

Tipo de retorno

get_sub_directory_client

Parâmetros

Retornos

Tipo de retorno

remove_access_control_recursive

Parâmetros

Retornos

Tipo de retorno

Exceções

rename_directory

Parâmetros

Retornos

Exemplos

set_access_control

Parâmetros

set_access_control_recursive

Parâmetros

Retornos

Tipo de retorno

Exceções

set_http_headers

Parâmetros

Retornos

Tipo de retorno

set_metadata

Parâmetros

Retornos

update_access_control_recursive

Parâmetros

Retornos

Tipo de retorno

Exceções