DataLakeServiceClient class

Erstellt eine Instanz von DataLakeServiceClient aus URL und Pipeline.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von DataLakeServiceClient aus der URL.

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

Parameter

accountName: string

Eigenschaftswert

Geerbt von StorageClient.accountName

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Geerbt von StorageClient.credential

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

Geerbt von StorageClient.url

Erstellt eine Instanz von DataLakeServiceClient aus der Verbindungszeichenfolge.

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

Parameter

Gibt zurück

Nur verfügbar für DataLakeServiceClient, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) für das Konto basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

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

Parameter

Gibt zurück

Ein KONTO-SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt von dem generierten SAS-Token.

Erstellt ein DataLakeFileSystemClient-Objekt .

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parameter

Gibt zurück

Ruft die Eigenschaften des Blobdienstendpunkts eines Speicherkontos ab, einschließlich Eigenschaften für Storage Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang Diensteigenschaften abrufen.

NUR VERFÜGBAR, WENN BEARER TOKEN AUTHENTICATION (TokenCredential) VERWENDET WIRD.

Ruft einen Benutzerdelegierungsschlüssel für den Data Lake-Dienst ab. Dies ist nur ein gültiger Vorgang, wenn die Bearertokenauthentifizierung verwendet wird.

Beispiel

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

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

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

Parameter

Gibt zurück

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Dateisysteme unter dem angegebenen Konto aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Dateisysteme auf Seiten aufzulisten.

Beispiel für die Verwendung von for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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}`);
    }
  }
}

Beispiel für die Verwendung von Paging mit einem Marker:

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

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

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

Parameter

Gibt zurück

Legt Eigenschaften für den Blobdienstendpunkt eines Speicherkontos fest, einschließlich Eigenschaften für Storage Analytics, CORS-Regeln (Cross-Origin Resource Sharing) und Einstellungen für vorläufiges Löschen.

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

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

Parameter

Gibt zurück

Antwortdaten für den Dienstsatzeigenschaften-Vorgang.

Stellen Sie ein zuvor gelöschtes Dateisystem wieder her. Diese API ist nur funktionsfähig, wenn das vorläufige Löschen von Container für das Speicherkonto aktiviert ist.

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

Parameter

Gibt zurück