Dela via

ShareServiceClient class

Paket:
@azure/storage-file-share

En ShareServiceClient representerar en URL till Azure Storage File-tjänsten så att du kan ändra filresurser.

Sträcker sig

StorageClient

Konstruktörer

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Skapar en instans av ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Skapar en instans av ShareServiceClient.

Ärvda egenskaper

accountName
url

URL-strängvärde.

Metoder

createShare(string, ShareCreateOptions)

Skapar en resurs.
deleteShare(string, ShareDeleteMethodOptions)

Tar bort en resurs.
fromConnectionString(string, ShareClientOptions)

Skapar en instans av ShareServiceClient från anslutningssträngen.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för ShareServiceClient som skapats med en delad nyckelautentiseringsuppgifter.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för ShareServiceClient som skapats med en delad nyckelautentiseringsuppgifter.

Genererar sträng för att signera för ett konto med signatur för delad åtkomst (SAS) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos filtjänst, inklusive egenskaper för lagringsanalys och CORS-regler (resursdelning mellan ursprung).

Se https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties
getShareClient(string)

Skapar ett ShareClient-objekt.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ENDAST TILLGÄNGLIGT VID ANVÄNDNING AV BÄRARTOKENAUTENTISERING (TokenCredential).

Hämtar en användardelegeringsnyckel för filtjänsten. Detta är endast en giltig operation vid användning av bärartokenautentisering.

Se https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listShares(ServiceListSharesOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa alla resurser under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att visa en lista över resurser på sidor.

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

Exempel med 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());
}

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

Exempel med växling med en markör:

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}`);
}
setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Anger egenskaper för ett lagringskontos filtjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning mellan ursprung) och inställningar för mjuk borttagning.

Se https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

Återställer en tidigare borttagen resurs. Det här API:et fungerar bara om Mjuk borttagning av resurs är aktiverat för lagringskontot som är associerat med resursen.

Konstruktördetaljer

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Skapar en instans av ShareServiceClient.

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

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-filtjänsten, till exempel "https://myaccount.file.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller TokenCredential, Om det inte anges används AnonymousCredential.

options
ShareClientOptions

Optional. Alternativ för att konfigurera HTTP-pipelinen.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Skapar en instans av ShareServiceClient.

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

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-filtjänsten, till exempel "https://myaccount.file.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

options
ShareClientConfig

Optional. Alternativ för att konfigurera HTTP-pipelinen.

Ärvda fastigheter

accountName 

accountName: string

Fastighetsvärde

string

ärvd från StorageClient.accountName

url

URL-strängvärde.

url: string

Fastighetsvärde

string

ärvd från StorageClient.url

Metoddetaljer

createShare(string, ShareCreateOptions)

Skapar en resurs.

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

Parametrar

shareName

string

options
ShareCreateOptions

Returnerar

Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Svar på skapande av resurs och motsvarande resursklient.

deleteShare(string, ShareDeleteMethodOptions)

Tar bort en resurs.

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

Parametrar

shareName

string

options
ShareDeleteMethodOptions

Returnerar

Promise<ShareDeleteResponse>

Svar på delningsborttagning och motsvarande resursklient.

fromConnectionString(string, ShareClientOptions)

Skapar en instans av ShareServiceClient från anslutningssträngen.

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

Parametrar

connectionString

string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options
ShareClientOptions

Alternativ för att konfigurera HTTP-pipelinen.

Returnerar

ShareServiceClient

En ny ShareServiceClient från den angivna anslutningssträngen.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för ShareServiceClient som skapats med en delad nyckelautentiseringsuppgifter.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

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

Parametrar

expiresOn

Date

Optional. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returnerar

string

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för ShareServiceClient som skapats med en delad nyckelautentiseringsuppgifter.

Genererar sträng för att signera för ett konto med signatur för delad åtkomst (SAS) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

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

Parametrar

expiresOn

Date

Optional. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returnerar

string

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos filtjänst, inklusive egenskaper för lagringsanalys och CORS-regler (resursdelning mellan ursprung).

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

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

Parametrar

options
ServiceGetPropertiesOptions

Alternativ för att hämta egenskaper.

Returnerar

Promise<ServiceGetPropertiesResponse>

Svarsdata för åtgärden Hämta egenskaper.

getShareClient(string)

Skapar ett ShareClient-objekt.

function getShareClient(shareName: string): ShareClient

Parametrar

shareName

string

Namnet på en resurs.

Returnerar

ShareClient

ShareClient-objektet för det angivna resursnamnet.

Exempel på användning:

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ENDAST TILLGÄNGLIGT VID ANVÄNDNING AV BÄRARTOKENAUTENTISERING (TokenCredential).

Hämtar en användardelegeringsnyckel för filtjänsten. Detta är endast en giltig operation vid användning av bärartokenautentisering.

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

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

Parametrar

startsOn

Date

Starttiden för användardelegerings-SAS. Måste vara inom 7 dagar från nuvarande tid

expiresOn

Date

Sluttiden för användardelegeringen SAS. Måste vara inom 7 dagar från nuvarande tid

options
ServiceGetUserDelegationKeyOptions

Returnerar

Promise<ServiceGetUserDelegationKeyResponse>

listShares(ServiceListSharesOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa alla resurser under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att visa en lista över resurser på sidor.

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

Exempel med 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());
}

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

Exempel med växling med en markör:

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>

Parametrar

options
ServiceListSharesOptions

Alternativ för att lista resursåtgärd.

En asyncIterableIterator som stöder växling.

Returnerar

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Anger egenskaper för ett lagringskontos filtjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning mellan ursprung) och inställningar för mjuk borttagning.

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

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

Parametrar

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Alternativ för att ange egenskaper.

Returnerar

Promise<ServiceSetPropertiesResponse>

Svarsdata för åtgärden Ange egenskaper.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Återställer en tidigare borttagen resurs. Det här API:et fungerar bara om Mjuk borttagning av resurs är aktiverat för lagringskontot som är associerat med resursen.

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

Parametrar

deletedShareName

string

Namnet på den tidigare borttagna resursen.

deletedShareVersion

string

Versionen av den tidigare borttagna resursen.

options
ServiceUndeleteShareOptions

Alternativ för att dela oborttagningsåtgärd.

Returnerar

Promise<ShareClient>

Återställd resurs.