QueueClient class

Tworzy wystąpienie obiektu QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametry

Tworzy wystąpienie obiektu QueueClient.

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

Parametry

Tworzy wystąpienie obiektu QueueClient.

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

Parametry

Nazwa kolejki.

string name

Wartość właściwości

accountName: string

Wartość właściwości

Dziedziczone zklasy StorageClient.accountName

Wartość ciągu adresu URL.

url: string

Wartość właściwości

Dziedziczone zobiektu StorageClient.url

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

Zwraca

Dane odpowiedzi dla operacji czyszczenia komunikatów.

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

Zwraca

Dane odpowiedzi dla operacji tworzenia kolejki.

Przykład użycia:

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

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

Zwraca

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

Zwraca

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

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

Zwraca

Dane odpowiedzi dla operacji usuwania komunikatu.

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

Zwraca

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

Zwraca

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.

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

Zwraca

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

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

Zwraca

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

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

Zwraca

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

Zwraca

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

Zwraca

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

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

Zwraca

Dane odpowiedzi dla operacji zasad dostępu zestawu kolejek.

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

Zwraca

Dane odpowiedzi dla operacji metadanych zestawu kolejek.

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

Zwraca

Dane odpowiedzi dotyczące operacji aktualizacji komunikatu.