ShareServiceClient class

Crée une instance de ShareServiceClient.

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

Paramètres

Crée une instance de ShareServiceClient.

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

Paramètres

accountName: string

Valeur de propriété

héritée de StorageClient.accountName

Valeur de chaîne d’URL.

url: string

Valeur de propriété

héritée de StorageClient.url

Crée un partage.

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

Paramètres

Retours

Réponse de création de partage et client de partage correspondant.

Supprime un partage.

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

Paramètres

Retours

Réponse de suppression de partage et client de partage correspondant.

Crée une instance de ShareServiceClient à partir de la chaîne de connexion.

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

Paramètres

Retours

Nouveau ShareServiceClient à partir de la chaîne de connexion donnée.

Disponible uniquement pour ShareServiceClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de compte basé sur les propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

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

Paramètres

Retours

URI SAP de compte constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Disponible uniquement pour ShareServiceClient construit avec des informations d’identification de clé partagée.

Génère une chaîne pour signer un URI de signature d’accès partagé (SAP) de compte en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

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

Paramètres

Retours

URI SAP de compte constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Obtient les propriétés du service de fichiers d’un compte de stockage, y compris les propriétés des règles Storage Analytics et CORS (partage de ressources cross-origin).

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

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

Paramètres

Retours

Données de réponse pour l’opération Get Properties.

Crée un objet ShareClient.

function getShareClient(shareName: string): ShareClient

Paramètres

Retours

Objet ShareClient pour le nom de partage donné.

Exemple d’utilisation :

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

Retourne un itérateur itérable asynchrone pour répertorier tous les partages sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les partages dans les pages.

Exemple utilisant for await syntaxe :

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

Exemple utilisant 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());
}

Exemple utilisant 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}`);
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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>

Paramètres

Retours

Définit les propriétés du point de terminaison de service de fichier d’un compte de stockage, y compris les propriétés des règles Storage Analytics, CORS (partage de ressources cross-origin) et les paramètres de suppression réversible.

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

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

Paramètres

Retours

Données de réponse pour l’opération Définir les propriétés.

Restaure un partage précédemment supprimé. Cette API est fonctionnelle uniquement si la suppression réversible de partage est activée pour le compte de stockage associé au partage.

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

Paramètres

Retours

Partage restauré.