QueueServiceClient class

Crea un'istanza di QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametri

Crea un'istanza di QueueServiceClient.

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

Parametri

const account = "<account>";

const credential = new DefaultAzureCredential();

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

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

accountName: string

Valore della proprietà

Ereditato da StorageClient.accountName

Valore stringa URL.

url: string

Valore della proprietà

Ereditato da StorageClient.url

Crea una nuova coda nell'account specificato.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione di creazione della coda.

Elimina definitivamente la coda specificata.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione di eliminazione coda.

Crea un'istanza di QueueServiceClient.

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

Parametri

Restituisce

Nuovo oggetto QueueServiceClient dalla stringa di connessione specificata.

Disponibile solo per QueueServiceClient costruito con una credenziale di chiave condivisa.

Genera un URI firma di accesso condiviso dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalla credenziale della chiave condivisa del client.

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

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

Parametri

Restituisce

URI della firma di accesso condiviso dell'account costituito dall'URI alla risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Ottiene le proprietà del servizio code di un account di archiviazione, incluse le proprietà per Analisi archiviazione e CORS (Cross-Origin Resource Sharing).

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

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

Parametri

Restituisce

Dati di risposta, incluse le proprietà del servizio di accodamento.

Crea un oggetto QueueClient .

function getQueueClient(queueName: string): QueueClient

Parametri

Restituisce

un nuovo QueueClient

Esempio di utilizzo:

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

Recupera le statistiche correlate alla replica per il servizio di accodamento. È disponibile solo sull'endpoint della posizione secondaria quando la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione.

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

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

Parametri

Restituisce

Dati di risposta per ottenere statistiche sull'operazione.

Restituisce un iteratore iteratore iterabile asincrono per elencare tutte le code nell'account specificato.

.byPage() restituisce un iteratore iteratore iteratore asincrono per elencare le code nelle pagine.

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

Esempio con 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++;
    }
  }
}

Esempio di uso del paging con un marcatore:

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>

Parametri

Restituisce

AsyncIterableIterator che supporta il paging.

Imposta le proprietà per l'endpoint del servizio di accodamento di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione Imposta proprietà.