Partilhar via

QueueServiceClient class

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

Um QueueServiceClient representa uma URL para o serviço de 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.

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

Exclui a fila especificada permanentemente.

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

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

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

Obtém as propriedades do serviço de fila de uma conta de armazenamento, incluindo propriedades para regras de análise de armazenamento e CORS (Cross-Origin Resource Sharing).

Veja https://docs.microsoft.com/en-us/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 de fila. Ele só está disponível no ponto de extremidade do local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta de armazenamento.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
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 sintaxe for await:

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

Exemplo usando 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 usando 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 de utilização da 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 de extremidade do serviço de fila 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.

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

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:

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 caracteres 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 ser criada

options
QueueCreateOptions

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

Devoluções

Promise<QueueCreateResponse>

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

deleteQueue(string, QueueDeleteOptions)

Exclui a fila especificada permanentemente.

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 ser excluída.

options
QueueDeleteOptions

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

Devoluções

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 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
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Devoluções

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

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

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

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

getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do serviço de fila de uma conta de armazenamento, incluindo propriedades para regras de análise de armazenamento e CORS (Cross-Origin Resource Sharing).

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 propriedades operacionais.

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

Exemplo de uso:

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

getStatistics(ServiceGetStatisticsOptions)

Recupera estatísticas relacionadas à replicação para o serviço de fila. Ele só está disponível no ponto de extremidade do local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada 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 operações estatísticas.

Devoluções

Promise<ServiceGetStatisticsResponse>

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

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 sintaxe for await:

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

Exemplo usando 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 usando 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 de utilização da 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 de extremidade do serviço de fila 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.

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.