Udostępnij za pośrednictwem

ShareServiceClient class

  • Odwołanie
Pakiet:
@azure/storage-file-share

Obiekt ShareServiceClient reprezentuje adres URL usługi Plików usługi Azure Storage, umożliwiając manipulowanie udziałami plików.

Rozszerzenie

StorageClient

Konstruktory

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Tworzy wystąpienie klasy ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Tworzy wystąpienie klasy ShareServiceClient.

Właściwości dziedziczone

accountName
url

Wartość ciągu adresu URL.

Metody

createShare(string, ShareCreateOptions)

Tworzy udział.
deleteShare(string, ShareDeleteMethodOptions)

Usuwa udział.
fromConnectionString(string, ShareClientOptions)

Tworzy wystąpienie klasy ShareServiceClient na podstawie parametrów połączenia.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Obiekt ShareServiceClient jest dostępny tylko przy użyciu poświadczeń klucza współdzielonego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

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

Pobiera właściwości usługi plików konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).

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

Tworzy obiekt ShareClient.
listShares(ServiceListSharesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich udziałów w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę udziałów na stronach.

Przykład użycia for await składni:

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

Przykład przy użyciu polecenia 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();
}

Przykład przy użyciu polecenia 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}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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)

Ustawia właściwości punktu końcowego usługi plików konta magazynu, w tym właściwości dla reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

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

Przywraca wcześniej usunięty udział. Ten interfejs API działa tylko wtedy, gdy dla konta magazynu skojarzonego z udziałem jest włączone udostępnianie usuwania nietrwałego.

Szczegóły konstruktora

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Tworzy wystąpienie klasy ShareServiceClient.

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

Parametry

url

string

Ciąg adresu URL wskazujący usługę plików usługi Azure Storage, taką jak "https://myaccount.file.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz funkcji AnonymousCredential, na przykład "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Na przykład AnonymousCredential, StorageSharedKeyCredential lub TokenCredential, Jeśli nie określono, jest używany parametr AnonymousCredential.

options
ShareClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Tworzy wystąpienie klasy ShareServiceClient.

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

Parametry

url

string

Ciąg adresu URL wskazujący usługę plików usługi Azure Storage, taką jak "https://myaccount.file.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz funkcji AnonymousCredential, na przykład "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Wywołaj metodę newPipeline() w celu utworzenia potoku domyślnego lub podaj dostosowany potok.

options
ShareClientConfig

Opcjonalny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości dziedziczonej

accountName 

accountName: string

Wartość właściwości

string

Dziedziczone z StorageClient.accountName

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Dziedziczone z StorageClient.url

Szczegóły metody

createShare(string, ShareCreateOptions)

Tworzy udział.

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

Parametry

shareName

string

options
ShareCreateOptions

Zwraca

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

Udostępnij odpowiedź na tworzenie i odpowiedni klient udziału.

deleteShare(string, ShareDeleteMethodOptions)

Usuwa udział.

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

Parametry

shareName

string

options
ShareDeleteMethodOptions

Zwraca

Promise<ShareDeleteResponse>

Udostępnij odpowiedź na usunięcie i odpowiedni klient udziału.

fromConnectionString(string, ShareClientOptions)

Tworzy wystąpienie klasy ShareServiceClient na podstawie parametrów połączenia.

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

Parametry

connectionString

string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Opcje konfigurowania potoku HTTP.

Zwraca

ShareServiceClient

Nowy element ShareServiceClient z podanych parametrów połączenia.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Obiekt ShareServiceClient jest dostępny tylko przy użyciu poświadczeń klucza współdzielonego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

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

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

Parametry

expiresOn

Date

Opcjonalny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna do godziny później, jeśli nie zostanie określona.

permissions
AccountSASPermissions

Określa listę uprawnień do skojarzenia z sygnaturą dostępu współdzielonego.

resourceTypes

string

Określa typy zasobów skojarzone z sygnaturą dostępu współdzielonego.

options
ServiceGenerateAccountSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getProperties(ServiceGetPropertiesOptions)

Pobiera właściwości usługi plików konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).

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

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

Parametry

options
ServiceGetPropertiesOptions

Opcje pobierania operacji właściwości.

Zwraca

Promise<ServiceGetPropertiesResponse>

Dane odpowiedzi dla operacji Pobierz właściwości.

getShareClient(string)

Tworzy obiekt ShareClient.

function getShareClient(shareName: string): ShareClient

Parametry

shareName

string

Nazwa udziału.

Zwraca

ShareClient

Obiekt ShareClient dla danej nazwy udziału.

Przykład użycia: 

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

listShares(ServiceListSharesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich udziałów w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę udziałów na stronach.

Przykład użycia for await składni:

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

Przykład przy użyciu polecenia 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();
}

Przykład przy użyciu polecenia 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}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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>

Parametry

options
ServiceListSharesOptions

Opcje wyświetlania listy operacji udziałów.

AsyncIterableIterator, który obsługuje stronicowanie.

Zwraca

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Ustawia właściwości punktu końcowego usługi plików konta magazynu, w tym właściwości dla reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

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

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

Parametry

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Opcje ustawiania operacji właściwości.

Zwraca

Promise<ServiceSetPropertiesResponse>

Dane odpowiedzi dla operacji Ustaw właściwości.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Przywraca wcześniej usunięty udział. Ten interfejs API działa tylko wtedy, gdy dla konta magazynu skojarzonego z udziałem jest włączone udostępnianie usuwania nietrwałego.

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

Parametry

deletedShareName

string

Nazwa wcześniej usuniętego udziału.

deletedShareVersion

string

Wersja wcześniej usuniętego udziału.

options
ServiceUndeleteShareOptions

Opcje udostępniania operacji cofania.

Zwraca

Promise<ShareClient>

Przywrócony udział.