Compartilhar via

ShareServiceClient class

Pacote:
@azure/storage-file-share

Um ShareServiceClient representa uma URL para o serviço de Arquivo de Armazenamento do Azure, permitindo que você manipule compartilhamentos de arquivos.

Extends

StorageClient

Construtores

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Cria uma instância do ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)

Cria uma instância do ShareServiceClient.

Propriedades herdadas

accountName
url

Valor da cadeia de caracteres de URL.

Métodos

createShare(string, ShareCreateOptions)

Cria um compartilhamento.
deleteShare(string, ShareDeleteMethodOptions)

Exclui um compartilhamento.
fromConnectionString(string, ShareClientOptions)

Cria uma instância do ShareServiceClient da cadeia de conexão.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para ShareServiceClient construído com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado) de conta com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Consulte https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para ShareServiceClient construído com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado) de conta com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Consulte https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do serviço de arquivo de uma conta de armazenamento, incluindo propriedades para as regras de Análise de Armazenamento e CORS (Compartilhamento de Recursos entre Origens).

Consulte https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties
getShareClient(string)

Cria um objeto ShareClient.
listShares(ServiceListSharesOptions)

Retorna um iterador iterável assíncrono para listar todos os compartilhamentos na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os compartilhamentos em páginas.

Exemplo usando for await sintaxe:

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

Exemplo usando 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());
}

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

Exemplo usando a paginação com um 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}`);
}
setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço de arquivo de uma conta de armazenamento, incluindo propriedades para análise de armazenamento, regras CORS (compartilhamento de recursos entre origens) e configurações de exclusão reversível.

Consulte https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

Restaura um compartilhamento excluído anteriormente. Essa API só estará funcional se o Share Soft Delete estiver habilitado para a conta de armazenamento associada ao compartilhamento.

Detalhes do construtor

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

Cria uma instância do ShareServiceClient.

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

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para o serviço de arquivo do Armazenamento do Azure, como "https://myaccount.file.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.file.core.windows.net?sasString".

credential

Credential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou TokenCredential, se não especificado, AnonymousCredential é usado.

options
ShareClientOptions

Optional. Opções para configurar o pipeline HTTP.

ShareServiceClient(string, Pipeline, ShareClientConfig)

Cria uma instância do ShareServiceClient.

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

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para o serviço de arquivo do Armazenamento do Azure, como "https://myaccount.file.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.file.core.windows.net?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

options
ShareClientConfig

Optional. Opções para configurar o pipeline HTTP.

Detalhes das propriedades herdadas

accountName 

accountName: string

Valor da propriedade

string

herdado de StorageClient.accountName

url

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

herdado de StorageClient.url

Detalhes do método

createShare(string, ShareCreateOptions)

Cria um compartilhamento.

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

Parâmetros

shareName

string

options
ShareCreateOptions

Retornos

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

Compartilhar a resposta de criação e o cliente de compartilhamento correspondente.

deleteShare(string, ShareDeleteMethodOptions)

Exclui um compartilhamento.

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

Parâmetros

shareName

string

options
ShareDeleteMethodOptions

Retornos

Promise<ShareDeleteResponse>

Resposta de exclusão de compartilhamento e o cliente de compartilhamento correspondente.

fromConnectionString(string, ShareClientOptions)

Cria uma instância do ShareServiceClient da cadeia de conexão.

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

Parâmetros

connectionString

string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão da conta – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net exemplo de cadeia de conexão SAS – 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

Opções para configurar o pipeline HTTP.

Retornos

ShareServiceClient

Um novo ShareServiceClient da cadeia de conexão fornecida.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para ShareServiceClient construído com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado) de conta com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

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

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

Parâmetros

expiresOn

Date

Optional. O momento em que a assinatura de acesso compartilhado se torna inválida. Padrão para uma hora depois, se não especificado.

permissions
AccountSASPermissions

Especifica a lista de permissões a serem associadas à SAS.

resourceTypes

string

Especifica os tipos de recurso associados à assinatura de acesso compartilhado.

options
ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Retornos

string

Um URI SAS de conta que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para ShareServiceClient construído com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado) de conta com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

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

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

Parâmetros

expiresOn

Date

Optional. O momento em que a assinatura de acesso compartilhado se torna inválida. Padrão para uma hora depois, se não especificado.

permissions
AccountSASPermissions

Especifica a lista de permissões a serem associadas à SAS.

resourceTypes

string

Especifica os tipos de recurso associados à assinatura de acesso compartilhado.

options
ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Retornos

string

Um URI SAS de conta que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do serviço de arquivo de uma conta de armazenamento, incluindo propriedades para as regras de Análise de Armazenamento e CORS (Compartilhamento de Recursos entre Origens).

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

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

Parâmetros

options
ServiceGetPropertiesOptions

Opções para obter a operação Propriedades.

Retornos

Promise<ServiceGetPropertiesResponse>

Dados de resposta para a operação Obter Propriedades.

getShareClient(string)

Cria um objeto ShareClient.

function getShareClient(shareName: string): ShareClient

Parâmetros

shareName

string

Nome de um compartilhamento.

Retornos

ShareClient

O objeto ShareClient para o nome de compartilhamento fornecido.

Exemplo de uso:

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

listShares(ServiceListSharesOptions)

Retorna um iterador iterável assíncrono para listar todos os compartilhamentos na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os compartilhamentos em páginas.

Exemplo usando for await sintaxe:

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

Exemplo usando 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());
}

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

Exemplo usando a paginação com um 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

options
ServiceListSharesOptions

Opções para listar a operação de compartilhamentos.

Um asyncIterableIterator que dá suporte à paginação.

Retornos

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço de arquivo de uma conta de armazenamento, incluindo propriedades para análise de armazenamento, regras CORS (compartilhamento de recursos entre origens) e configurações de exclusão reversível.

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

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

Parâmetros

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Opções para definir a operação Propriedades.

Retornos

Promise<ServiceSetPropertiesResponse>

Dados de resposta para a operação Definir Propriedades.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Restaura um compartilhamento excluído anteriormente. Essa API só estará funcional se o Share Soft Delete estiver habilitado para a conta de armazenamento associada ao compartilhamento.

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

Parâmetros

deletedShareName

string

O nome do compartilhamento excluído anteriormente.

deletedShareVersion

string

A versão do compartilhamento excluído anteriormente.

options
ServiceUndeleteShareOptions

Opções para compartilhar a operação undelete.

Retornos

Promise<ShareClient>

Compartilhamento restaurado.