DataLakeDirectoryClient class

Pacote:

@azure/storage-file-datalake

Um DataLakeDirectoryClient representa uma URL para o diretório do Armazenamento do Azure.

Extends

DataLakePathClient

Construtores

DataLakeDirectoryClient(string, Pipeline)	Cria uma instância de DataLakePathClient da URL e do pipeline.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Cria uma instância de DataLakePathClient com base na URL e na 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 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.
url	Valor da cadeia de caracteres de URL codificada.

Métodos

create(DirectoryCreateOptions)	Crie um diretório. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	Crie um diretório. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(DirectoryCreateIfNotExistsOptions)	Crie um diretório se ele ainda não existir. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Crie um diretório se ele ainda não existir. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
generateSasStringToSign(DirectoryGenerateSasUrlOptions)	Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(DirectoryGenerateSasUrlOptions)	Disponível somente para clientes construídos com uma credencial de chave compartilhada. Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)	Gera cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades do cliente e os parâmetros passados na SAS são assinados pela chave de delegação do usuário de entrada. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)	Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getFileClient(string)	Cria um objeto DataLakeFileClient no diretório atual.
getSubdirectoryClient(string)	Cria um objeto DataLakeDirectoryClient no diretório atual.

Métodos herdados

delete(boolean, PathDeleteOptions)	Excluir o caminho atual (diretório ou arquivo). Consulte 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. Consulte 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). Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Obtenha um DataLakeLeaseClient que gerencia as 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 objeto metadata 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 caixa original. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Mover diretório ou arquivo no mesmo sistema de arquivos. Consulte 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. Consulte 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. Consulte 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). Consulte 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. Consulte 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. Consulte 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 metadados definido no parâmetro, os metadados do caminho serão removidos. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Define as permissões de arquivo em um caminho. Consulte 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 sub-caminhos. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Detalhes do construtor

DataLakeDirectoryClient(string, Pipeline)

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

new DataLakeDirectoryClient(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.

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

Cria uma instância de DataLakePathClient com base na URL e na credencial.

new DataLakeDirectoryClient(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 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 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 deDataLakePathClient.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 | TokenCredential

Valor da propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

herdado deDataLakePathClient.credential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

string

herdado deDataLakePathClient.url

Detalhes do método

create(DirectoryCreateOptions)

Crie um diretório.

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

Retornos

Promise<DirectoryCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Crie um diretório.

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

Retornos

Promise<PathCreateResponse>

createIfNotExists(DirectoryCreateIfNotExistsOptions)

Crie um diretório se ele ainda não existir.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

Parâmetros

options

DirectoryCreateIfNotExistsOptions

Retornos

Promise<DirectoryCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Crie um diretório se ele ainda não existir.

Consulte 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

Retornos

Promise<PathCreateIfNotExistsResponse>

generateSasStringToSign(DirectoryGenerateSasUrlOptions)

Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

Parâmetros

options

DirectoryGenerateSasUrlOptions

Parâmetros opcionais.

Retornos

string

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

generateSasUrl(DirectoryGenerateSasUrlOptions)

Disponível somente para clientes construídos com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

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

Retornos

Promise<string>

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)

Gera cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades do cliente e os parâmetros passados na SAS são assinados pela chave de delegação do usuário de entrada.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parâmetros

options

DirectoryGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey

UserDelegationKey

Valor retornado de blobServiceClient.getUserDelegationKey()

Retornos

string

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parâmetros

options

DirectoryGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey

UserDelegationKey

Valor retornado de blobServiceClient.getUserDelegationKey()

Retornos

Promise<string>

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

getFileClient(string)

Cria um objeto DataLakeFileClient no diretório atual.

function getFileClient(fileName: string): DataLakeFileClient

Parâmetros

fileName

string

Retornos

DataLakeFileClient

getSubdirectoryClient(string)

Cria um objeto DataLakeDirectoryClient no diretório atual.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

Parâmetros

subdirectoryName

string

Nome do subdiretório.

Retornos

DataLakeDirectoryClient

Detalhes do método herdado

delete(boolean, PathDeleteOptions)

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

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

herdado deDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

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

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

herdado deDataLakePathClient.deleteIfExists

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>

Herdado deDataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

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

Consulte 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 ao arquivo.

Retornos

Promise<PathGetAccessControlResponse>

herdado de DataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gerencia as 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

herdado deDataLakePathClient.getDataLakeLeaseClient

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 objeto metadata 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 caixa original.

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

herdado de DataLakePathClient.getProperties

move(string, PathMoveOptions)

Mover diretório ou arquivo no mesmo sistema de arquivos.

Consulte 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 a SAS ao caminho de destino como "diretório/arquivo?sasToken".

options

PathMoveOptions

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

Retornos

Promise<PathMoveResponse>

herdado deDataLakePathClient.move

move(string, string, PathMoveOptions)

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

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

options

PathMoveOptions

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

Retornos

Promise<PathMoveResponse>

herdado deDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

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

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

Herdado deDataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

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

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

Herdado deDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

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

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

Herdado deDataLakePathClient.setAccessControlRecursive

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.

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

herdado deDataLakePathClient.setHttpHeaders

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 metadados definido no parâmetro, os metadados do caminho serão removidos.

Consulte 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 fornecido, os metadados existentes serão removidos.

options

PathSetMetadataOptions

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

Retornos

Promise<PathSetMetadataResponse>

Herdado deDataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Define as permissões de arquivo em um caminho.

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

Herdado deDataLakePathClient.setPermissions

toDirectoryClient()

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

function toDirectoryClient(): DataLakeDirectoryClient

Retornos

DataLakeDirectoryClient

herdado deDataLakePathClient.toDirectoryClient

toFileClient()

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

function toFileClient(): DataLakeFileClient

Retornos

DataLakeFileClient

herdado deDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

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

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

herdado deDataLakePathClient.updateAccessControlRecursive