DataLakeServiceClient class

Crea una instancia de DataLakeServiceClient a partir de la dirección URL y la canalización.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parámetros

Crea una instancia de DataLakeServiceClient a partir de la dirección URL.

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

Parámetros

accountName: string

Valor de propiedad

Heredado de StorageClient.accountName

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de propiedad

heredado de StorageClient.credential

Valor de cadena de dirección URL codificada.

url: string

Valor de propiedad

se hereda de StorageClient.url

Crea una instancia de DataLakeServiceClient a partir de la cadena de conexión.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient

Parámetros

Devoluciones

Solo está disponible para DataLakeServiceClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de cuenta basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parámetros

Devoluciones

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

Solo está disponible para DataLakeServiceClient construido con una credencial de clave compartida.

Genera una cadena para firmar una firma de acceso compartido (SAS) de cuenta basada en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parámetros

Devoluciones

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

Crea un objeto DataLakeFileSystemClient.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parámetros

Devoluciones

Obtiene las propiedades del punto de conexión de Blob service de una cuenta de almacenamiento, incluidas las propiedades de las reglas de Uso compartido de recursos entre orígenes y análisis de Storage.

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties.

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parámetros

Devoluciones

Datos de respuesta para la operación Obtener propiedades del servicio.

SOLO ESTÁ DISPONIBLE CUANDO SE USA LA AUTENTICACIÓN DE TOKEN DE PORTADOR (TokenCredential).

Recupera una clave de delegación de usuarios para el servicio Data Lake. Solo se trata de una operación válida cuando se usa la autenticación de token de portador.

Ejemplo

// 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();

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parámetros

Devoluciones

Devuelve un iterador iterable asincrónico para enumerar todos los sistemas de archivos de la cuenta especificada.

.byPage() devuelve un iterador asincrónico para enumerar los sistemas de archivos de las páginas.

Ejemplo de uso de la sintaxis de for await:

let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
  console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}

Ejemplo de uso de 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();
}

Ejemplo de uso de 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}`);
    }
  }
}

Ejemplo de uso de paginación con un 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}`);
  }
}

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2.

function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

Parámetros

Devoluciones

Establece las propiedades para el punto de conexión de Blob Service de una cuenta de almacenamiento, incluidas las propiedades para las reglas de Storage Analytics, CORS (uso compartido de recursos entre orígenes) y la configuración de eliminación temporal.

Vea https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties.

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parámetros

Devoluciones

Datos de respuesta para la operación Propiedades del conjunto de servicios.

Restaure un sistema de archivos eliminado anteriormente. Esta API solo es funcional si la eliminación temporal del contenedor está habilitada para la cuenta de almacenamiento.

function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>

Parámetros

Devoluciones