DataLakePathClient class

Pacote:

@azure/storage-file-datalake

Um DataLakePathClient representa uma URL para o caminho do Armazenamento do Azure (diretório ou arquivo).

Extends

StorageClient

Construtores

DataLakePathClient(string, Pipeline)	Cria uma instância de DataLakePathClient da URL e do pipeline.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Cria uma instância de DataLakePathClient da URL e da credencial.

Propriedades

fileSystemName	Nome do sistema de arquivos atual.
name	Nome do caminho atual (diretório ou arquivo).

Propriedades herdadas

accountName
credential	Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote 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.
url	Valor da cadeia de caracteres de URL codificada.

Métodos

create(PathResourceTypeModel, PathCreateOptions)	Crie um diretório ou caminho. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Crie um diretório ou arquivo. Se o recurso já existir, ele não será alterado. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Exclua o caminho atual (diretório ou arquivo). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Exclua o caminho atual (diretório ou arquivo) se ele existir. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Retornará true se o arquivo data lake representado por esse cliente existir; false caso contrário. OBSERVAÇÃO: use essa função com cuidado, pois um arquivo existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
getAccessControl(PathGetAccessControlOptions)	Retorna os dados de controle de acesso para um caminho (diretório do arquivo). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Obtenha um DataLakeLeaseClient que gerencia concessões no caminho (diretório ou arquivo).
getProperties(PathGetPropertiesOptions)	Retorna todos os metadados definidos pelo usuário, as propriedades HTTP padrão e as propriedades do sistema para o caminho (diretório ou arquivo). AVISO: o metadata objeto retornado na resposta terá suas chaves em letras 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á sua maiúscula original. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Mover diretório ou arquivo dentro do mesmo sistema de arquivos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Mova o diretório ou o arquivo para outro sistema de arquivos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Remove o Controle de Acesso em um caminho e sub caminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Defina os dados de controle de acesso para um caminho (diretório do arquivo). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Define o Controle de Acesso em um caminho e sub caminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Define as propriedades do sistema no caminho (diretório ou arquivo). Se nenhum valor for 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Define metadados definidos pelo usuário para o caminho especificado (diretório do arquivo) como um ou mais pares nome-valor. Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro, os metadados do caminho serão removidos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Define as permissões de arquivo em um caminho. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Converta DataLakePathClient atual em DataLakeDirectoryClient se o caminho atual for um diretório.
toFileClient()	Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um arquivo.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Modifica o Controle de Acesso em um caminho e subcaminhos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Detalhes do construtor

DataLakePathClient(string, Pipeline)

Cria uma instância de DataLakePathClient da URL e do pipeline.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de caracteres do 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.

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de DataLakePathClient da URL e da credencial.

new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url

string

Uma cadeia de caracteres do 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 @azure/identity pacote 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 da propriedade

fileSystemName

Nome do sistema de arquivos atual.

string fileSystemName

Valor da propriedade

string

name

Nome do caminho atual (diretório ou arquivo).

string name

Valor da propriedade

string

Detalhes das propriedades herdadas

accountName

accountName: string

Valor da propriedade

string

Herdado de StorageClient.accountName

credential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote 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 | TokenCredential

Valor da propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Herdado de StorageClient.credential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

string

Herdado de StorageClient.url

Detalhes do método

create(PathResourceTypeModel, PathCreateOptions)

Crie um diretório ou caminho.

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

Tipo de recurso, "diretório" ou "arquivo".

options

PathCreateOptions

Opcional. Opções ao criar caminho.

Retornos

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Crie um diretório ou arquivo. Se o recurso já existir, ele não será alterado.

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

Tipo de recurso, "diretório" ou "arquivo".

options

PathCreateIfNotExistsOptions

Retornos

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

Exclua o caminho atual (diretório ou arquivo).

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

Retornos

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

Exclua o caminho atual (diretório ou arquivo) se ele 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 somente quando o recurso é um diretório. Se "true", todos os caminhos abaixo do diretório serão excluídos.

options

PathDeleteOptions

Retornos

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

Retornará true se o arquivo data lake representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um arquivo existente pode ser excluído por outros clientes ou aplicativos. 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 Exists.

Retornos

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

Retorna os dados de controle de acesso para um caminho (diretório do arquivo).

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 controle de acesso a arquivos.

Retornos

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gerencia concessões no caminho (diretório ou arquivo).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

proposeLeaseId

string

Opcional. ID de concessão proposta inicial.

Retornos

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário, as propriedades HTTP padrão e as propriedades do sistema para o caminho (diretório ou arquivo).

AVISO: o metadata objeto retornado na resposta terá suas chaves em letras 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á sua maiúscula 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 propriedades de caminho.

Retornos

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

Mover diretório ou arquivo dentro do mesmo sistema de arquivos.

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 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 o diretório ou arquivo.

Retornos

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

Mova o diretório ou o arquivo para outro sistema de arquivos.

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 arquivos de destino como "filesystem".

destinationPath

string

Caminho do diretório de destino, como "diretório" ou caminho de arquivo "diretório/arquivo" Se o destinationPath for autenticado com SAS, adicione a SAS ao caminho de destino como "directory/file?sasToken".

options

PathMoveOptions

Opcional. Opções ao mover o diretório ou arquivo.

Retornos

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Remove o Controle de Acesso em um 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

acl

RemovePathAccessControlItem[]

A lista de controle de acesso POSIX para o arquivo ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Retornos

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Defina os dados de controle de acesso para um caminho (diretório do arquivo).

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Parâmetros

acl

PathAccessControlItem[]

A lista de controle de acesso POSIX para o arquivo ou diretório.

options

PathSetAccessControlOptions

Opcional. Opções ao definir o controle de acesso do caminho.

Retornos

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Define o Controle de Acesso em um 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

PathAccessControlItem[]

A lista de controle de acesso POSIX para o arquivo ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Retornos

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

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

Se nenhum valor for 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.

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

Retornos

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

Define metadados definidos pelo usuário para o caminho especificado (diretório do arquivo) como um ou mais pares nome-valor.

Se nenhuma opção for fornecida ou nenhum metadado definido 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 esse valor. Se nenhum valor for fornecido, os metadados existentes serão removidos.

options

PathSetMetadataOptions

Opcional. Opções ao definir metadados de caminho.

Retornos

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Define as permissões de arquivo em um 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 arquivo, o grupo proprietário do arquivo e outros.

options

PathSetPermissionsOptions

Opcional. Opções ao definir permissões de caminho.

Retornos

Promise<PathSetPermissionsResponse>

toDirectoryClient()

Converta DataLakePathClient atual em DataLakeDirectoryClient se o caminho atual for um diretório.

function toDirectoryClient(): DataLakeDirectoryClient

Retornos

DataLakeDirectoryClient

toFileClient()

Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um arquivo.

function toFileClient(): DataLakeFileClient

Retornos

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Modifica o Controle de Acesso em um caminho e subcaminhos.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parâmetros

acl

PathAccessControlItem[]

A lista de controle de acesso POSIX para o arquivo ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Retornos

Promise<PathChangeAccessControlRecursiveResponse>