Freigeben über

ShareServiceClient class

  • Referenz
Paket:
@azure/storage-file-share

Ein ShareServiceClient stellt eine URL zum Azure Storage-Dateidienst dar, mit der Sie Dateifreigaben bearbeiten können.

Extends

StorageClient

Konstruktoren

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Erstellt eine Instanz von ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Erstellt eine Instanz von ShareServiceClient.

Geerbte Eigenschaften

accountName
url

URL-Zeichenfolgenwert.

Methoden

createShare(string, ShareCreateOptions)

Erstellt eine Freigabe.
deleteShare(string, ShareDeleteMethodOptions)

Löscht eine Freigabe.
fromConnectionString(string, ShareClientOptions)

Erstellt eine Instanz von ShareServiceClient aus der Verbindungszeichenfolge.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur verfügbar für ShareServiceClient, 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.
getProperties(ServiceGetPropertiesOptions)

Ruft die Eigenschaften des Dateidiensts 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-file-service-properties.
getShareClient(string)

Erstellt ein ShareClient-Objekt.
listShares(ServiceListSharesOptions)

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

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

Beispiel für die Verwendung von for await Syntax:

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

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

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

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

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)

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

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.

Details zum Konstruktor

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Erstellt eine Instanz von ShareServiceClient.

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

Parameter

url

string

Eine URL-Zeichenfolge, die auf den Azure Storage-Dateidienst verweist, z. B. "https://myaccount.file.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.file.core.windows.net?sasString"".

credential

Credential | TokenCredential

Z. B. AnonymousCredential, StorageSharedKeyCredential oder TokenCredential: Wenn nicht angegeben, wird AnonymousCredential verwendet.

options
ShareClientOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Erstellt eine Instanz von ShareServiceClient.

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

Parameter

url

string

Eine URL-Zeichenfolge, die auf den Azure Storage-Dateidienst verweist, z. B. "https://myaccount.file.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.file.core.windows.net?sasString"".

pipeline
Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

options
ShareClientConfig

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Geerbte Eigenschaftsdetails

accountName 

accountName: string

Eigenschaftswert

string

Geerbt von StorageClient.accountName

url

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt von StorageClient.url

Details zur Methode

createShare(string, ShareCreateOptions)

Erstellt eine Freigabe.

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

Parameter

shareName

string

options
ShareCreateOptions

Gibt zurück

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

Freigabeerstellungsantwort und den entsprechenden Freigabeclient.

deleteShare(string, ShareDeleteMethodOptions)

Löscht eine Freigabe.

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

Parameter

shareName

string

options
ShareDeleteMethodOptions

Gibt zurück

Promise<ShareDeleteResponse>

Teilen Sie die Löschantwort und den entsprechenden Freigabeclient.

fromConnectionString(string, ShareClientOptions)

Erstellt eine Instanz von ShareServiceClient aus der Verbindungszeichenfolge.

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

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis : Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: 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

Optionen zum Konfigurieren der HTTP-Pipeline.

Gibt zurück

ShareServiceClient

Ein neuer ShareServiceClient aus der angegebenen Verbindungszeichenfolge.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur verfügbar für ShareServiceClient, 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

expiresOn

Date

Optional. Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Wenn nicht angegeben, wird standardmäßig eine Stunde später festgelegt.

permissions
AccountSASPermissions

Gibt die Liste der Berechtigungen an, die der SAS zugeordnet werden sollen.

resourceTypes

string

Gibt die Ressourcentypen an, die der Freigegebenen Zugriffssignatur zugeordnet sind.

options
ServiceGenerateAccountSasUrlOptions

Optionale Parameter.

Gibt zurück

string

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

getProperties(ServiceGetPropertiesOptions)

Ruft die Eigenschaften des Dateidiensts 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-file-service-properties.

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

Parameter

options
ServiceGetPropertiesOptions

Optionen zum Vorgang "Eigenschaften abrufen".

Gibt zurück

Promise<ServiceGetPropertiesResponse>

Antwortdaten für den Vorgang Eigenschaften abrufen.

getShareClient(string)

Erstellt ein ShareClient-Objekt.

function getShareClient(shareName: string): ShareClient

Parameter

shareName

string

Name einer Freigabe.

Gibt zurück

ShareClient

Das ShareClient-Objekt für den angegebenen Freigabenamen.

Beispielverwendung:

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

listShares(ServiceListSharesOptions)

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

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

Beispiel für die Verwendung von for await Syntax:

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

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

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

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

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>

Parameter

options
ServiceListSharesOptions

Optionen zum Auflisten von Freigaben.

Ein asyncIterableIterator, der Paging unterstützt.

Gibt zurück

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties.

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

Parameter

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Optionen zum Festlegen des Eigenschaftenvorgangs.

Gibt zurück

Promise<ServiceSetPropertiesResponse>

Antwortdaten für den Vorgang Eigenschaften festlegen.

undeleteShare(string, string, ServiceUndeleteShareOptions)

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

deletedShareName

string

Der Name der zuvor gelöschten Freigabe.

deletedShareVersion

string

Die Version der zuvor gelöschten Freigabe.

options
ServiceUndeleteShareOptions

Optionen zum Rückgängigmachen des Freigabevorgangs.

Gibt zurück

Promise<ShareClient>

Freigabe wiederhergestellt.