DataLakeServiceClient class
O DataLakeServiceClient permite manipular os recursos e sistemas de arquivos do serviço Azure Data Lake. A conta de armazenamento fornece o namespace de nível superior para o serviço Data Lake.
- Extends
-
StorageClient
Construtores
Data |
Cria uma instância de DataLakeServiceClient a partir de url e pipeline. |
Data |
Cria uma instância de DataLakeServiceClient a partir de url. |
Propriedades Herdadas
account |
|
credential | Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote |
url | Valor da cadeia de caracteres de URL codificada. |
Métodos
from |
Cria uma instância de DataLakeServiceClient a partir da cadeia de conexão. |
generate |
Disponível apenas para DataLakeServiceClient construído com uma credencial de chave compartilhada. Gera um URI de Assinatura de Acesso Compartilhado (SAS) de conta 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/create-account-sas |
generate |
Disponível apenas para DataLakeServiceClient construído com uma credencial de chave compartilhada. Gera cadeia de caracteres para assinar uma conta Assinatura de Acesso Compartilhado (SAS) com base nas propriedades do cliente e parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
Cria um objeto DataLakeFileSystemClient. |
get |
Obtém as propriedades do ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Cross-Origin Resource Sharing). Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
DISPONÍVEL SOMENTE AO USAR A AUTENTICAÇÃO DE TOKEN DE PORTADOR (TokenCredential). Recupera uma chave de delegação de usuário para o serviço Data Lake. Esta é apenas uma operação válida ao usar a autenticação de token de portador. Exemplo
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Retorna um iterador iterável assíncrono para listar todos os sistemas de arquivos na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os sistemas de arquivos 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/en-us/rest/api/storageservices/list-containers2 |
set |
Define propriedades para o ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Cross-Origin Resource Sharing) e configurações de exclusão suave. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Restaure um sistema de arquivos excluído anteriormente. Essa API só será funcional se o Container Soft Delete estiver habilitado para a conta de armazenamento. |
Detalhes do Construtor
DataLakeServiceClient(string, Pipeline)
Cria uma instância de DataLakeServiceClient a partir de url e pipeline.
new DataLakeServiceClient(url: string, pipeline: Pipeline)
Parâmetros
- url
-
string
Uma cadeia de caracteres de cliente apontando para o serviço de data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net?sasString".
- pipeline
- Pipeline
Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de DataLakeServiceClient a partir de url.
new DataLakeServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parâmetros
- url
-
string
Uma cadeia de caracteres de cliente apontando para o serviço de data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net?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 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
fromConnectionString(string, StoragePipelineOptions)
Cria uma instância de DataLakeServiceClient a partir da cadeia de conexão.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient
Parâmetros
- connectionString
-
string
Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure.
[ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS tempo de execução. ] Exemplo de cadeia de conexão de conta -
DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
exemplo de cadeia de conexão SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
Devoluções
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Disponível apenas para DataLakeServiceClient construído com uma credencial de chave compartilhada.
Gera um URI de Assinatura de Acesso Compartilhado (SAS) de conta 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/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parâmetros
- expiresOn
-
Date
Opcional. O momento em que a assinatura de acesso compartilhado se torna inválida. O padrão é uma hora depois, se não for especificado.
- permissions
- AccountSASPermissions
Especifica a lista de permissões a serem associadas ao SAS.
- resourceTypes
-
string
Especifica os tipos de recursos associados à assinatura de acesso compartilhado.
Parâmetros opcionais.
Devoluções
string
Um URI SAS de conta que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Disponível apenas para DataLakeServiceClient construído com uma credencial de chave compartilhada.
Gera cadeia de caracteres para assinar uma conta Assinatura de Acesso Compartilhado (SAS) com base nas propriedades do cliente e parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parâmetros
- expiresOn
-
Date
Opcional. O momento em que a assinatura de acesso compartilhado se torna inválida. O padrão é uma hora depois, se não for especificado.
- permissions
- AccountSASPermissions
Especifica a lista de permissões a serem associadas ao SAS.
- resourceTypes
-
string
Especifica os tipos de recursos associados à assinatura de acesso compartilhado.
Parâmetros opcionais.
Devoluções
string
Um URI SAS de conta que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.
getFileSystemClient(string)
Cria um objeto DataLakeFileSystemClient.
function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient
Parâmetros
- fileSystemName
-
string
Nome do sistema de arquivos.
Devoluções
getProperties(ServiceGetPropertiesOptions)
Obtém as propriedades do ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Cross-Origin Resource Sharing).
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parâmetros
- options
- ServiceGetPropertiesOptions
Opções para a operação Obter propriedades do serviço.
Devoluções
Promise<DataLakeServiceGetPropertiesResponse>
Dados de resposta para a operação Service Get Properties.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
DISPONÍVEL SOMENTE AO USAR A AUTENTICAÇÃO DE TOKEN DE PORTADOR (TokenCredential).
Recupera uma chave de delegação de usuário para o serviço Data Lake. Esta é apenas uma operação válida ao usar a autenticação de token de portador.
Exemplo
// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
fileSystemName, // Required
permissions: FileSystemSASPermissions.parse("racwdl"), // Required
startsOn, // Required. Date type
expiresOn, // Optional. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
},
userDelegationKey, // UserDelegationKey
accountName
).toString();
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parâmetros
- startsOn
-
Date
A hora de início para a SAS de delegação de usuário. Deve ser dentro de 7 dias da hora atual.
- expiresOn
-
Date
A hora de término da SAS de delegação de usuário. Deve ser dentro de 7 dias da hora atual.
Devoluções
Promise<ServiceGetUserDelegationKeyResponse>
listFileSystems(ServiceListFileSystemsOptions)
Retorna um iterador iterável assíncrono para listar todos os sistemas de arquivos na conta especificada.
.byPage() retorna um iterador iterável assíncrono para listar os sistemas de arquivos nas páginas.
Exemplo usando sintaxe for await
:
let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}
Exemplo usando iter.next()
:
let i = 1;
const iter = serviceClient.listFileSystems();
let fileSystemItem = await iter.next();
while (!fileSystemItem.done) {
console.log(`FileSystem ${i++}: ${fileSystemItem.value.name}`);
fileSystemItem = await iter.next();
}
Exemplo usando byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
if (response.fileSystemItems) {
for (const fileSystem of response.fileSystemItems) {
console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}
}
}
Exemplo de utilização da paginação com um marcador:
let i = 1;
let iterator = serviceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 file system names
if (response.fileSystemItems) {
for (const fileSystem of response.fileSystemItems) {
console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = serviceClient
.listContainers()
.byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 file system names
if (response.fileSystemItems) {
for (const fileSystem of response.fileSystemItems) {
console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}
}
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2
function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>
Parâmetros
- options
- ServiceListFileSystemsOptions
Devoluções
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Define propriedades para o ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Cross-Origin Resource Sharing) e configurações de exclusão suave.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parâmetros
- properties
- DataLakeServiceProperties
- options
- ServiceSetPropertiesOptions
Opções para a operação Propriedades do conjunto de serviços.
Devoluções
Promise<ServiceSetPropertiesResponse>
Dados de resposta para a operação Propriedades do conjunto de serviços.
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)
Restaure um sistema de arquivos excluído anteriormente. Essa API só será funcional se o Container Soft Delete estiver habilitado para a conta de armazenamento.
function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>
Parâmetros
- deletedFileSystemName
-
string
O nome do sistema de arquivos de origem.
- deleteFileSystemVersion
-
string
O novo nome do sistema de arquivos.
- options
- ServiceUndeleteFileSystemOptions
Opções para configurar a operação de restauração do sistema de arquivos.
Devoluções
Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>