ShareServiceClient class

Erstellt eine Instanz von ShareServiceClient.

new ShareServiceClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Parameter

Erstellt eine Instanz von ShareServiceClient.

new ShareServiceClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parameter

accountName: string

Eigenschaftswert

geerbt von StorageClient.accountName

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

geerbt von StorageClient.url

Erstellt eine Freigabe.

function createShare(shareName: string, options?: ShareCreateOptions): Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Parameter

Gibt zurück

Antwort auf die Freigabeerstellung und den entsprechenden Freigabeclient.

Löscht eine Freigabe.

function deleteShare(shareName: string, options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Parameter

Gibt zurück

Freigeben der Löschantwort und des entsprechenden Freigabeclients.

Erstellt eine Instanz von ShareServiceClient aus der Verbindungszeichenfolge.

static function fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient

Parameter

Gibt zurück

Ein neuer ShareServiceClient aus der angegebenen Verbindungszeichenfolge.

Nur für ShareServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parameter

Gibt zurück

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

Nur für ShareServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert eine Zeichenfolge zum Signieren für einen SAS-URI (Shared Access Signature), der auf den Clienteigenschaften und Parametern basiert, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parameter

Gibt zurück

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

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

Siehe https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties

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

Parameter

Gibt zurück

Antwortdaten für den Get Properties-Vorgang.

Erstellt ein ShareClient-Objekt.

function getShareClient(shareName: string): ShareClient

Parameter

Gibt zurück

Das ShareClient-Objekt für den angegebenen Freigabenamen.

Beispielverwendung:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const shareClient = serviceClient.getShareClient(shareName);
await shareClient.create();

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Freigaben unter dem angegebenen Konto auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Freigaben auf Seiten auflisten zu können.

Beispiel mit for await Syntax:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

Beispiel für die Verwendung von iter.next():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

Beispiel für die Verwendung von byPage():

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

Beispiel für das Paging mit einer Markierung:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken
iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

function listShares(options?: ServiceListSharesOptions): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

Parameter

Gibt zurück

Legt Eigenschaften für den Dateidienstendpunkt 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://learn.microsoft.com/rest/api/storageservices/set-file-service-properties

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Eigenschaften festlegen".

Stellt eine zuvor gelöschte Freigabe wieder her. Diese API ist nur funktionsfähig, wenn "Vorläufiges Löschen freigeben" für das Speicherkonto aktiviert ist, das der Freigabe zugeordnet ist.

function undeleteShare(deletedShareName: string, deletedShareVersion: string, options?: ServiceUndeleteShareOptions): Promise<ShareClient>

Parameter

Gibt zurück

Wiederhergestellte Freigabe.