Delen via

ShareServiceClient class

  • Referentie
Pakket:
@azure/storage-file-share

Een ShareServiceClient vertegenwoordigt een URL naar de Azure Storage File-service waarmee u bestandsshares kunt bewerken.

Uitbreiding

StorageClient

Constructors

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Hiermee maakt u een exemplaar van ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Hiermee maakt u een exemplaar van ShareServiceClient.

Overgenomen eigenschappen

accountName
url

URL-tekenreekswaarde.

Methoden

createShare(string, ShareCreateOptions)

Hiermee maakt u een share.
deleteShare(string, ShareDeleteMethodOptions)

Hiermee verwijdert u een share.
fromConnectionString(string, ShareClientOptions)

Hiermee maakt u een exemplaar van ShareServiceClient op basis van de verbindingsreeks.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

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/en-us/rest/api/storageservices/get-file-service-properties
getShareClient(string)

Hiermee maakt u een ShareClient-object.
listShares(ServiceListSharesOptions)

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:

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

Voorbeeld van iter.next():

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

Voorbeeld van byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  if (response.shareItems) {
   for (const share of response.shareItems) {
       console.log(`Share ${i++}: ${share.name}`);
    }
  }
}

Voorbeeld van het gebruik van paging met een markering:

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

// Prints 2 share names
if (response.shareItems) {
  for (const share of response.shareItems) {
    console.log(`Share ${i++}: ${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;

// Prints 10 share names
if (response.shareItems) {
  for (const share of response.shareItems) {
    console.log(`Share ${i++}: ${share.name}`);
  }
}
setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

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/en-us/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

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.

Constructordetails

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Hiermee maakt u een exemplaar van ShareServiceClient.

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

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-bestandsservice, zoals 'https://myaccount.file.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of TokenCredential, Indien niet opgegeven, wordt AnonymousCredential gebruikt.

options
ShareClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Hiermee maakt u een exemplaar van ShareServiceClient.

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

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-bestandsservice, zoals 'https://myaccount.file.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

options
ShareClientConfig

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

overgenomen van StorageClient.accountName

url

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen van StorageClient.url

Methodedetails

createShare(string, ShareCreateOptions)

Hiermee maakt u een share.

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

Parameters

shareName

string

options
ShareCreateOptions

Retouren

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

Antwoord voor het maken van delen en de bijbehorende shareclient.

deleteShare(string, ShareDeleteMethodOptions)

Hiermee verwijdert u een share.

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

Parameters

shareName

string

options
ShareDeleteMethodOptions

Retouren

Promise<ShareDeleteResponse>

Antwoord op verwijdering delen en de bijbehorende shareclient.

fromConnectionString(string, ShareClientOptions)

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

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

Parameters

connectionString

string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

Opties voor het configureren van de HTTP-pijplijn.

Retouren

ShareServiceClient

Een nieuwe ShareServiceClient van de opgegeven verbindingsreeks.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas

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

Parameters

expiresOn

Date

Facultatief. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard een uur later als dit niet is opgegeven.

permissions
AccountSASPermissions

Hiermee geeft u de lijst met machtigingen die aan de SAS moeten worden gekoppeld.

resourceTypes

string

Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

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

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas

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

Parameters

expiresOn

Date

Facultatief. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard een uur later als dit niet is opgegeven.

permissions
AccountSASPermissions

Hiermee geeft u de lijst met machtigingen die aan de SAS moeten worden gekoppeld.

resourceTypes

string

Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

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

getProperties(ServiceGetPropertiesOptions)

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/en-us/rest/api/storageservices/get-file-service-properties

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

Parameters

options
ServiceGetPropertiesOptions

Opties voor de bewerking Eigenschappen ophalen.

Retouren

Promise<ServiceGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen ophalen.

getShareClient(string)

Hiermee maakt u een ShareClient-object.

function getShareClient(shareName: string): ShareClient

Parameters

shareName

string

Naam van een share.

Retouren

ShareClient

Het ShareClient-object voor de opgegeven sharenaam.

Voorbeeldgebruik:

const shareClient = serviceClient.getShareClient("<share name>");
await shareClient.create();
console.log("Created share successfully!");

listShares(ServiceListSharesOptions)

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:

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

Voorbeeld van iter.next():

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

Voorbeeld van byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  if (response.shareItems) {
   for (const share of response.shareItems) {
       console.log(`Share ${i++}: ${share.name}`);
    }
  }
}

Voorbeeld van het gebruik van paging met een markering:

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

// Prints 2 share names
if (response.shareItems) {
  for (const share of response.shareItems) {
    console.log(`Share ${i++}: ${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;

// Prints 10 share names
if (response.shareItems) {
  for (const share of response.shareItems) {
    console.log(`Share ${i++}: ${share.name}`);
  }
}

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

Parameters

options
ServiceListSharesOptions

Opties voor het weergeven van shares.

Een asyncIterableIterator die paging ondersteunt.

Retouren

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

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/en-us/rest/api/storageservices/set-file-service-properties

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

Parameters

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Opties voor het instellen van de bewerking Eigenschappen.

Retouren

Promise<ServiceSetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen instellen.

undeleteShare(string, string, ServiceUndeleteShareOptions)

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

deletedShareName

string

De naam van de eerder verwijderde share.

deletedShareVersion

string

De versie van de eerder verwijderde share.

options
ServiceUndeleteShareOptions

Opties voor het ongedaan maken van de verwijderingsbewerking delen.

Retouren

Promise<ShareClient>

Herstelde share.