Condividi tramite

ShareServiceClient class

  • Riferimento
Pacchetto:
@azure/storage-file-share

Un oggetto ShareServiceClient rappresenta un URL del servizio file di archiviazione di Azure che consente di modificare le condivisioni file.

Extends

StorageClient

Costruttori

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Crea un'istanza di ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Crea un'istanza di ShareServiceClient.

Proprietà ereditate

accountName
url

Valore stringa URL.

Metodi

createShare(string, ShareCreateOptions)

Crea una condivisione.
deleteShare(string, ShareDeleteMethodOptions)

Elimina una condivisione.
fromConnectionString(string, ShareClientOptions)

Crea un'istanza di ShareServiceClient dalla stringa di connessione.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per ShareServiceClient costruito con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà del servizio file di un account di archiviazione, incluse le proprietà per le regole di analisi archiviazione e CORS (condivisione di risorse tra le origini).

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties
getShareClient(string)

Crea un oggetto ShareClient.
listShares(ServiceListSharesOptions)

Restituisce un iteratore iteratore iterabile asincrono per elencare tutte le condivisioni nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare le condivisioni nelle pagine.

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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)

Imposta le proprietà per l'endpoint di servizio file di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

Ripristina una condivisione eliminata in precedenza. Questa API è funzionante solo se l'opzione Condividi eliminazione temporanea è abilitata per l'account di archiviazione associato alla condivisione.

Dettagli costruttore

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Crea un'istanza di ShareServiceClient.

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

Parametri

url

string

Stringa URL che punta al servizio file di Archiviazione di Azure, ad esempio "https://myaccount.file.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o TokenCredential, se non specificato, viene usato AnonymousCredential.

options
ShareClientOptions

facoltativo. Opzioni per configurare la pipeline HTTP.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Crea un'istanza di ShareServiceClient.

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

Parametri

url

string

Stringa URL che punta al servizio file di Archiviazione di Azure, ad esempio "https://myaccount.file.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

options
ShareClientConfig

facoltativo. Opzioni per configurare la pipeline HTTP.

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

url

Valore stringa URL.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

createShare(string, ShareCreateOptions)

Crea una condivisione.

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

Parametri

shareName

string

options
ShareCreateOptions

Restituisce

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

Condividere la risposta di creazione e il client di condivisione corrispondente.

deleteShare(string, ShareDeleteMethodOptions)

Elimina una condivisione.

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

Parametri

shareName

string

options
ShareDeleteMethodOptions

Restituisce

Promise<ShareDeleteResponse>

Condividere la risposta di eliminazione e il client di condivisione corrispondente.

fromConnectionString(string, ShareClientOptions)

Crea un'istanza di ShareServiceClient dalla stringa di connessione.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione di firma di accesso condiviso - 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

Opzioni per configurare la pipeline HTTP.

Restituisce

ShareServiceClient

Nuovo ShareServiceClient dalla stringa di connessione specificata.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per ShareServiceClient costruito con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parametri

expiresOn

Date

facoltativo. Ora in cui la firma di accesso condiviso non è valida. Se non specificato, il valore predefinito è un'ora successiva.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorse associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà del servizio file di un account di archiviazione, incluse le proprietà per le regole di analisi archiviazione e CORS (condivisione di risorse tra le origini).

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties

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

Parametri

options
ServiceGetPropertiesOptions

Opzioni per ottenere l'operazione Proprietà.

Restituisce

Promise<ServiceGetPropertiesResponse>

Dati di risposta per l'operazione Get Properties.

getShareClient(string)

Crea un oggetto ShareClient.

function getShareClient(shareName: string): ShareClient

Parametri

shareName

string

Nome di una condivisione.

Restituisce

ShareClient

Oggetto ShareClient per il nome della condivisione specificato.

Esempio di utilizzo:

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

listShares(ServiceListSharesOptions)

Restituisce un iteratore iteratore iterabile asincrono per elencare tutte le condivisioni nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare le condivisioni nelle pagine.

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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>

Parametri

options
ServiceListSharesOptions

Opzioni per elencare le condivisioni.

AsyncIterableIterator che supporta il paging.

Restituisce

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Imposta le proprietà per l'endpoint di servizio file di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties

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

Parametri

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Opzioni per impostare l'operazione Proprietà.

Restituisce

Promise<ServiceSetPropertiesResponse>

Dati di risposta per l'operazione Imposta proprietà.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Ripristina una condivisione eliminata in precedenza. Questa API è funzionante solo se l'opzione Condividi eliminazione temporanea è abilitata per l'account di archiviazione associato alla condivisione.

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

Parametri

deletedShareName

string

Nome della condivisione eliminata in precedenza.

deletedShareVersion

string

Versione della condivisione eliminata in precedenza.

options
ServiceUndeleteShareOptions

Opzioni per condividere l'operazione di annullamento dell'eliminazione.

Restituisce

Promise<ShareClient>

Condivisione ripristinata.