QueueClient class

Odwołanie

Pakiet:: @azure/storage-queue

Obiekt QueueClient reprezentuje adres URL komunikatów kolejki usługi Azure Storage, co umożliwia manipulowanie jego komunikatami.

Extends: StorageClient

Konstruktory

QueueClient(string, Pipeline)	Tworzy wystąpienie obiektu QueueClient.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie obiektu QueueClient.
QueueClient(string, string, StoragePipelineOptions)	Tworzy wystąpienie obiektu QueueClient.

Właściwości

name	Nazwa kolejki.

Właściwości dziedziczone

accountName
url	Wartość ciągu adresu URL.

Metody

clearMessages(QueueClearMessagesOptions)	Wyczyść pole usuwa wszystkie komunikaty z kolejki. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
create(QueueCreateOptions)	Tworzy nową kolejkę w ramach określonego konta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)	Tworzy nową kolejkę na określonym koncie, jeśli jeszcze nie istnieje. Jeśli kolejka już istnieje, nie zostanie zmieniona. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)	Usuwa na stałe określoną kolejkę. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)	Usuwa określoną kolejkę trwale, jeśli istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage trwale usuwa określony komunikat z kolejki. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)	Zwraca wartość true, jeśli istnieje określona kolejka; false w przeciwnym razie. UWAGA: użyj tej funkcji z opieką, ponieważ istniejąca kolejka może zostać usunięta przez innych klientów lub aplikacji. Na odwrót nowe kolejki mogą zostać dodane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
generateSasUrl(QueueGenerateSasUrlOptions)	Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współdzielonego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)	Pobiera szczegółowe informacje o wszystkich przechowywanych zasadach dostępu określonych w kolejce, które mogą być używane z sygnaturami dostępu współdzielonego. OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z". Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)	Pobiera wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonej kolejki. Metadane są skojarzone z kolejką jako pary name-values. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata OSTRZEŻENIE: `metadata` Obiekt zwrócony w odpowiedzi będzie miał swoje klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez `listQueues` metodę QueueServiceClient`includeMetadata` używania opcji, która zachowa oryginalną wielkość liter.
peekMessages(QueuePeekMessagesOptions)	peekMessages pobiera jeden lub więcej komunikatów z przodu kolejki, ale nie zmienia widoczności komunikatu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)	receiveMessages pobiera co najmniej jeden komunikat z przodu kolejki. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)	sendMessage dodaje nowy komunikat z tyłu kolejki. Limit czasu widoczności określa, jak długo komunikat powinien być niewidoczny dla operacji Dequeue i Peek. Zawartość komunikatu ma rozmiar do 64 KB i musi być w formacie, który można uwzględnić w żądaniu XML z kodowaniem UTF-8. Aby dołączyć znaczniki w komunikacie, zawartość wiadomości musi być kodowana przy użyciu kodu XML lub Base64. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Ustawia przechowywane zasady dostępu dla kolejki, które mogą być używane z sygnaturami dostępu współdzielonego. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)	Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonej kolejki. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane kolejki zostaną usunięte. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	Aktualizacja zmienia limit czasu widoczności komunikatu i jego zawartość. Zawartość wiadomości ma rozmiar do 64 KB i musi być w formacie, który można uwzględnić w żądaniu XML z kodowaniem UTF-8. Aby dołączyć znaczniki do wiadomości, zawartość komunikatu musi być znakiem XML lub kodem Base64. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Szczegóły konstruktora

QueueClient(string, Pipeline)

Tworzy wystąpienie obiektu QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametry

url: string

Ciąg adresu URL wskazujący kolejkę usługi Azure Storage, na przykład "https://myaccount.queue.core.windows.net/myqueue"". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz funkcji AnonymousCredential, na przykład "https://myaccount.queue.core.windows.net/myqueue?sasString"".

pipeline: Pipeline

Wywołaj metodę newPipeline() w celu utworzenia potoku domyślnego lub podaj dostosowany potok.

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

Tworzy wystąpienie obiektu QueueClient.

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z @azure/identity pakietu w celu uwierzytelnienia żądań do usługi. Można również podać obiekt implementujący interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: StoragePipelineOptions

Opcje konfigurowania potoku HTTP.

QueueClient(string, string, StoragePipelineOptions)

Tworzy wystąpienie obiektu QueueClient.

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

Parametry

connectionString: string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Nazwa kolejki.

options: StoragePipelineOptions

Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

name

Nazwa kolejki.

string name

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName

accountName: string

Wartość właściwości

string

