DataLakeServiceClient class

Crea un'istanza di DataLakeServiceClient dall'URL e dalla pipeline.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametri

Crea un'istanza di DataLakeServiceClient dall'URL.

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

Parametri

accountName: string

Valore della proprietà

Ereditato da StorageClient.accountName

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del @azure/identity pacchetto per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene usata AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

Ereditato da StorageClient.credential

Valore stringa URL codificato.

url: string

Valore della proprietà

Ereditato da StorageClient.url

Crea un'istanza di DataLakeServiceClient dalla stringa di connessione.

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

Parametri

Restituisce

Disponibile solo per DataLakeServiceClient costruito con le credenziali delle chiavi condivise.

Genera un URI firma di accesso condiviso dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalla credenziale della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parametri

Restituisce

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Crea un oggetto DataLakeFileSystemClient .

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametri

Restituisce

Ottiene le proprietà dell'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (Condivisione risorse tra le origini).

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

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

Parametri

Restituisce

Dati di risposta per l'operazione Service Get Properties.

DISPONIBILE SOLO QUANDO SI USA L'AUTENTICAZIONE DEL TOKEN DI CONNESSIONE (TokenCredential).

Recupera una chiave di delega utente per il servizio Data Lake. Si tratta di un'operazione valida solo quando si usa l'autenticazione del token di connessione.

Esempio

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

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

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

Parametri

Restituisce

Restituisce un iteratore iteratore iterabile asincrono per elencare tutti i file system nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i file system nelle pagine.

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

Esempio con 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}`);
    }
  }
}

Esempio di uso del paging con un marcatore:

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2

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

Parametri

Restituisce

Imposta le proprietà per l'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione Proprietà set di servizi.

Ripristinare un file system eliminato in precedenza. Questa API è funzionante solo se l'eliminazione temporanea del contenitore è abilitata per l'account di archiviazione.

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

Parametri

Restituisce