DataLakeDirectoryClient class
Um DataLakeDirectoryClient representa um URL para o diretório do Armazenamento do Azure.
- Extends
Construtores
| Data |
Cria uma instância de DataLakePathClient a partir do URL e do pipeline. |
| Data |
Cria uma instância de DataLakePathClient a partir do URL e da credencial. |
Propriedades
| file |
Nome do sistema de ficheiros atual. |
| name | Nome do caminho atual (diretório ou ficheiro). |
Propriedades Herdadas
| account |
|
| credential | Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do |
| url | Valor de cadeia de URL codificado. |
Métodos
Métodos Herdados
| delete(boolean, Path |
Eliminar caminho atual (diretório ou ficheiro). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Elimine o caminho atual (diretório ou ficheiro) se existir. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Devolve true se o ficheiro do Data Lake representado por este cliente existir; falso, caso contrário. NOTA: utilize esta função com cuidado, uma vez que um ficheiro existente pode ser eliminado por outros clientes ou aplicações. Os novos ficheiros vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função. |
| get |
Devolve os dados de controlo de acesso de um caminho (diretório de ficheiro). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Obtenha um DataLakeLeaseClient que gere as concessões no caminho (diretório ou ficheiro). |
| get |
Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o caminho (diretório ou ficheiro). AVISO: O Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Mover o diretório ou ficheiro no mesmo sistema de ficheiros. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Mover o diretório ou ficheiro para outro sistema de ficheiros. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Remove o Controlo de Acesso num caminho e sub caminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Defina os dados de controlo de acesso para um caminho (diretório de ficheiro). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Define o Controlo de Acesso num caminho e sub caminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Define as propriedades do sistema no caminho (diretório ou ficheiro). Se não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes cabeçalhos HTTP de blob sem um valor serão limpos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
| set |
Define os metadados definidos pelo utilizador para o caminho especificado (diretório de ficheiro) como um ou mais pares nome-valor. Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do caminho serão removidos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
| set |
Define as permissões de ficheiro num caminho. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Converta DataLakePathClient atual em DataLakeDirectoryClient se o caminho atual for um diretório. |
| to |
Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um ficheiro. |
| update |
Modifica o Controlo de Acesso num caminho e sub-caminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
Detalhes do Construtor
DataLakeDirectoryClient(string, Pipeline)
Cria uma instância de DataLakePathClient a partir do URL e do pipeline.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)Parâmetros
- url
-
string
Uma cadeia de carateres do Cliente a apontar para o caminho do data lake do Armazenamento do Azure (diretório ou ficheiro), como "https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de DataLakePathClient a partir do URL e da credencial.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parâmetros
- url
-
string
Uma cadeia de carateres do Cliente a apontar para o caminho do data lake do Armazenamento do Azure (diretório ou ficheiro), como "https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
Detalhes de Propriedade
fileSystemName
Nome do sistema de ficheiros atual.
string fileSystemNameValor de Propriedade
string
name
Nome do caminho atual (diretório ou ficheiro).
string nameValor de Propriedade
string
Detalhes da Propriedade Herdada
accountName
credential
Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialValor de Propriedade
Herdado deDataLakePathClient.credential
url
Valor de cadeia de URL codificado.
url: stringValor de Propriedade
string
Herdado deDataLakePathClient.url
Detalhes de Método
create(DirectoryCreateOptions)
Criar um diretório.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parâmetros
- options
- DirectoryCreateOptions
Opcional. Opções ao criar o diretório.
Devoluções
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Criar um diretório.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parâmetros
- resourceType
- PathResourceTypeModel
O tipo de recurso tem de ser "diretório" para DataLakeDirectoryClient.
- options
- PathCreateOptions
Opcional. Opções ao criar o diretório.
Devoluções
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Crie um diretório se ainda não existir.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parâmetros
Devoluções
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Crie um diretório se ainda não existir.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parâmetros
- resourceType
- PathResourceTypeModel
O tipo de recurso tem de ser "diretório" para DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Devoluções
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
Disponível apenas para clientes criados com uma credencial de chave partilhada.
Gera um URI de Assinatura de Acesso Partilhado do Serviço (SAS) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parâmetros
- options
- DirectoryGenerateSasUrlOptions
Parâmetros opcionais.
Devoluções
Promise<string>
O URI de SAS que consiste no URI para o recurso representado por este cliente, seguido do token de SAS gerado.
getFileClient(string)
Cria um objeto DataLakeFileClient no diretório atual.
function getFileClient(fileName: string): DataLakeFileClientParâmetros
- fileName
-
string
Devoluções
getSubdirectoryClient(string)
Cria um objeto DataLakeDirectoryClient no diretório atual.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParâmetros
- subdirectoryName
-
string
Nome do subdiretório.
Devoluções
Detalhes do Método Herdado
delete(boolean, PathDeleteOptions)
Eliminar caminho atual (diretório ou ficheiro).
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Parâmetros
- recursive
-
boolean
Obrigatório e válido apenas quando o recurso é um diretório. Se for "verdadeiro", todos os caminhos abaixo do diretório serão eliminados.
- options
- PathDeleteOptions
Opcional. Opções ao eliminar o caminho.
Devoluções
Promise<PathDeleteResponse>
Herdado deDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Elimine o caminho atual (diretório ou ficheiro) se existir.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parâmetros
- recursive
-
boolean
Obrigatório e válido apenas quando o recurso é um diretório. Se for "verdadeiro", todos os caminhos abaixo do diretório serão eliminados.
- options
- PathDeleteOptions
Devoluções
Promise<PathDeleteIfExistsResponse>
Herdado deDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Devolve true se o ficheiro do Data Lake representado por este cliente existir; falso, caso contrário.
NOTA: utilize esta função com cuidado, uma vez que um ficheiro existente pode ser eliminado por outros clientes ou aplicações. Os novos ficheiros vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.
function exists(options?: PathExistsOptions): Promise<boolean>Parâmetros
- options
- PathExistsOptions
opções para a operação Existe.
Devoluções
Promise<boolean>
Herdado deDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Devolve os dados de controlo de acesso de um caminho (diretório de ficheiro).
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parâmetros
- options
- PathGetAccessControlOptions
Opcional. Opções ao obter o controlo de acesso a ficheiros.
Devoluções
Promise<PathGetAccessControlResponse>
Herdado deDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Obtenha um DataLakeLeaseClient que gere as concessões no caminho (diretório ou ficheiro).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParâmetros
- proposeLeaseId
-
string
Opcional. ID de concessão proposta inicial.
Devoluções
getProperties(PathGetPropertiesOptions)
Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o caminho (diretório ou ficheiro).
AVISO: O metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelos métodos de DataLakeFileSystemClient que listam caminhos com a opção includeMetadata , que irá manter a sua caixa original.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parâmetros
- options
- PathGetPropertiesOptions
Opcional. Opções ao obter as propriedades do caminho.
Devoluções
Promise<PathGetPropertiesResponse>
Herdado deDataLakePathClient.getProperties
move(string, PathMoveOptions)
Mover o diretório ou ficheiro no mesmo sistema de ficheiros.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parâmetros
- destinationPath
-
string
Caminho do diretório de destino, como "diretório" ou caminho de ficheiro "diretório/ficheiro". Se o destinationPath estiver autenticado com SAS, adicione a SAS ao caminho de destino, como "diretório/ficheiro?sasToken".
- options
- PathMoveOptions
Opcional. Opções ao mover o diretório ou ficheiro.
Devoluções
Promise<PathMoveResponse>
Herdado deDataLakePathClient.move
move(string, string, PathMoveOptions)
Mover o diretório ou ficheiro para outro sistema de ficheiros.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parâmetros
- destinationFileSystem
-
string
Sistema de ficheiros de destino, como "sistema de ficheiros".
- destinationPath
-
string
Caminho do diretório de destino, como "diretório" ou caminho de ficheiro "diretório/ficheiro" Se o destinationPath estiver autenticado com SAS, adicione a SAS ao caminho de destino, como "diretório/ficheiro?sasToken".
- options
- PathMoveOptions
Opcional. Opções ao mover o diretório ou ficheiro.
Devoluções
Promise<PathMoveResponse>
Herdado deDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Remove o Controlo de Acesso num caminho e sub caminhos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parâmetros
A lista de controlo de acesso POSIX para o ficheiro ou diretório.
Opcional. Opções
Devoluções
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Defina os dados de controlo de acesso para um caminho (diretório de ficheiro).
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Parâmetros
- acl
A lista de controlo de acesso POSIX para o ficheiro ou diretório.
- options
- PathSetAccessControlOptions
Opcional. Opções ao definir o controlo de acesso ao caminho.
Devoluções
Promise<PathSetAccessControlResponse>
Herdado deDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Define o Controlo de Acesso num caminho e sub caminhos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parâmetros
- acl
A lista de controlo de acesso POSIX para o ficheiro ou diretório.
Opcional. Opções
Devoluções
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Define as propriedades do sistema no caminho (diretório ou ficheiro).
Se não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes cabeçalhos HTTP de blob sem um valor serão limpos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Parâmetros
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Devoluções
Promise<PathSetHttpHeadersResponse>
Herdado deDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Define os metadados definidos pelo utilizador para o caminho especificado (diretório de ficheiro) como um ou mais pares nome-valor.
Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do caminho serão removidos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Parâmetros
- metadata
- Metadata
Opcional. Substitua os metadados existentes por este valor. Se não for fornecido nenhum valor, os metadados existentes serão removidos.
- options
- PathSetMetadataOptions
Opcional. Opções ao definir metadados de caminho.
Devoluções
Promise<PathSetMetadataResponse>
Herdado deDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Define as permissões de ficheiro num caminho.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Parâmetros
- permissions
- PathPermissions
As permissões de acesso POSIX para o proprietário do ficheiro, o grupo proprietário do ficheiro e outros.
- options
- PathSetPermissionsOptions
Opcional. Opções ao definir permissões de caminho.
Devoluções
Promise<PathSetPermissionsResponse>
Herdado deDataLakePathClient.setPermissions
toDirectoryClient()
Converta DataLakePathClient atual em DataLakeDirectoryClient se o caminho atual for um diretório.
function toDirectoryClient(): DataLakeDirectoryClientDevoluções
Herdado deDataLakePathClient.toDirectoryClient
toFileClient()
Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um ficheiro.
function toFileClient(): DataLakeFileClientDevoluções
Herdado deDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Modifica o Controlo de Acesso num caminho e sub-caminhos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parâmetros
- acl
A lista de controlo de acesso POSIX para o ficheiro ou diretório.
Opcional. Opções