Compartilhar via

QueueServiceClient class

Pacote:
@azure/storage-queue

Um QueueServiceClient representa uma URL para o serviço Fila de Armazenamento do Azure, permitindo que você manipule 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 caracteres de URL.

Métodos

createQueue(string, QueueCreateOptions)

Cria uma nova fila na conta especificada.

Consulte https://learn.microsoft.com/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Exclui a fila especificada permanentemente.

Consulte https://learn.microsoft.com/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 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 QueueServiceClient 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 Fila 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-queue-service-properties
getQueueClient(string)

Cria um objeto QueueClient.
getStatistics(ServiceGetStatisticsOptions)

Recupera estatísticas relacionadas à replicação para o serviço Fila. Ele só está disponível no ponto de extremidade de local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta de armazenamento.

Consulte https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONÍVEL APENAS QUANDO SE UTILIZA AUTENTICAÇÃO DE TOKEN PORTADOR (TokenCredential).

Recupera uma chave de delegação de usuário para o serviço de fila. Essa operação só é válida quando se utiliza autenticação de token portador.

Consulte https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listQueues(ServiceListQueuesOptions)

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

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

Exemplo usando for await sintaxe:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

Exemplo usando iter.next():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

Exemplo usando byPage():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  for (const item of page.queueItems || []) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

Exemplo usando a paginação com um marcador:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço Fila 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-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 caracteres de URL apontando para o serviço de fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline padrão 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 caracteres de URL apontando para o serviço de fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Exemplo usando DefaultAzureCredential de @azure/identity:

import { DefaultAzureCredential } from "@azure/identity";
import { QueueServiceClient } from "@azure/storage-queue";

const account = "<account>";
const credential = new DefaultAzureCredential();

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

Exemplo usando um nome/chave de conta:

import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";

// Enter your storage account name and shared key
const account = "<account>";
const accountKey = "<accountkey>";

// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);

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

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

createQueue(string, QueueCreateOptions)

Cria uma nova fila na conta especificada.

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

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

Parâmetros

queueName

string

nome da fila a ser criada

options
QueueCreateOptions

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

Retornos

Promise<QueueCreateResponse>

Dados de resposta para a operação de criação de fila.

deleteQueue(string, QueueDeleteOptions)

Exclui a fila especificada permanentemente.

Consulte https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Parâmetros

queueName

string

nome da fila a ser excluída.

options
QueueDeleteOptions

Opções para a operação de exclusão de fila.

Retornos

Promise<QueueDeleteResponse>

Dados de resposta para a operação de exclusão de fila.

fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de QueueServiceClient.

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

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
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Retornos

QueueServiceClient

Um novo objeto QueueServiceClient da cadeia de conexão fornecida.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para QueueServiceClient 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 QueueServiceClient 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 Fila 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-queue-service-properties

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

Parâmetros

options
ServiceGetPropertiesOptions

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

Retornos

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

Retornos

QueueClient

um novo QueueClient

Exemplo de uso:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

getStatistics(ServiceGetStatisticsOptions)

Recupera estatísticas relacionadas à replicação para o serviço Fila. Ele só está disponível no ponto de extremidade de local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta de armazenamento.

Consulte https://learn.microsoft.com/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.

Retornos

Promise<ServiceGetStatisticsResponse>

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONÍVEL APENAS QUANDO SE UTILIZA AUTENTICAÇÃO DE TOKEN PORTADOR (TokenCredential).

Recupera uma chave de delegação de usuário para o serviço de fila. Essa operação só é válida quando se utiliza autenticação de token portador.

Consulte https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parâmetros

startsOn

Date

O horário de início do SAS de delegação do usuário. Deve estar dentro de 7 dias do horário atual

expiresOn

Date

O tempo de fim para o SAS de delegação de usuários. Deve estar dentro de 7 dias do horário atual

options
ServiceGetUserDelegationKeyOptions

Retornos

Promise<ServiceGetUserDelegationKeyResponse>

listQueues(ServiceListQueuesOptions)

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

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

Exemplo usando for await sintaxe:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

Exemplo usando iter.next():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

Exemplo usando byPage():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  for (const item of page.queueItems || []) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

Exemplo usando a paginação com um marcador:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

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

Parâmetros

options
ServiceListQueuesOptions

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

Retornos

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

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

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço Fila 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-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.

Retornos

Promise<ServiceSetPropertiesResponse>

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