DataLakePathClient class

Pacote:

@azure/storage-file-datalake

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

Extends

StorageClient

Construtores

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

Propriedades

fileSystemName	Nome do sistema de ficheiros atual.
name	Nome do caminho atual (diretório ou ficheiro).

Propriedades Herdadas

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.
url	Valor de cadeia de URL codificado.

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)	Criar um diretório ou ficheiro. Se o recurso já existir, não será alterado. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Elimine o caminho atual (diretório ou ficheiro). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/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
exists(PathExistsOptions)	Devolve verdadeiro se o ficheiro do Data Lake representado por este cliente existir; falso de outra forma. 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.
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
getDataLakeLeaseClient(string)	Obtenha um DataLakeLeaseClient que gere as concessões no caminho (diretório ou ficheiro).
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 dataLakeFileSystemClient que listam caminhos com a opção, o que irá manter o includeMetadata seu invólucro original. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Mover 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, PathMoveOptions)	Mover diretório ou ficheiro para outro sistema de ficheiros. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
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
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
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
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
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
setPermissions(PathPermissions, PathSetPermissionsOptions)	Define as permissões de ficheiro num 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 ficheiro.
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

Detalhes do Construtor

DataLakePathClient(string, Pipeline)

Cria uma instância do DataLakePathClient a partir do url e do pipeline.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de cliente que aponta 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.

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

Cria uma instância do DataLakePathClient a partir do URL e da credencial.

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

Parâmetros

url

string

Uma cadeia de cliente que aponta 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 no 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 fileSystemName

Valor de Propriedade

string

name

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

string name

Valor de Propriedade

string

Detalhes da Propriedade Herdada

accountName

accountName: string

Valor de Propriedade

string

Herdado de StorageClient.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 | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Herdado de StorageClient.credential

url

Valor de cadeia de URL codificado.

url: string

Valor de Propriedade

string

Herdado de StorageClient.url

Detalhes de 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 "ficheiro".

options

PathCreateOptions

Opcional. Opções ao criar o caminho.

Devoluções

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Criar um diretório ou ficheiro. Se o recurso já existir, 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 "ficheiro".

options

PathCreateIfNotExistsOptions

Devoluções

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

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

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>

exists(PathExistsOptions)

Devolve verdadeiro se o ficheiro do Data Lake representado por este cliente existir; falso de outra forma.

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>

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>

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gere as concessões no caminho (diretório ou ficheiro).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

proposeLeaseId

string

Opcional. ID de concessão proposta inicial.

Devoluções

DataLakeLeaseClient

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 dataLakeFileSystemClient que listam caminhos com a opção, o que irá manter o includeMetadata seu invólucro 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.

Devoluções

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

Mover 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 for autenticado com SAS, adicione o SAS ao caminho de destino, como "diretório/ficheiro?sasToken".

options

PathMoveOptions

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

Devoluções

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

Mover 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 o SAS ao caminho de destino como "diretório/ficheiro?sasToken".

options

PathMoveOptions

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

Devoluções

Promise<PathMoveResponse>

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

acl

RemovePathAccessControlItem[]

A lista de controlo de acesso POSIX para o ficheiro ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Devoluções

Promise<PathChangeAccessControlRecursiveResponse>

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

PathAccessControlItem[]

A lista de controlo de acesso POSIX para o ficheiro ou diretório.

options

PathSetAccessControlOptions

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

Devoluções

Promise<PathSetAccessControlResponse>

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

PathAccessControlItem[]

A lista de controlo de acesso POSIX para o ficheiro ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Devoluções

Promise<PathChangeAccessControlRecursiveResponse>

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>

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>

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>

toDirectoryClient()

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

function toDirectoryClient(): DataLakeDirectoryClient

Devoluções

DataLakeDirectoryClient

toFileClient()

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

function toFileClient(): DataLakeFileClient

Devoluções

DataLakeFileClient

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

PathAccessControlItem[]

A lista de controlo de acesso POSIX para o ficheiro ou diretório.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opções

Devoluções

Promise<PathChangeAccessControlRecursiveResponse>