Share via

QueueClient class

  • Reference
Balíček:
@azure/storage-queue

QueueClient představuje adresu URL zpráv fronty služby Azure Storage, která umožňuje manipulovat s jejími zprávami.

Extends

StorageClient

Konstruktory

QueueClient(string, Pipeline)

Vytvoří instanci QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Vytvoří instanci QueueClient.

Vlastnosti

name

Název fronty.

Zděděné vlastnosti

accountName
url

Hodnota řetězce adresy URL.

Metody

clearMessages(QueueClearMessagesOptions)

Vymazat odstraní všechny zprávy z fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages.
create(QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4.
createIfNotExists(QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem, pokud ještě neexistuje. Pokud už fronta existuje, nezmění se.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4.
delete(QueueDeleteOptions)

Trvale odstraní zadanou frontu.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3.
deleteIfExists(QueueDeleteOptions)

Odstraní zadanou frontu trvale, pokud existuje.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3.
deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage trvale odebere zadanou zprávu ze své fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2.
exists(QueueExistsOptions)

Vrátí hodnotu true, pokud zadaná fronta existuje; v opačném případě false.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující frontu můžou odstranit jiní klienti nebo aplikace. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové fronty.
generateSasUrl(QueueGenerateSasUrlOptions)

K dispozici pouze pro QueueClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAccessPolicy(QueueGetAccessPolicyOptions)

Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které mohou být použity se sdílenými přístupovými podpisy.

UPOZORNĚNÍ: Při analýze počátečního a vypršení platnosti řetězce může dojít ke ztrátě přesnosti data JavaScriptu. Například nový Date("2018-12-31T03:44:23.8827891Z").toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl.
getProperties(QueueGetPropertiesOptions)

Získá všechny uživatelem definované metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružená k frontě jako páry název-hodnoty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata.

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít své klíče malými písmeny, i když původně obsahovaly velká písmena. To se liší od klíčů metadat vrácených metodou listQueuesQueueServiceClient pomocí includeMetadata možnosti, která si zachová jejich původní velká písmena.
peekMessages(QueuePeekMessagesOptions)

peekMessages načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages.
receiveMessages(QueueReceiveMessageOptions)

receiveMessages načte jednu nebo více zpráv z přední části fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages.
sendMessage(string, QueueSendMessageOptions)

sendMessage přidá novou zprávu do zadní části fronty. Časový limit viditelnosti určuje, jak dlouho má být zpráva neviditelná pro operace dequeue a náhledu. Obsah zprávy má velikost až 64 kB a musí být ve formátu, který lze zahrnout do požadavku XML s kódováním UTF-8. Pokud chcete do zprávy zahrnout značky, musí být obsah zprávy buď xml-escaped, nebo kódování Base64.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-message.
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Nastaví uložené zásady přístupu pro frontu, které se dají použít se sdílenými přístupovými podpisy.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl.
setMetadata(Metadata, QueueSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadanou frontu.

Pokud není k dispozici žádná možnost nebo nejsou v parametru možnosti definována žádná metadata, metadata fronty se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata.
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Aktualizace změní časový limit viditelnosti zprávy a její obsah. Obsah zprávy má velikost až 64 kB a musí být ve formátu, který lze zahrnout do požadavku XML s kódováním UTF-8. Chcete-li do zprávy zahrnout značky, musí být obsah zprávy buď xml-escaped, nebo kódování Base64.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/update-message.

Podrobnosti konstruktoru

QueueClient(string, Pipeline)

Vytvoří instanci QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametry

url

string

Řetězec adresy URL odkazující na frontu služby Azure Storage, například "https://myaccount.queue.core.windows.net/myqueue". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

Vytvoří instanci QueueClient.

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

Parametry

url

string

Řetězec adresy URL odkazující na frontu služby Azure Storage, například "https://myaccount.queue.core.windows.net/myqueue". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

Možnosti konfigurace kanálu HTTP

QueueClient(string, string, StoragePipelineOptions)

Vytvoří instanci QueueClient.

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

Parametry

connectionString

string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Příklad připojovacího řetězce 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

queueName

string

Název fronty.

options
StoragePipelineOptions

Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

name

Název fronty.

string name

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

Zděděno z StorageClient.accountName

url

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Zděděno z StorageClient.url

Podrobnosti metody

clearMessages(QueueClearMessagesOptions)

Vymazat odstraní všechny zprávy z fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages.

function clearMessages(options?: QueueClearMessagesOptions): Promise<MessagesClearResponse>

Parametry

options
QueueClearMessagesOptions

Možnosti operace vymazání zpráv

Návraty

Promise<MessagesClearResponse>

Data odpovědi pro operaci vymazat zprávy.

create(QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem.

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

function create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

Parametry

options
QueueCreateOptions

Možnosti operace vytvoření fronty

Návraty

Promise<QueueCreateResponse>

Data odpovědí pro operaci vytvoření fronty.

Příklad použití:

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

createIfNotExists(QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem, pokud ještě neexistuje. Pokud už fronta existuje, nezmění se.

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

function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

Parametry

options
QueueCreateOptions

Návraty

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Trvale odstraní zadanou frontu.

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

function delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

Parametry

options
QueueDeleteOptions

Možnosti operace odstranění fronty

Návraty

Promise<QueueDeleteResponse>

Data odpovědí pro operaci odstranění fronty.

Příklad použití:

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

deleteIfExists(QueueDeleteOptions)

Odstraní zadanou frontu trvale, pokud existuje.

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

function deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

Parametry

options
QueueDeleteOptions

Návraty

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage trvale odebere zadanou zprávu ze své fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2.

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<MessageIdDeleteResponse>

Parametry

messageId

string

ID zprávy.

popReceipt

string

Platná hodnota potvrzení pop vrácená z dřívějšího volání operace příjmu zpráv nebo aktualizace zprávy.

options
QueueDeleteMessageOptions

Možnosti operace odstranění zprávy

Návraty

Promise<MessageIdDeleteResponse>

Data odpovědi pro operaci odstranění zprávy.

exists(QueueExistsOptions)

Vrátí hodnotu true, pokud zadaná fronta existuje; v opačném případě false.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující frontu můžou odstranit jiní klienti nebo aplikace. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové fronty.

function exists(options?: QueueExistsOptions): Promise<boolean>

Parametry

options
QueueExistsOptions

možnosti operace Existuje.

Návraty

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

K dispozici pouze pro QueueClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametry

options
QueueGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.

getAccessPolicy(QueueGetAccessPolicyOptions)

Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které mohou být použity se sdílenými přístupovými podpisy.

UPOZORNĚNÍ: Při analýze počátečního a vypršení platnosti řetězce může dojít ke ztrátě přesnosti data JavaScriptu. Například nový Date("2018-12-31T03:44:23.8827891Z").toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl.

function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

Parametry

options
QueueGetAccessPolicyOptions

Možnosti pro frontu načíst operaci zásad přístupu.

Návraty

Promise<QueueGetAccessPolicyResponse>

Data odpovědí pro operaci zásady přístupu queue get

getProperties(QueueGetPropertiesOptions)

Získá všechny uživatelem definované metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružená k frontě jako páry název-hodnoty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata.

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít své klíče malými písmeny, i když původně obsahovaly velká písmena. To se liší od klíčů metadat vrácených metodou listQueuesQueueServiceClient pomocí includeMetadata možnosti, která si zachová jejich původní velká písmena.

function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

Parametry

options
QueueGetPropertiesOptions

Možnosti operace Získání vlastností ve frontě

Návraty

Promise<QueueGetPropertiesResponse>

Data odpovědí pro operaci Queue get properties (Získání vlastností fronty).

peekMessages(QueuePeekMessagesOptions)

peekMessages načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages.

function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

Parametry

options
QueuePeekMessagesOptions

Možnosti operace náhledu zpráv

Návraty

Promise<QueuePeekMessagesResponse>

Data odpovědí na operaci náhledu zpráv.

Příklad použití:

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages(QueueReceiveMessageOptions)

receiveMessages načte jednu nebo více zpráv z přední části fronty.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages.

function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

Parametry

options
QueueReceiveMessageOptions

Možnosti pro příjem zpráv operace.

Návraty

Promise<QueueReceiveMessageResponse>

Data odpovědi pro operaci příjmu zpráv.

Příklad použití:

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

sendMessage(string, QueueSendMessageOptions)

sendMessage přidá novou zprávu do zadní části fronty. Časový limit viditelnosti určuje, jak dlouho má být zpráva neviditelná pro operace dequeue a náhledu. Obsah zprávy má velikost až 64 kB a musí být ve formátu, který lze zahrnout do požadavku XML s kódováním UTF-8. Pokud chcete do zprávy zahrnout značky, musí být obsah zprávy buď xml-escaped, nebo kódování Base64.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-message.

function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

Parametry

messageText

string

Text zprávy, která se má odeslat

options
QueueSendMessageOptions

Možnosti pro operaci odesílání zpráv.

Návraty

Promise<QueueSendMessageResponse>

Data odpovědi pro operaci odesílání zpráv.

Příklad použití:

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Nastaví uložené zásady přístupu pro frontu, které se dají použít se sdílenými přístupovými podpisy.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl.

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

Parametry

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Možnosti operace nastavení zásad přístupu ve frontě

Návraty

Promise<QueueSetAccessPolicyResponse>

Data odpovědí pro operaci zásad přístupu sady front.

setMetadata(Metadata, QueueSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadanou frontu.

Pokud není k dispozici žádná možnost nebo nejsou v parametru možnosti definována žádná metadata, metadata fronty se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata.

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

Parametry

metadata
Metadata

Pokud nejsou k dispozici žádná metadata, odeberou se všechna existující metadata.

options
QueueSetMetadataOptions

Možnosti operace nastavení metadat fronty

Návraty

Promise<QueueSetMetadataResponse>

Data odpovědi pro operaci metadat sady front.

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Aktualizace změní časový limit viditelnosti zprávy a její obsah. Obsah zprávy má velikost až 64 kB a musí být ve formátu, který lze zahrnout do požadavku XML s kódováním UTF-8. Chcete-li do zprávy zahrnout značky, musí být obsah zprávy buď xml-escaped, nebo kódování Base64.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/update-message.

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<MessageIdUpdateResponse>

Parametry

messageId

string

ID zprávy

popReceipt

string

Platná hodnota potvrzení pop vrácená z dřívějšího volání operace příjmu zpráv nebo aktualizace zprávy.

message

string

Zpráva k aktualizaci Pokud je tento parametr nedefinovaný, obsah zprávy se neaktualizuje.

visibilityTimeout

number

Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Nová hodnota musí být větší nebo rovna 0 a nesmí být větší než 7 dnů. Časový limit viditelnosti zprávy nelze nastavit na hodnotu pozdější než čas vypršení platnosti. Zprávu je možné aktualizovat, dokud nebude odstraněna nebo nevypršela jeho platnost.

options
QueueUpdateMessageOptions

Možnosti pro operaci aktualizace zpráv.

Návraty

Promise<MessageIdUpdateResponse>

Data odpovědi na operaci zprávy o aktualizaci.