Compartir a través de

QueueServiceClient class

  • Referencia
Paquete:
@azure/storage-queue

QueueServiceClient representa una dirección URL al servicio de colas de Azure Storage que le permite manipular colas.

Extends

StorageClient

Constructores

QueueServiceClient(string, Pipeline)

Crea una instancia de QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea una instancia de QueueServiceClient.

Propiedades heredadas

accountName
url

Valor de cadena de dirección URL.

Métodos

createQueue(string, QueueCreateOptions)

Crea una nueva cola en la cuenta especificada.

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

Elimina la cola especificada de forma permanente.

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

Crea una instancia de QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Solo está disponible para QueueServiceClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de cuenta basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Solo está disponible para QueueServiceClient construido con una credencial de clave compartida.

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de cuenta en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

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

Obtiene las propiedades de queue service de una cuenta de almacenamiento, incluidas las propiedades de las reglas De uso compartido de recursos entre orígenes y Análisis de Storage.

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

Crea un objeto QueueClient.
getStatistics(ServiceGetStatisticsOptions)

Recupera estadísticas relacionadas con la replicación de Queue Service. Solo está disponible en el punto de conexión de ubicación secundaria cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

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

Devuelve un iterador iterable asincrónico para enumerar todas las colas de la cuenta especificada.

.byPage() devuelve un iterador asincrónico para enumerar las colas de las páginas.

Ejemplo de uso de la sintaxis de for await:

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

Ejemplo de uso de 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();
}

Ejemplo de uso de 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++;
    }
  }
}

Ejemplo de uso de paginación con un 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)

Establece las propiedades para el punto de conexión de Queue Service de una cuenta de almacenamiento, incluidas las propiedades para las reglas de Storage Analytics, CORS (uso compartido de recursos entre orígenes) y la configuración de eliminación temporal.

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

Detalles del constructor

QueueServiceClient(string, Pipeline)

Crea una instancia de QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parámetros

url

string

Cadena de dirección URL que apunta al servicio de colas de Azure Storage, como "https://myaccount.queue.core.windows.net". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Llame a newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

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

Crea una instancia de QueueServiceClient.

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

Parámetros

url

string

Cadena de dirección URL que apunta al servicio de colas de Azure Storage, como "https://myaccount.queue.core.windows.net". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options
StoragePipelineOptions

Opciones para configurar la canalización HTTP.

Ejemplo de uso de DefaultAzureCredential de @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Ejemplo con un nombre o clave de cuenta:

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
  }
);

Detalles de las propiedades heredadas

accountName 

accountName: string

Valor de propiedad

string

Heredado de StorageClient.accountName

url

Valor de cadena de dirección URL.

url: string

Valor de propiedad

string

se hereda de StorageClient.url

Detalles del método

createQueue(string, QueueCreateOptions)

Crea una nueva cola en la cuenta especificada.

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

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

Parámetros

queueName

string

nombre de la cola que se va a crear

options
QueueCreateOptions

Opciones para la operación de creación de colas.

Devoluciones

Promise<QueueCreateResponse>

Datos de respuesta para la operación de creación de colas.

deleteQueue(string, QueueDeleteOptions)

Elimina la cola especificada de forma permanente.

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

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

Parámetros

queueName

string

nombre de la cola que se va a eliminar.

options
QueueDeleteOptions

Opciones para la operación de eliminación de colas.

Devoluciones

Promise<QueueDeleteResponse>

Datos de respuesta para la operación de eliminación de colas.

fromConnectionString(string, StoragePipelineOptions)

Crea una instancia de QueueServiceClient.

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

Parámetros

connectionString

string

Cadena de conexión de la cuenta o una cadena de conexión saS de una cuenta de almacenamiento de Azure. [ Nota: la cadena de conexión de la cuenta solo se puede usar en NODE.JS tiempo de ejecución. ] Ejemplo de cadena de conexión de cuenta: ejemplo de cadena de conexión saS de DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net: 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

Opciones para configurar la canalización HTTP.

Devoluciones

QueueServiceClient

Nuevo objeto QueueServiceClient de la cadena de conexión especificada.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Solo está disponible para QueueServiceClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de cuenta basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea 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. Hora en la que la firma de acceso compartido deja de ser válida. El valor predeterminado es una hora más tarde si no se especifica.

permissions
AccountSASPermissions

Especifica la lista de permisos que se van a asociar a la SAS.

resourceTypes

string

Especifica los tipos de recursos asociados a la firma de acceso compartido.

options
ServiceGenerateAccountSasUrlOptions

Parámetros opcionales.

Devoluciones

string

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Solo está disponible para QueueServiceClient construido con una credencial de clave compartida.

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de cuenta en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea 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. Hora en la que la firma de acceso compartido deja de ser válida. El valor predeterminado es una hora más tarde si no se especifica.

permissions
AccountSASPermissions

Especifica la lista de permisos que se van a asociar a la SAS.

resourceTypes

string

Especifica los tipos de recursos asociados a la firma de acceso compartido.

options
ServiceGenerateAccountSasUrlOptions

Parámetros opcionales.

Devoluciones

string

Un URI de SAS de cuenta que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

getProperties(ServiceGetPropertiesOptions)

Obtiene las propiedades de queue service de una cuenta de almacenamiento, incluidas las propiedades de las reglas De uso compartido de recursos entre orígenes y Análisis de Storage.

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

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

Parámetros

options
ServiceGetPropertiesOptions

Opciones para obtener la operación de propiedades.

Devoluciones

Promise<ServiceGetPropertiesResponse>

Datos de respuesta, incluidas las propiedades del servicio de cola.

getQueueClient(string)

Crea un objeto QueueClient.

function getQueueClient(queueName: string): QueueClient

Parámetros

queueName

string

Devoluciones

QueueClient

un nuevo QueueClient

Uso de ejemplo:

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

getStatistics(ServiceGetStatisticsOptions)

Recupera estadísticas relacionadas con la replicación de Queue Service. Solo está disponible en el punto de conexión de ubicación secundaria cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

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

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

Parámetros

options
ServiceGetStatisticsOptions

Opciones para obtener la operación de estadísticas.

Devoluciones

Promise<ServiceGetStatisticsResponse>

Datos de respuesta para obtener estadísticas de la operación.

listQueues(ServiceListQueuesOptions)

Devuelve un iterador iterable asincrónico para enumerar todas las colas de la cuenta especificada.

.byPage() devuelve un iterador asincrónico para enumerar las colas de las páginas.

Ejemplo de uso de la sintaxis de for await:

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

Ejemplo de uso de 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();
}

Ejemplo de uso de 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++;
    }
  }
}

Ejemplo de uso de paginación con un 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

Opciones para enumerar la operación de colas.

Devoluciones

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator que admite la paginación.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Establece las propiedades para el punto de conexión de Queue Service de una cuenta de almacenamiento, incluidas las propiedades para las reglas de Storage Analytics, CORS (uso compartido de recursos entre orígenes) y la configuración de eliminación temporal.

Vea 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

Opciones para establecer la operación de propiedades.

Devoluciones

Promise<ServiceSetPropertiesResponse>

Datos de respuesta para la operación Establecer propiedades.