ShareServiceClient class

Hiermee maakt u een exemplaar van ShareServiceClient.

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

Parameters

Hiermee maakt u een exemplaar van ShareServiceClient.

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

Parameters

accountName: string

Waarde van eigenschap

overgenomen van StorageClient.accountName

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

overgenomen van StorageClient.url

Hiermee maakt u een share.

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

Parameters

Retouren

Antwoord voor het maken van delen en de bijbehorende shareclient.

Hiermee verwijdert u een share.

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

Parameters

Retouren

Antwoord op verwijdering delen en de bijbehorende shareclient.

Hiermee maakt u een exemplaar van ShareServiceClient op basis van de verbindingsreeks.

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

Parameters

Retouren

Een nieuwe ShareServiceClient van de opgegeven verbindingsreeks.

Alleen beschikbaar voor ShareServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een SAS-URI (Shared Access Signature) gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

Retouren

Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Alleen beschikbaar voor ShareServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een tekenreeks voor aanmelding voor een SAS-URI (Shared Access Signature) van een account op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

Retouren

Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee haalt u de eigenschappen op van de bestandsservice van een opslagaccount, inclusief eigenschappen voor regels voor Opslaganalyse en CORS (Cross-Origin Resource Sharing).

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

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Eigenschappen ophalen.

Hiermee maakt u een ShareClient-object.

function getShareClient(shareName: string): ShareClient

Parameters

Retouren

Het ShareClient-object voor de opgegeven sharenaam.

Voorbeeldgebruik:

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

ALLEEN BESCHIKBAAR BIJ GEBRUIK VAN BEARER TOKEN-AUTHENTICATIE (TokenCredential).

Haalt een gebruikersdelegatiesleutel op voor de bestandsservice. Dit is alleen een geldige operatie bij gebruik van bearer token-authenticatie.

Zie https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

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

Parameters

Retouren

Retourneert een asynchrone iterator om alle shares onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de shares in pagina's weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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());
}

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

Voorbeeld van het gebruik van paging met een markering:

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>

Parameters

Retouren

Hiermee stelt u eigenschappen in voor het service-eindpunt van een opslagaccount, waaronder eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

Zie https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Eigenschappen instellen.

Hiermee herstelt u een eerder verwijderde share. Deze API is alleen functioneel als Voorlopig verwijderen delen is ingeschakeld voor het opslagaccount dat is gekoppeld aan de share.

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

Parameters

Retouren

Hersteld aandeel.