Dziedziczone zklasy StorageClient.accountName

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Dziedziczone zobiektu StorageClient.url

Szczegóły metody

clearMessages(QueueClearMessagesOptions)

Wyczyść pole usuwa wszystkie komunikaty z kolejki.

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

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

Parametry

options: QueueClearMessagesOptions

Opcje czyszczenia operacji komunikatów.

Zwraca

Promise<QueueClearMessagesResponse>

Dane odpowiedzi dla operacji czyszczenia komunikatów.

create(QueueCreateOptions)

Tworzy nową kolejkę w ramach określonego konta.

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

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

Parametry

options: QueueCreateOptions

Opcje tworzenia kolejki.

Zwraca

Promise<QueueCreateResponse>

Dane odpowiedzi dla operacji tworzenia kolejki.

Przykład użycia:

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

createIfNotExists(QueueCreateOptions)

Tworzy nową kolejkę na określonym koncie, jeśli jeszcze nie istnieje. Jeśli kolejka już istnieje, nie zostanie zmieniona.

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

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

Parametry

options: QueueCreateOptions

Zwraca

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Usuwa na stałe określoną kolejkę.

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

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

Parametry

options: QueueDeleteOptions

Opcje operacji usuwania w kolejce.

Zwraca

Promise<QueueDeleteResponse>

Dane odpowiedzi dla operacji usuwania kolejki.

Przykład użycia:

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

deleteIfExists(QueueDeleteOptions)

Usuwa określoną kolejkę trwale, jeśli istnieje.

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

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

Parametry

options: QueueDeleteOptions

Zwraca

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage trwale usuwa określony komunikat z kolejki.

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

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

Parametry

messageId: string

Identyfikator wiadomości.

popReceipt: string

Prawidłowa wartość potwierdzenia wyskakującego zwrócona z wcześniejszego wywołania do operacji odbierania komunikatów lub aktualizowania komunikatów.

options: QueueDeleteMessageOptions

Opcje usuwania operacji komunikatu.

Zwraca

Promise<QueueDeleteMessageResponse>

Dane odpowiedzi dla operacji usuwania komunikatu.

exists(QueueExistsOptions)

Zwraca wartość true, jeśli istnieje określona kolejka; false w przeciwnym razie. UWAGA: użyj tej funkcji z opieką, ponieważ istniejąca kolejka może zostać usunięta przez innych klientów lub aplikacji. Na odwrót nowe kolejki mogą zostać dodane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options: QueueExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współdzielonego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametry

options: QueueGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getAccessPolicy(QueueGetAccessPolicyOptions)

Pobiera szczegółowe informacje o wszystkich przechowywanych zasadach dostępu określonych w kolejce, które mogą być używane z sygnaturami dostępu współdzielonego. OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".

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

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

Parametry

options: QueueGetAccessPolicyOptions

Opcje kolejki uzyskiwania operacji zasad dostępu.

Zwraca

Promise<QueueGetAccessPolicyResponse>

Dane odpowiedzi dla operacji zasad uzyskiwania dostępu do kolejki.

getProperties(QueueGetPropertiesOptions)

Pobiera wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonej kolejki. Metadane są skojarzone z kolejką jako pary name-values.

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

OSTRZEŻENIE: metadata Obiekt zwrócony w odpowiedzi będzie miał swoje klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez listQueues metodę QueueServiceClientincludeMetadata używania opcji, która zachowa oryginalną wielkość liter.

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

Parametry

options: QueueGetPropertiesOptions

Opcje pobierania właściwości w kolejce.

Zwraca

Promise<QueueGetPropertiesResponse>

Dane odpowiedzi dla operacji pobierania właściwości kolejki.

peekMessages(QueuePeekMessagesOptions)

peekMessages pobiera jeden lub więcej komunikatów z przodu kolejki, ale nie zmienia widoczności komunikatu.

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

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

Parametry

options: QueuePeekMessagesOptions

Opcje podglądu operacji komunikatów.

Zwraca

Promise<QueuePeekMessagesResponse>

Dane odpowiedzi dotyczące operacji podglądu komunikatów.

Przykład użycia:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages pobiera co najmniej jeden komunikat z przodu kolejki.

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

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

Parametry

options: QueueReceiveMessageOptions

Opcje odbierania komunikatów.

Zwraca

Promise<QueueReceiveMessageResponse>

Dane odpowiedzi dotyczące operacji odbierania komunikatów.

