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 de ShareServiceClient.
ShareServiceClient(string, Pipeline, ShareClientConfig)	Cria uma instância de 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 a partir 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 Assinatura de Acesso Compartilhado (SAS) de conta com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente. Visualizar https://docs.microsoft.com/en-us/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 Assinatura de Acesso Compartilhado (SAS) de conta com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)	Obtém as propriedades do serviço de arquivos de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Compartilhamento de Recursos entre Origens). Visualizar 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 nas páginas. Exemplo usando sintaxe `for await`: 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 de utilização da 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 (Cross-Origin Resource Sharing) e configurações de exclusão suave. Visualizar 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 o Share Soft Delete estiver habilitado para a conta de armazenamento associada ao compartilhamento.

Detalhes do Construtor

Cria uma instância de 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 de 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 da Propriedade Herdada

accountName: string

Valor de Propriedade

string

herdado de StorageClient.accountName

Valor da cadeia de caracteres de URL.

url: string

Valor de Propriedade

string

herdado de StorageClient.url

Detalhes de Método

Cria um compartilhamento.

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

Parâmetros

shareName: string

options: ShareCreateOptions

Devoluções

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

Resposta de criação de compartilhamento e o cliente de compartilhamento correspondente.

Exclui um compartilhamento.

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

Parâmetros

shareName: string

options: ShareDeleteMethodOptions

Devoluções

Promise<ShareDeleteResponse>

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

Cria uma instância de ShareServiceClient a partir 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 tempo de execução. ] 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.

Devoluções

ShareServiceClient

Um novo ShareServiceClient da cadeia de conexão fornecida.

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

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

Visualizar 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. O momento em que a assinatura de acesso compartilhado se torna inválida. O padrão é uma hora depois, se não for especificado.

permissions: AccountSASPermissions

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

resourceTypes: string

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

options: ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Devoluções

string

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

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

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

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

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

Parâmetros

expiresOn: Date

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

permissions: AccountSASPermissions

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

resourceTypes: string

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

options: ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Devoluções

string

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

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

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

Devoluções

Promise<ServiceGetPropertiesResponse>

Dados de resposta para a operação Get Properties.

Cria um objeto ShareClient.

function getShareClient(shareName: string): ShareClient

Parâmetros

shareName: string

Nome de uma ação.

Devoluções

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 nas páginas.

Exemplo usando sintaxe for await:

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 de utilização da 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ções de operação.

Um asyncIterableIterator que suporta paginação.

Devoluções

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 (Cross-Origin Resource Sharing) e configurações de exclusão suave.

Visualizar 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 a operação Definir propriedades.

Devoluções

Promise<ServiceSetPropertiesResponse>

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

Restaura um compartilhamento excluído anteriormente. Essa API só será 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 de undelete.

Devoluções

Promise<ShareClient>

Compartilhamento restaurado.

Partilhar via

ShareServiceClient class

Construtores

Propriedades Herdadas

Métodos

Detalhes do Construtor

Parâmetros

Parâmetros

Detalhes da Propriedade Herdada

Valor de Propriedade

Valor de Propriedade

Detalhes de Método

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Parâmetros

Devoluções

Recursos adicionais

Partilhar 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 da Propriedade Herdada

accountName

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

createShare(string, ShareCreateOptions)

Parâmetros

Devoluções

deleteShare(string, ShareDeleteMethodOptions)

Parâmetros

Devoluções

fromConnectionString(string, ShareClientOptions)

Parâmetros

Devoluções

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Parâmetros

Devoluções

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Parâmetros

Devoluções

getProperties(ServiceGetPropertiesOptions)

Parâmetros

Devoluções

getShareClient(string)

Parâmetros

Devoluções

listShares(ServiceListSharesOptions)

Parâmetros

Devoluções

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Parâmetros

Devoluções

undeleteShare(string, string, ServiceUndeleteShareOptions)

Parâmetros

Devoluções

Recursos adicionais