ShareServiceClient class

Crea una instancia de ShareServiceClient.

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

Parámetros

Crea una instancia de ShareServiceClient.

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

Parámetros

accountName: string

Valor de propiedad

Heredado de StorageClient.accountName

Valor de cadena de dirección URL.

url: string

Valor de propiedad

se hereda de StorageClient.url

Crea un recurso compartido.

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

Parámetros

Devoluciones

Respuesta de creación de recursos compartidos y el cliente de recurso compartido correspondiente.

Elimina un recurso compartido.

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

Parámetros

Devoluciones

Respuesta de eliminación de recursos compartidos y el cliente de recurso compartido correspondiente.

Crea una instancia de ShareServiceClient a partir de la cadena de conexión.

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

Parámetros

Devoluciones

Nuevo ShareServiceClient de la cadena de conexión especificada.

Solo está disponible para ShareServiceClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de cuenta basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Consulte https://v4.hkg1.meaqua.org/rest/api/storageservices/create-account-sas

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

Parámetros

Devoluciones

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

Solo está disponible para ShareServiceClient construido con una credencial de clave compartida.

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de cuenta en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Consulte https://v4.hkg1.meaqua.org/rest/api/storageservices/create-account-sas

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

Parámetros

Devoluciones

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

Obtiene las propiedades del servicio de archivos de una cuenta de almacenamiento, incluidas las propiedades de las reglas De uso compartido de recursos entre orígenes y Análisis de Storage.

Consulte https://v4.hkg1.meaqua.org/rest/api/storageservices/get-file-service-properties

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

Parámetros

Devoluciones

Datos de respuesta para la operación Obtener propiedades.

Crea un objeto ShareClient.

function getShareClient(shareName: string): ShareClient

Parámetros

Devoluciones

Objeto ShareClient para el nombre de recurso compartido especificado.

Uso de ejemplo:

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

Devuelve un iterador asincrónico para enumerar todos los recursos compartidos de la cuenta especificada.

.byPage() devuelve un iterador asincrónico para enumerar los recursos compartidos en páginas.

Ejemplo de uso de la sintaxis de for await:

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

Ejemplo de uso de 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());
}

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

Ejemplo de uso de paginación con un marcador:

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>

Parámetros

Devoluciones

Establece propiedades para el punto de conexión de servicio de archivos de una cuenta de almacenamiento, incluidas las propiedades para las reglas de Storage Analytics, CORS (uso compartido de recursos entre orígenes) y la configuración de eliminación temporal.

Consulte https://v4.hkg1.meaqua.org/rest/api/storageservices/set-file-service-properties

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

Parámetros

Devoluciones

Datos de respuesta para la operación Establecer propiedades.

Restaura un recurso compartido eliminado anteriormente. Esta API solo es funcional si la eliminación temporal de recursos compartidos está habilitada para la cuenta de almacenamiento asociada al recurso compartido.

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

Parámetros

Devoluciones

Acción restaurada.