DataLakeDirectoryClient class
Um DataLakeDirectoryClient representa uma URL para o diretório de Armazenamento do Azure.
- Extends
Construtores
| Data |
Cria uma instância de DataLakePathClient a partir de url e pipeline. |
| Data |
Cria uma instância de DataLakePathClient a partir de url e credencial. |
Propriedades
| file |
Nome do sistema de arquivos atual. |
| name | Nome do caminho atual (diretório ou arquivo). |
Propriedades Herdadas
| account |
|
| credential | Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote |
| url | Valor da cadeia de caracteres de URL codificada. |
Métodos
Métodos Herdados
| delete(boolean, Path |
Exclua o caminho atual (diretório ou arquivo). Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Exclua o caminho atual (diretório ou arquivo), se existir. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Retorna true se o arquivo 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. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função. |
| get |
Retorna os dados de controle de acesso para um caminho (diretório de arquivo). Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Obtenha um DataLakeLeaseClient que gerencia concessões no caminho (diretório ou arquivo). |
| get |
Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o caminho (diretório ou arquivo). AVISO: O objeto Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Mova o diretório ou arquivo dentro do mesmo sistema de arquivos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Mova o diretório ou arquivo para outro sistema de arquivos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Remove o Controle de Acesso em um caminho e subcaminhos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Defina os dados de controle de acesso para um caminho (diretório de arquivo). Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Define o Controle de Acesso em um caminho e subcaminhos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Define as propriedades do sistema no caminho (diretório ou arquivo). Se nenhum valor fornecido, ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
| set |
Define metadados definidos pelo usuário para o caminho especificado (diretório de arquivo) como um ou mais pares nome-valor. Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do caminho serão removidos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
| set |
Define as permissões de arquivo em um caminho. Visualizar 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 arquivo. |
| update |
Modifica o Controle de Acesso em um caminho e subcaminhos. Visualizar 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 de url e pipeline.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)Parâmetros
- url
-
string
Uma cadeia de caracteres de Cliente apontando para o caminho do data lake do Armazenamento do Azure (diretório ou arquivo), como "https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de DataLakePathClient a partir de url e credencial.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parâmetros
- url
-
string
Uma cadeia de caracteres de Cliente apontando para o caminho do data lake do Armazenamento do Azure (diretório ou arquivo), como "https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
Detalhes de Propriedade
fileSystemName
Nome do sistema de arquivos atual.
string fileSystemNameValor de Propriedade
string
name
Nome do caminho atual (diretório ou arquivo).
string nameValor de Propriedade
string
Detalhes da Propriedade Herdada
accountName
credential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialValor de Propriedade
url
Valor da cadeia de caracteres de URL codificada.
url: stringValor de Propriedade
string
Detalhes de Método
create(DirectoryCreateOptions)
Crie um diretório.
Visualizar 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 diretório.
Devoluções
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Crie um diretório.
Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parâmetros
- resourceType
- PathResourceTypeModel
Tipo de recurso, deve ser "diretório" para DataLakeDirectoryClient.
- options
- PathCreateOptions
Opcional. Opções ao criar diretório.
Devoluções
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Crie um diretório se ele ainda não existir.
Visualizar 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 ele ainda não existir.
Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parâmetros
- resourceType
- PathResourceTypeModel
Tipo de recurso, deve ser "diretório" para DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Devoluções
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
Disponível apenas para clientes construídos com uma credencial de chave compartilhada.
Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.
Visualizar 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 SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token 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)
Exclua o caminho atual (diretório ou arquivo).
Visualizar 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 somente quando o recurso é um diretório. Se "true", todos os caminhos abaixo do diretório serão excluídos.
- options
- PathDeleteOptions
Opcional. Opções ao excluir caminho.
Devoluções
Promise<PathDeleteResponse>
herdado deDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Exclua o caminho atual (diretório ou arquivo), se existir.
Visualizar 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 somente quando o recurso é um diretório. Se "true", todos os caminhos abaixo do diretório serão excluídos.
- options
- PathDeleteOptions
Devoluções
Promise<PathDeleteIfExistsResponse>
herdado deDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Retorna true se o arquivo 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. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa 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)
Retorna os dados de controle de acesso para um caminho (diretório de arquivo).
Visualizar 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 controle de acesso a arquivos.
Devoluções
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
Obtenha um DataLakeLeaseClient que gerencia concessões no caminho (diretório ou arquivo).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParâmetros
- proposeLeaseId
-
string
Opcional. Proposta inicial de arrendamento Id.
Devoluções
getProperties(PathGetPropertiesOptions)
Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o caminho (diretório ou arquivo).
AVISO: O objeto metadata retornado na resposta terá suas teclas em minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelos métodos de DataLakeFileSystemClient que listam caminhos usando a opção includeMetadata, que manterá seu invólucro original.
Visualizar 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 propriedades de caminho.
Devoluções
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
Mova o diretório ou arquivo dentro do mesmo sistema de arquivos.
Visualizar 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 do arquivo "diretório/arquivo". Se destinationPath for autenticado com SAS, adicione o SAS ao caminho de destino como "directory/file?sasToken".
- options
- PathMoveOptions
Opcional. Opções ao mover diretório ou arquivo.
Devoluções
Promise<PathMoveResponse>
herdado deDataLakePathClient.move
move(string, string, PathMoveOptions)
Mova o diretório ou arquivo para outro sistema de arquivos.
Visualizar 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 arquivos de destino como "sistema de arquivos".
- destinationPath
-
string
Caminho do diretório de destino como "diretório" ou caminho do arquivo "diretório/arquivo" Se o destinationPath for autenticado com SAS, adicione o SAS ao caminho de destino como "directory/file?sasToken".
- options
- PathMoveOptions
Opcional. Opções ao mover diretório ou arquivo.
Devoluções
Promise<PathMoveResponse>
herdado deDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Remove o Controle de Acesso em um caminho e subcaminhos.
Visualizar 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 controle de acesso POSIX para o arquivo ou diretório.
Opcional. Opções
Devoluções
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Defina os dados de controle de acesso para um caminho (diretório de arquivo).
Visualizar 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 controle de acesso POSIX para o arquivo ou diretório.
- options
- PathSetAccessControlOptions
Opcional. Opções ao definir o controle de acesso de caminho.
Devoluções
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Define o Controle de Acesso em um caminho e subcaminhos.
Visualizar 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 controle de acesso POSIX para o arquivo ou diretório.
Opcional. Opções
Devoluções
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Define as propriedades do sistema no caminho (diretório ou arquivo).
Se nenhum valor fornecido, ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.
Visualizar 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 metadados definidos pelo usuário para o caminho especificado (diretório de arquivo) como um ou mais pares nome-valor.
Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do caminho serão removidos.
Visualizar 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 esse valor. Se nenhum valor for fornecido, os metadados existentes serão removidos.
- options
- PathSetMetadataOptions
Opcional. Opções ao definir metadados de caminho.
Devoluções
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
Define as permissões de arquivo em um caminho.
Visualizar 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 arquivo, o grupo proprietário do arquivo 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
toFileClient()
Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um arquivo.
function toFileClient(): DataLakeFileClientDevoluções
herdado deDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Modifica o Controle de Acesso em um caminho e subcaminhos.
Visualizar 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 controle de acesso POSIX para o arquivo ou diretório.
Opcional. Opções