DataLakeFileSystemClient class
Um DataLakeFileSystemClient representa uma URL para o sistema de arquivos do Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.
- Extends
-
StorageClient
Construtores
Data |
Cria uma instância de DataLakeFileSystemClient a partir de url e pipeline. |
Data |
Cria uma instância de DataLakeFileSystemClient a partir de url e credencial. |
Propriedades
name | Nome do sistema de arquivos atual. |
Propriedades Herdadas
account |
|
credential | Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote |
url | Valor da cadeia de caracteres de URL codificada. |
Métodos
create(File |
Cria um novo sistema de arquivos na conta especificada. Se o sistema de arquivos com o mesmo nome já existir, a operação falhará. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
create |
Cria um novo sistema de arquivos na conta especificada. Se o sistema de arquivos com o mesmo nome já existir, ele não será alterado. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete(File |
Exclua o sistema de arquivos atual. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
delete |
Exclua o sistema de arquivos atual, se ele existir. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
exists(File |
Retorna true se o sistema de arquivos representado por este cliente existir; falso caso contrário. NOTA: utilize esta função com cuidado, uma vez que um sistema de ficheiros existente pode ser eliminado por outros clientes ou aplicações. Vice-versa, um novo sistema de arquivos com o mesmo nome pode ser adicionado por outros clientes ou aplicativos após a conclusão dessa função. |
generate |
Disponível apenas para DataLakeFileSystemClient construído com uma credencial de chave compartilhada. Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
generate |
Disponível apenas para DataLakeFileSystemClient construído 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
generate |
Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela chave de delegação do usuário de entrada. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
generate |
Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. A SAS é assinada pela chave de delegação do usuário de entrada. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Obtém as permissões para o sistema de arquivos especificado. As permissões indicam se os dados do sistema de arquivos podem ser acessados publicamente. AVISO: JavaScript Date perderá potencialmente a precisão ao analisar startsOn e expiresOn strings. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z". Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl |
get |
Obtenha um DataLakeLeaseClient que gerencia concessões no sistema de arquivos. |
get |
Cria um objeto DataLakeDirectoryClient no sistema de arquivos atual. |
get |
Cria um objeto DataLakeFileClient no sistema de arquivos atual. |
get |
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o sistema de arquivos especificado. AVISO: O objeto Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties |
list |
Retorna um iterador iterável assíncrono para listar todos os caminhos (diretórios e arquivos) no sistema de arquivos especificado. .byPage() retorna um iterador iterável assíncrono para listar os caminhos nas páginas. Exemplo usando sintaxe
Exemplo usando
Exemplo usando
Exemplo de utilização da paginação com um marcador:
Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs |
list |
Retorna um iterador iterável assíncrono para listar todos os caminhos (diretórios e arquivos) no sistema de arquivos especificado. .byPage() retorna um iterador iterável assíncrono para listar os caminhos nas páginas. Exemplo usando sintaxe
Exemplo usando
Exemplo usando
Exemplo de utilização da paginação com um marcador:
Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs |
set |
Define as permissões para o sistema de arquivos especificado. As permissões indicam se diretórios ou arquivos em um sistema de arquivos podem ser acessados publicamente. Quando você define permissões para um sistema de arquivos, as permissões existentes são substituídas. Se nenhum acesso ou containerAcl fornecido, a ACL do sistema de arquivos existente será removida. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl |
set |
Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado. Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do sistema de arquivos serão removidos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata |
undelete |
Restaura um caminho excluído suavemente. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
Detalhes do Construtor
DataLakeFileSystemClient(string, Pipeline)
Cria uma instância de DataLakeFileSystemClient a partir de url e pipeline.
new DataLakeFileSystemClient(url: string, pipeline: Pipeline)
Parâmetros
- url
-
string
Uma cadeia de caracteres Client apontando para o sistema de arquivos data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".
- pipeline
- Pipeline
Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de DataLakeFileSystemClient a partir de url e credencial.
new DataLakeFileSystemClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parâmetros
- url
-
string
Uma cadeia de caracteres Client apontando para o sistema de arquivos data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?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
name
Nome do sistema de arquivos atual.
string name
Valor de Propriedade
string
Detalhes da Propriedade Herdada
accountName
accountName: string
Valor de Propriedade
string
herdado de StorageClient.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 de Propriedade
herdado de StorageClient.credential
url
Valor da cadeia de caracteres de URL codificada.
url: string
Valor de Propriedade
string
herdado de StorageClient.url
Detalhes de Método
create(FileSystemCreateOptions)
Cria um novo sistema de arquivos na conta especificada. Se o sistema de arquivos com o mesmo nome já existir, a operação falhará.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>
Parâmetros
- options
- FileSystemCreateOptions
Opcional. Opções ao criar o sistema de arquivos.
Devoluções
Promise<FileSystemCreateResponse>
createIfNotExists(FileSystemCreateOptions)
Cria um novo sistema de arquivos na conta especificada. Se o sistema de arquivos com o mesmo nome já existir, ele não será alterado.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>
Parâmetros
- options
- FileSystemCreateOptions
Devoluções
Promise<FileSystemCreateIfNotExistsResponse>
delete(FileSystemDeleteOptions)
Exclua o sistema de arquivos atual.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>
Parâmetros
- options
- FileSystemDeleteOptions
Opcional. Opções ao excluir o sistema de arquivos.
Devoluções
Promise<FileSystemDeleteResponse>
deleteIfExists(FileSystemDeleteOptions)
Exclua o sistema de arquivos atual, se ele existir.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>
Parâmetros
- options
- FileSystemDeleteOptions
Devoluções
Promise<FileSystemDeleteIfExistsResponse>
exists(FileSystemExistsOptions)
Retorna true se o sistema de arquivos representado por este cliente existir; falso caso contrário.
NOTA: utilize esta função com cuidado, uma vez que um sistema de ficheiros existente pode ser eliminado por outros clientes ou aplicações. Vice-versa, um novo sistema de arquivos com o mesmo nome pode ser adicionado por outros clientes ou aplicativos após a conclusão dessa função.
function exists(options?: FileSystemExistsOptions): Promise<boolean>
Parâmetros
- options
- FileSystemExistsOptions
Devoluções
Promise<boolean>
generateSasStringToSign(FileSystemGenerateSasUrlOptions)
Disponível apenas para DataLakeFileSystemClient construído com uma credencial de chave compartilhada.
Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string
Parâmetros
- options
- FileSystemGenerateSasUrlOptions
Parâmetros opcionais.
Devoluções
string
O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.
generateSasUrl(FileSystemGenerateSasUrlOptions)
Disponível apenas para DataLakeFileSystemClient construído 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise<string>
Parâmetros
- options
- FileSystemGenerateSasUrlOptions
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.
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)
Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela chave de delegação do usuário de entrada.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
Parâmetros
- options
- FileSystemGenerateSasUrlOptions
Parâmetros opcionais.
- userDelegationKey
- UserDelegationKey
Valor de retorno de blobServiceClient.getUserDelegationKey()
Devoluções
string
O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)
Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. A SAS é assinada pela chave de delegação do usuário de entrada.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>
Parâmetros
- options
- FileSystemGenerateSasUrlOptions
Parâmetros opcionais.
- userDelegationKey
- UserDelegationKey
Valor de retorno de blobServiceClient.getUserDelegationKey()
Devoluções
Promise<string>
O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.
getAccessPolicy(FileSystemGetAccessPolicyOptions)
Obtém as permissões para o sistema de arquivos especificado. As permissões indicam se os dados do sistema de arquivos podem ser acessados publicamente.
AVISO: JavaScript Date perderá potencialmente a precisão ao analisar startsOn e expiresOn strings. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>
Parâmetros
- options
- FileSystemGetAccessPolicyOptions
Opcional. Opções ao obter a política de acesso ao sistema de arquivos.
Devoluções
Promise<FileSystemGetAccessPolicyResponse>
getDataLakeLeaseClient(string)
Obtenha um DataLakeLeaseClient que gerencia concessões no sistema de arquivos.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parâmetros
- proposeLeaseId
-
string
Opcional. Proposta inicial de arrendamento Id.
Devoluções
getDirectoryClient(string)
Cria um objeto DataLakeDirectoryClient no sistema de arquivos atual.
function getDirectoryClient(directoryName: string): DataLakeDirectoryClient
Parâmetros
- directoryName
-
string
Devoluções
getFileClient(string)
Cria um objeto DataLakeFileClient no sistema de arquivos atual.
function getFileClient(fileName: string): DataLakeFileClient
Parâmetros
- fileName
-
string
Devoluções
getProperties(FileSystemGetPropertiesOptions)
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o sistema de arquivos especificado.
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 pelo método listFileSystems
de DataLakeServiceClient usando a opção includeMetadata
, que manterá seu invólucro original.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>
Parâmetros
- options
- FileSystemGetPropertiesOptions
Opcional. Opções ao obter propriedades do sistema de arquivos.
Devoluções
Promise<FileSystemGetPropertiesResponse>
listDeletedPaths(ListDeletedPathsOptions)
Retorna um iterador iterável assíncrono para listar todos os caminhos (diretórios e arquivos) no sistema de arquivos especificado.
.byPage() retorna um iterador iterável assíncrono para listar os caminhos nas páginas.
Exemplo usando sintaxe for await
:
// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
Exemplo usando iter.next()
:
let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
pathItem = await iter.next();
}
Exemplo usando byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
for (const deletePath of response.pathItems) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
}
Exemplo de utilização da paginação com um marcador:
let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs
function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>
Parâmetros
- options
- ListDeletedPathsOptions
Opcional. Opções ao listar caminhos excluídos.
Devoluções
listPaths(ListPathsOptions)
Retorna um iterador iterável assíncrono para listar todos os caminhos (diretórios e arquivos) no sistema de arquivos especificado.
.byPage() retorna um iterador iterável assíncrono para listar os caminhos nas páginas.
Exemplo usando sintaxe for await
:
// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
Exemplo usando iter.next()
:
let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
pathItem = await iter.next();
}
Exemplo usando byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
}
Exemplo de utilização da paginação com um marcador:
let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs
function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>
Parâmetros
- options
- ListPathsOptions
Opcional. Opções ao listar caminhos.
Devoluções
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)
Define as permissões para o sistema de arquivos especificado. As permissões indicam se diretórios ou arquivos em um sistema de arquivos podem ser acessados publicamente.
Quando você define permissões para um sistema de arquivos, as permissões existentes são substituídas. Se nenhum acesso ou containerAcl fornecido, a ACL do sistema de arquivos existente será removida.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>
Parâmetros
- access
- PublicAccessType
Opcional. O nível de acesso público aos dados no sistema de arquivos.
- fileSystemAcl
Opcional. Matriz de elementos, cada um com um ID exclusivo e detalhes da política de acesso.
- options
- FileSystemSetAccessPolicyOptions
Opcional. Opções ao definir a política de acesso ao sistema de arquivos.
Devoluções
Promise<FileSystemSetAccessPolicyResponse>
setMetadata(Metadata, FileSystemSetMetadataOptions)
Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado.
Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do sistema de arquivos serão removidos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>
Parâmetros
- metadata
- Metadata
Substitua os metadados existentes por esse valor. Se nenhum valor for fornecido, os metadados existentes serão removidos.
- options
- FileSystemSetMetadataOptions
Opcional. Opções ao definir metadados do sistema de arquivos.
Devoluções
Promise<FileSystemSetMetadataResponse>
undeletePath(string, string, FileSystemUndeletePathOption)
Restaura um caminho excluído suavemente.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>
Parâmetros
- deletedPath
-
string
Necessário. O caminho do caminho excluído.
- deletionId
-
string
Necessário. O ID de exclusão associado ao caminho excluído suavemente.
- options
- FileSystemUndeletePathOption
Devoluções
Promise<FileSystemUndeletePathResponse>