QueueClient class
QueueClient představuje adresu URL zpráv fronty služby Azure Storage, která umožňuje manipulovat s jejími zprávami.
- Extends
-
StorageClient
Konstruktory
| Queue |
Vytvoří instanci QueueClient. |
| Queue |
Vytvoří instanci QueueClient. |
| Queue |
Vytvoří instanci QueueClient. |
Vlastnosti
| name | Název fronty. |
Zděděné vlastnosti
| account |
|
| url | Hodnota řetězce adresy URL. |
Metody
| clear |
Vymazání odstraní všechny zprávy z fronty. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/clear-messages |
| create(Queue |
Vytvoří novou frontu pod zadaným účtem. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-queue4 |
| create |
Vytvoří novou frontu pod zadaným účtem, pokud ještě neexistuje. Pokud už fronta existuje, nezmění se. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-queue4 |
| delete(Queue |
Odstraní zadanou frontu trvale. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/delete-queue3 |
| delete |
Odstraní zadanou frontu trvale, pokud existuje. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/delete-queue3 |
| delete |
deleteMessage trvale odebere zadanou zprávu z její fronty. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/delete-message2 |
| exists(Queue |
Vrátí hodnotu true, pokud zadaná fronta existuje; jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující fronta může být odstraněna jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové fronty přidány jinými klienty nebo aplikacemi. |
| generate |
K dispozici pouze pro QueueClient vytvořené pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
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 (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| get |
Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy. UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z". Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-acl |
| get |
Získá všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružena k frontě jako páry name-values. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata UPOZORNĚNÍ: Objekt |
| peek |
Funkce peekMessages načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/peek-messages |
| receive |
receiveMessages načte jednu nebo více zpráv z přední části fronty. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-messages |
| send |
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áhled. Obsah zprávy je o velikosti 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 kód, musí být obsah zprávy buď řídicí kód XML, nebo kódování Base64. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/put-message |
| set |
Nastaví uložené zásady přístupu pro frontu, kterou lze použít se sdílenými přístupovými podpisy. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/set-queue-acl |
| set |
Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou frontu. Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, metadata fronty budou odebrána. Podívejte se na https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata |
| update |
Aktualizace změní časový limit a obsah zprávy. Obsah zprávy je o velikosti 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 kód, musí být obsah zprávy buď řídicí kód XML, nebo kódování Base64. Podívejte se na https://learn.microsoft.com/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 metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. 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 lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS 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
- 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 ze StorageClient.accountName
url
Hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
zděděno ze StorageClient.url
Podrobnosti metody
clearMessages(QueueClearMessagesOptions)
Vymazání odstraní všechny zprávy z fronty.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/clear-messages
function clearMessages(options?: QueueClearMessagesOptions): Promise<MessagesClearResponse>
Parametry
- options
- QueueClearMessagesOptions
Možnosti pro vymazání operace zpráv
Návraty
Promise<MessagesClearResponse>
Data odpovědí pro operaci jasných zpráv.
create(QueueCreateOptions)
Vytvoří novou frontu pod zadaným účtem.
Podívejte se na https://learn.microsoft.com/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í:
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}`,
);
createIfNotExists(QueueCreateOptions)
Vytvoří novou frontu pod zadaným účtem, pokud ještě neexistuje. Pokud už fronta existuje, nezmění se.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-queue4
function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>
Parametry
- options
- QueueCreateOptions
Návraty
Promise<QueueCreateIfNotExistsResponse>
delete(QueueDeleteOptions)
Odstraní zadanou frontu trvale.
Podívejte se na https://learn.microsoft.com/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í:
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 deleteQueueResponse = await queueClient.delete();
console.log(
`Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
);
deleteIfExists(QueueDeleteOptions)
Odstraní zadanou frontu trvale, pokud existuje.
Podívejte se na https://learn.microsoft.com/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 z její fronty.
Podívejte se na https://learn.microsoft.com/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í otevírané v okně vrácená z dřívějšího volání příjmu přijatých zpráv nebo operace aktualizace zprávy.
- options
- QueueDeleteMessageOptions
Možnosti odstranění operace zprávy
Návraty
Promise<MessageIdDeleteResponse>
Data odpovědí pro operaci odstranění zprávy
exists(QueueExistsOptions)
Vrátí hodnotu true, pokud zadaná fronta existuje; jinak nepravda.
POZNÁMKA: Tuto funkci používejte opatrně, protože existující fronta může být odstraněna jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové fronty přidány jinými klienty nebo aplikacemi.
function exists(options?: QueueExistsOptions): Promise<boolean>
Parametry
- options
- QueueExistsOptions
možnosti pro operaci Existuje.
Návraty
Promise<boolean>
generateSasStringToSign(QueueGenerateSasUrlOptions)
K dispozici pouze pro QueueClient vytvořené pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string
Parametry
- options
- QueueGenerateSasUrlOptions
Volitelné parametry.
Návraty
string
Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
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 (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: QueueGenerateSasUrlOptions): string
Parametry
- options
- QueueGenerateSasUrlOptions
Volitelné parametry.
Návraty
string
Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
getAccessPolicy(QueueGetAccessPolicyOptions)
Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy.
UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-acl
function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>
Parametry
- options
- QueueGetAccessPolicyOptions
Možnosti pro získání operace zásad přístupu ve frontě
Návraty
Promise<QueueGetAccessPolicyResponse>
Data odpovědí pro operaci zásad přístupu pro frontu získáte.
getProperties(QueueGetPropertiesOptions)
Získá všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružena k frontě jako páry name-values.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata
UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodou listQueuesQueueServiceClient pomocí možnosti includeMetadata, která zachová původní velikost skříně.
function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>
Parametry
- options
- QueueGetPropertiesOptions
Možnosti pro získání operace vlastností ve frontě
Návraty
Promise<QueueGetPropertiesResponse>
Data odpovědí pro operaci získání vlastností fronty
peekMessages(QueuePeekMessagesOptions)
Funkce peekMessages načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/peek-messages
function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>
Parametry
- options
- QueuePeekMessagesOptions
Možnosti náhledu operace zpráv
Návraty
Promise<QueuePeekMessagesResponse>
Data odpovědí pro operaci náhledu zpráv
Příklad použití:
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 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.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-messages
function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>
Parametry
- options
- QueueReceiveMessageOptions
Možnosti příjmu zpráv
Návraty
Promise<QueueReceiveMessageResponse>
Data odpovědí pro operaci příjmu zpráv.
Příklad použití:
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 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áhled. Obsah zprávy je o velikosti 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 kód, musí být obsah zprávy buď řídicí kód XML, nebo kódování Base64.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/put-message
function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>
Parametry
- messageText
-
string
Text zprávy k odeslání
- options
- QueueSendMessageOptions
Možnosti odesílání zpráv
Návraty
Promise<QueueSendMessageResponse>
Data odpovědí pro operaci odesílání zpráv.
Příklad použití:
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);
// Send a message into the queue using the sendMessage method.
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, kterou lze použít se sdílenými přístupovými podpisy.
Podívejte se na https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>
Parametry
- queueAcl
- options
- QueueSetAccessPolicyOptions
Možnosti nastavení operace zásad přístupu ve frontě
Návraty
Promise<QueueSetAccessPolicyResponse>
Data odpovědí pro operaci zásad přístupu nastavenou frontou
setMetadata(Metadata, QueueSetMetadataOptions)
Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou frontu.
Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, metadata fronty budou odebrána.
Podívejte se na https://learn.microsoft.com/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 ve frontě
Návraty
Promise<QueueSetMetadataResponse>
Data odpovědí pro operaci metadat sady front
updateMessage(string, string, string, number, QueueUpdateMessageOptions)
Aktualizace změní časový limit a obsah zprávy. Obsah zprávy je o velikosti 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 kód, musí být obsah zprávy buď řídicí kód XML, nebo kódování Base64.
Podívejte se na https://learn.microsoft.com/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í otevírané v okně vrácená z dřívějšího volání příjmu přijatých zpráv nebo operace aktualizace zprávy.
- message
-
string
Zpráva, která se má aktualizovat 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ěji než čas vypršení platnosti. Zprávu je možné aktualizovat, dokud nebude odstraněna nebo nevypršela jeho platnost.
- options
- QueueUpdateMessageOptions
Možnosti aktualizace operace zprávy
Návraty
Promise<MessageIdUpdateResponse>
Data odpovědí pro operaci aktualizace zprávy.