Przykład użycia:

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 dodaje nowy komunikat z tyłu kolejki. Limit czasu widoczności określa, jak długo komunikat powinien być niewidoczny dla operacji Dequeue i Peek. Zawartość komunikatu ma rozmiar do 64 KB i musi być w formacie, który można uwzględnić w żądaniu XML z kodowaniem UTF-8. Aby dołączyć znaczniki w komunikacie, zawartość wiadomości musi być kodowana przy użyciu kodu XML lub Base64.

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

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

Parametry

messageText: string

Tekst wiadomości do wysłania

options: QueueSendMessageOptions

Opcje wysyłania operacji komunikatów.

Zwraca

Promise<QueueSendMessageResponse>

Dane odpowiedzi dotyczące operacji wysyłania komunikatów.

Przykład użycia:

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)

Ustawia przechowywane zasady dostępu dla kolejki, które mogą być używane z sygnaturami dostępu współdzielonego.

Zobacz 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

Opcje ustawiania zasad dostępu w kolejce.

Zwraca

Promise<QueueSetAccessPolicyResponse>

Dane odpowiedzi dla operacji zasad dostępu zestawu kolejek.

setMetadata(Metadata, QueueSetMetadataOptions)

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonej kolejki. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane kolejki zostaną usunięte.

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

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

Parametry

metadata: Metadata

Jeśli nie podano żadnych metadanych, wszystkie istniejące metadane zostaną usunięte.

options: QueueSetMetadataOptions

Opcje operacji ustawiania metadanych w kolejce.

Zwraca

Promise<QueueSetMetadataResponse>

Dane odpowiedzi dla operacji metadanych zestawu kolejek.

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

Aktualizacja zmienia limit czasu widoczności komunikatu i jego zawartość. Zawartość wiadomości ma rozmiar do 64 KB i musi być w formacie, który można uwzględnić w żądaniu XML z kodowaniem UTF-8. Aby dołączyć znaczniki do wiadomości, zawartość komunikatu musi być znakiem XML lub kodem Base64.

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

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

Parametry

messageId: string

Identyfikator wiadomości

popReceipt: string

Prawidłowa wartość potwierdzenia wyskakującego zwrócona z wcześniejszego wywołania do operacji odbierania komunikatów lub aktualizacji komunikatu.

message: string

Komunikat do aktualizacji. Jeśli ten parametr jest niezdefiniowany, zawartość komunikatu nie zostanie zaktualizowana.

visibilityTimeout: number

Określa nową wartość limitu czasu widoczności w sekundach względem czasu serwera. Nowa wartość musi być większa lub równa 0 i nie może być większa niż 7 dni. Limit czasu widoczności komunikatu nie może być ustawiony na wartość późniejszą niż czas wygaśnięcia. Komunikat można zaktualizować do momentu jego usunięcia lub wygaśnięcia.

options: QueueUpdateMessageOptions

Opcje aktualizowania operacji komunikatu.

Zwraca

Promise<QueueUpdateMessageResponse>

Dane odpowiedzi dotyczące operacji aktualizacji komunikatu.

Udostępnij za pośrednictwem

QueueClient class

Konstruktory

Właściwości

Właściwości dziedziczone

Metody

Szczegóły konstruktora

QueueClient(string, Pipeline)

Parametry

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

Parametry

QueueClient(string, string, StoragePipelineOptions)

Parametry

Szczegóły właściwości

name

Wartość właściwości

Szczegóły właściwości dziedziczonej

accountName

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

clearMessages(QueueClearMessagesOptions)

Parametry

Zwraca

create(QueueCreateOptions)

Parametry

Zwraca

createIfNotExists(QueueCreateOptions)

Parametry

Zwraca

delete(QueueDeleteOptions)

Parametry

Zwraca

deleteIfExists(QueueDeleteOptions)

Parametry

Zwraca

deleteMessage(string, string, QueueDeleteMessageOptions)

Parametry

Zwraca

exists(QueueExistsOptions)

Parametry

Zwraca

generateSasUrl(QueueGenerateSasUrlOptions)

Parametry

Zwraca

getAccessPolicy(QueueGetAccessPolicyOptions)

Parametry

Zwraca

getProperties(QueueGetPropertiesOptions)

Parametry

Zwraca

peekMessages(QueuePeekMessagesOptions)

Parametry

Zwraca

receiveMessages(QueueReceiveMessageOptions)

Parametry

Zwraca

sendMessage(string, QueueSendMessageOptions)

Parametry

Zwraca

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Parametry

Zwraca

setMetadata(Metadata, QueueSetMetadataOptions)

Parametry

Zwraca

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

Parametry

Zwraca

Dodatkowe zasoby