ShareServiceClient class

Cria uma instância do ShareServiceClient.

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

Parâmetros

Cria uma instância do ShareServiceClient.

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

Parâmetros

accountName: string

Valor de Propriedade

Herdado de StorageClient.accountName

Valor da cadeia de URL.

url: string

Valor de Propriedade

Herdado de StorageClient.url

Cria uma Partilha.

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

Parâmetros

Devoluções

Partilhe a resposta de criação e o cliente de partilha correspondente.

Elimina uma Partilha.

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

Parâmetros

Devoluções

Partilhe a resposta de eliminação e o cliente de partilha correspondente.

Cria uma instância do ShareServiceClient a partir da cadeia de ligação.

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

Parâmetros

Devoluções

Um novo ShareServiceClient da cadeia de ligação especificada.

Apenas disponível para ShareServiceClient construído com uma credencial de chave partilhada.

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

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

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

Parâmetros

Devoluções

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

Obtém as propriedades do serviço de ficheiros de uma conta de armazenamento, incluindo propriedades para a Análise de Armazenamento e regras CORS (Partilha de Recursos de Várias Origens).

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

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

Parâmetros

Devoluções

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

Cria um objeto ShareClient.

function getShareClient(shareName: string): ShareClient

Parâmetros

Devoluções

O objeto ShareClient para o nome da partilha especificado.

Utilização de exemplo:

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

Devolve um iterador iterável assíncrono para listar todas as partilhas na conta especificada.

.byPage() devolve um iterador iterável assíncrono para listar as partilhas em páginas.

Exemplo com for await sintaxe:

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

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

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

Exemplo com a paginação com um marcador:

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>

Parâmetros

Devoluções

Define propriedades para o ponto final de serviço de ficheiros de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Partilha de Recursos Transversais à Origem) e definições de eliminação recuperável.

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

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

Parâmetros

Devoluções

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

Restaura uma partilha eliminada anteriormente. Esta API só funciona se a opção Partilhar Eliminação Recuperável estiver ativada para a conta de armazenamento associada à partilha.

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

Parâmetros

Devoluções

Partilha restaurada.