ShareServiceClient class

Referência

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_2 \| 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 de ShareServiceClient da cadeia de conexão.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)	Disponível somente 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. Veja https://docs.microsoft.com/en-us/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). Veja https://docs.microsoft.com/en-us/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` a sintaxe: let i = 1; for await (const share of serviceClient.listShares()) { console.log(`Share ${i++}: ${share.name}`); } Exemplo usando `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 usando `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 usando 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}`); } }
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)	Restaura um compartilhamento excluído anteriormente. Essa API só será funcional se a Exclusão Reversível de Compartilhamento estiver habilitada para a conta de armazenamento associada ao compartilhamento.

Detalhes do construtor

Cria uma instância do ShareServiceClient.

new ShareServiceClient(url: string, credential?: Credential_2 | 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 for especificado, AnonymousCredential será usado.

options: ShareClientOptions

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

Cria uma instância do ShareServiceClient.

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

Parâmetros

url: string

pipeline: Pipeline

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

options: ShareClientConfig

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

Detalhes das propriedades herdadas

accountName: string

Valor da propriedade

string

Herdado de StorageClient.accountName

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Herdado de StorageClient.url

Detalhes do método

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.

Exclui um compartilhamento.

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

Parâmetros

shareName: string

options: ShareDeleteMethodOptions

Retornos

Promise<ShareDeleteResponse>

Compartilhar a resposta de exclusão e o cliente de compartilhamento correspondente.

Cria uma instância de 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 de 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.

Disponível somente 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.

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

expiresOn: Date

Opcional. A hora em que a assinatura de acesso compartilhado se torna inválida. O padrão será uma hora depois, se não for especificado.

permissions: AccountSASPermissions

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

resourceTypes: string

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

options: ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Retornos

string

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

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).

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

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

Parâmetros

options: ServiceGetPropertiesOptions

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

Retornos

Promise<ServiceGetPropertiesResponse>

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

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:

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

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 a sintaxe:

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

Exemplo usando 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 usando 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 usando 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

options: ServiceListSharesOptions

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

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

Retornos

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

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.

Veja https://docs.microsoft.com/en-us/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.

Restaura um compartilhamento excluído anteriormente. Essa API só será funcional se a Exclusão Reversível de Compartilhamento estiver habilitada 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 operação de cancelamento de exclusão.

Retornos

Promise<ShareClient>

Compartilhamento restaurado.

Compartilhar via

ShareServiceClient class

Construtores

Propriedades herdadas

Métodos

Detalhes do construtor

Parâmetros

Parâmetros

Detalhes das propriedades herdadas

Valor da propriedade

Valor da propriedade

Detalhes do método

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Parâmetros

Retornos

Recursos adicionais

Compartilhar via

ShareServiceClient class

Construtores

Propriedades herdadas

Métodos

Detalhes do construtor

ShareServiceClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parâmetros

ShareServiceClient(string, Pipeline, ShareClientConfig)

Parâmetros

Detalhes das propriedades herdadas

accountName

Valor da propriedade

url

Valor da propriedade

Detalhes do método

createShare(string, ShareCreateOptions)

Parâmetros

Retornos

deleteShare(string, ShareDeleteMethodOptions)

Parâmetros

Retornos

fromConnectionString(string, ShareClientOptions)

Parâmetros

Retornos

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Parâmetros

Retornos

getProperties(ServiceGetPropertiesOptions)

Parâmetros

Retornos

getShareClient(string)

Parâmetros

Retornos

listShares(ServiceListSharesOptions)

Parâmetros

Retornos

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Parâmetros

Retornos

undeleteShare(string, string, ServiceUndeleteShareOptions)

Parâmetros

Retornos

Recursos adicionais