Udostępnij za pośrednictwem


QueueClient class

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

Rozszerzenie

StorageClient

Konstruktory

QueueClient(string, Pipeline)

Tworzy wystąpienie klasy QueueClient.

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

Tworzy wystąpienie klasy QueueClient.

QueueClient(string, string, StoragePipelineOptions)

Tworzy wystąpienie klasy QueueClient.

Właściwości

name

Nazwa kolejki.

Właściwości dziedziczone

accountName
url

Wartość ciągu adresu URL.

Metody

clearMessages(QueueClearMessagesOptions)

Wyczyść usunięcie wszystkich komunikatów 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ę w ramach określonego konta, jeśli jeszcze nie istnieje. Jeśli kolejka już istnieje, nie zostanie ona zmieniona.

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

delete(QueueDeleteOptions)

Usuwa określoną kolejkę trwale.

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; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejąca kolejka może zostać usunięta przez innych klientów lub aplikacje. Na odwrót nowe kolejki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

generateSasStringToSign(QueueGenerateSasUrlOptions)

Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora 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ólnego klienta.

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

generateSasUrl(QueueGenerateSasUrlOptions)

Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

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ólnego 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: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę listQueuesQueueServiceClient przy użyciu opcji includeMetadata, 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 do wiadomości, zawartość wiadomości musi być w formacie XML-escaped lub Base64-encode.

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ść 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 do wiadomości, zawartość wiadomości musi być w formacie XML-escaped lub Base64-encode.

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

Szczegóły konstruktora

QueueClient(string, Pipeline)

Tworzy wystąpienie klasy 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 jest używana funkcja AnonymousCredential, na przykład "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

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

Tworzy wystąpienie klasy QueueClient.

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

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 jest używana funkcja AnonymousCredential, na przykład "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje 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 klasy 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 — przykład parametrów połączenia sygnatury dostępu współdzielonego DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netBlobEndpoint=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 z StorageClient.accountName

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone z StorageClient.url

Szczegóły metody

clearMessages(QueueClearMessagesOptions)

Wyczyść usunięcie wszystkich komunikatów z kolejki.

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

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

Parametry

options
QueueClearMessagesOptions

Opcje czyszczenia operacji komunikatów.

Zwraca

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

Dane odpowiedzi dla operacji tworzenia kolejki.

Przykładowe użycie:

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

createIfNotExists(QueueCreateOptions)

Tworzy nową kolejkę w ramach określonego konta, jeśli jeszcze nie istnieje. Jeśli kolejka już istnieje, nie zostanie ona zmieniona.

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

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

Parametry

Zwraca

delete(QueueDeleteOptions)

Usuwa określoną kolejkę trwale.

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

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

Parametry

options
QueueDeleteOptions

Opcje operacji usuwania kolejki.

Zwraca

Dane odpowiedzi dla operacji usuwania kolejki.

Przykładowe użycie:

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

Zwraca

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<MessageIdDeleteResponse>

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

Dane odpowiedzi dla operacji usuwania komunikatu.

exists(QueueExistsOptions)

Zwraca wartość true, jeśli istnieje określona kolejka; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejąca kolejka może zostać usunięta przez innych klientów lub aplikacje. Na odwrót nowe kolejki mogą być dodawane 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>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora 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ólnego klienta.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parametry

options
QueueGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

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

generateSasUrl(QueueGenerateSasUrlOptions)

Jest dostępny tylko dla elementu QueueClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

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ólnego 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 do 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

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: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę listQueuesQueueServiceClient przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

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

Parametry

options
QueueGetPropertiesOptions

Opcje kolejkowania operacji pobierania właściwości.

Zwraca

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 wglądu w operację komunikatów.

Zwraca

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

Przykładowe użycie:

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 operacji komunikatów.

Zwraca

Dane odpowiedzi dla operacji odbierania komunikatów.

Przykładowe użycie:

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 do wiadomości, zawartość wiadomości musi być w formacie XML-escaped lub Base64-encode.

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

Dane odpowiedzi dla operacji wysyłania komunikatów.

Przykładowe użycie:

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 do kolejki.

Zwraca

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

Dane odpowiedzi dla operacji metadanych zestawu kolejek.

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

Aktualizacja zmienia limit czasu widoczności komunikatu i jego zawartość. 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 do wiadomości, zawartość wiadomości musi być w formacie XML-escaped lub Base64-encode.

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<MessageIdUpdateResponse>

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.

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. Wiadomość można zaktualizować do momentu usunięcia lub wygaśnięcia.

options
QueueUpdateMessageOptions

Opcje aktualizacji operacji komunikatu.

Zwraca

Dane odpowiedzi dla operacji komunikatu aktualizacji.