Partilhar via

QueueServiceClient class

  • Referência
Pacote:
@azure/storage-queue

Um QueueServiceClient representa um URL para o serviço Fila de Armazenamento do Azure que lhe permite manipular filas.

Extends

StorageClient

Construtores

QueueServiceClient(string, Pipeline)

Cria uma instância de QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de QueueServiceClient.

Propriedades Herdadas

accountName
url

Valor da cadeia de URL.

Métodos

createQueue(string, QueueCreateOptions)

Cria uma nova fila na conta especificada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Elimina permanentemente a fila especificada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para QueueServiceClient 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
getProperties(ServiceGetPropertiesOptions)

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

Cria um objeto QueueClient .
getStatistics(ServiceGetStatisticsOptions)

Obtém estatísticas relacionadas com a replicação do serviço Fila. Só está disponível no ponto final de localização secundária quando a replicação georredundante com acesso de leitura está ativada para a conta de armazenamento.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
listQueues(ServiceListQueuesOptions)

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

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

Exemplo com for await sintaxe:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

Exemplo com iter.next():

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${item.value.name}`);
  i++;
  item = await iterator.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Define propriedades para o ponto final de serviço Fila 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-queue-service-properties

Detalhes do Construtor

QueueServiceClient(string, Pipeline)

Cria uma instância de QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de URL que aponta para o serviço de fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de QueueServiceClient.

new QueueServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url

string

Uma cadeia de URL que aponta para o serviço de fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Exemplo com DefaultAzureCredential a partir de @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  credential
}

Exemplo com um nome/chave de conta:

const account = "<account>";

const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
  }
);

Detalhes da Propriedade Herdada

accountName 

accountName: string

Valor de Propriedade

string

Herdado de StorageClient.accountName

url

Valor da cadeia de URL.

url: string

Valor de Propriedade

string

Herdado de StorageClient.url

Detalhes de Método

createQueue(string, QueueCreateOptions)

Cria uma nova fila na conta especificada.

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

function createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>

Parâmetros

queueName

string

nome da fila a criar

options
QueueCreateOptions

Opções para a operação de criação de filas.

Devoluções

Promise<QueueCreateResponse>

Dados de resposta para a operação de criação da Fila.

deleteQueue(string, QueueDeleteOptions)

Elimina permanentemente a fila especificada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

function deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

Parâmetros

queueName

string

nome da fila a eliminar.

options
QueueDeleteOptions

Opções para a operação de eliminação de filas.

Devoluções

Promise<QueueDeleteResponse>

Dados de resposta para a operação Eliminação de filas.

fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de QueueServiceClient.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): QueueServiceClient

Parâmetros

connectionString

string

Cadeia de ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - A cadeia de ligação de conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligaçã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
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Devoluções

QueueServiceClient

Um novo objeto QueueServiceClient da cadeia de ligação especificada.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para QueueServiceClient 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

expiresOn

Date

Opcional. O momento em que a assinatura de acesso partilhado se torna inválida. Predefinição para uma hora mais tarde, se não for especificado.

permissions
AccountSASPermissions

Especifica a lista de permissões a associar à SAS.

resourceTypes

string

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

options
ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Devoluções

string

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

getProperties(ServiceGetPropertiesOptions)

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

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

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

Parâmetros

options
ServiceGetPropertiesOptions

Opções para obter a operação de propriedades.

Devoluções

Promise<ServiceGetPropertiesResponse>

Dados de resposta, incluindo as propriedades do serviço de fila.

getQueueClient(string)

Cria um objeto QueueClient .

function getQueueClient(queueName: string): QueueClient

Parâmetros

queueName

string

Devoluções

QueueClient

um novo QueueClient

Utilização de exemplo: 

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

getStatistics(ServiceGetStatisticsOptions)

Obtém estatísticas relacionadas com a replicação do serviço Fila. Só está disponível no ponto final de localização secundária quando a replicação georredundante com acesso de leitura está ativada para a conta de armazenamento.

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

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

Parâmetros

options
ServiceGetStatisticsOptions

Opções para obter a operação de estatísticas.

Devoluções

Promise<ServiceGetStatisticsResponse>

Dados de resposta para obter estatísticas da operação.

listQueues(ServiceListQueuesOptions)

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

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

Exemplo com for await sintaxe:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

Exemplo com iter.next():

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${item.value.name}`);
  i++;
  item = await iterator.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}

function listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Parâmetros

options
ServiceListQueuesOptions

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

Devoluções

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Um asyncIterableIterator que suporta paginação.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Define propriedades para o ponto final de serviço Fila 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-queue-service-properties

function setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parâmetros

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Opções para definir a operação de propriedades.

Devoluções

Promise<ServiceSetPropertiesResponse>

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