DataLakePathClient class

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

new DataLakePathClient(url: string, pipeline: Pipeline)

Parâmetros

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

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

Parâmetros

Nome do sistema de arquivos atual.

string fileSystemName

Valor da propriedade

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

string name

Valor da propriedade

accountName: string

Valor da propriedade

herdado de StorageClient.accountName

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

herdado de StorageClient.credential

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

herdado de StorageClient.url

Crie um diretório ou caminho.

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Parâmetros

Retornos

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

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Parâmetros

Retornos

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

Retornos

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://learn.microsoft.com/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parâmetros

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parâmetros

Retornos

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://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Parâmetros

Retornos

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://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Parâmetros

Retornos

Define as permissões de arquivo em um caminho.

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Parâmetros

Retornos

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

function toDirectoryClient(): DataLakeDirectoryClient

Retornos

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

function toFileClient(): DataLakeFileClient

Retornos

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

Consulte https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parâmetros

Retornos