QueueClient Klasse

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Paket:

Azure.Storage.Queues v12.17.1

Quelle:

QueueClient.cs

Ein QueueClient stellt einen URI für den Azure Storage Queue-Dienst dar, mit dem Sie eine Warteschlange bearbeiten können.

public class QueueClient

type QueueClient = class

Public Class QueueClient

Vererbung

Object

QueueClient

Konstruktoren

QueueClient()	Initialisiert eine neue instance der -Klasse für die QueueClient Simulation.
QueueClient(String, String)	Initialisiert eine neue Instanz der QueueClient-Klasse.
QueueClient(String, String, QueueClientOptions)	Initialisiert eine neue Instanz der QueueClient-Klasse.
QueueClient(Uri, AzureSasCredential, QueueClientOptions)	Initialisiert eine neue Instanz der QueueClient-Klasse.
QueueClient(Uri, QueueClientOptions)	Initialisiert eine neue Instanz der QueueClient-Klasse.
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)	Initialisiert eine neue Instanz der QueueClient-Klasse.
QueueClient(Uri, TokenCredential, QueueClientOptions)	Initialisiert eine neue Instanz der QueueClient-Klasse.

Eigenschaften

AccountName	Ruft den Speicherkontonamen ab, der dem Warteschlangenclient entspricht.
CanGenerateSasUri	Bestimmt, ob der Client eine SAS generieren kann. Wenn der Client mit einem StorageSharedKeyCredentialauthentifiziert wird.
MaxPeekableMessages	QueueMaxMessagesPeek gibt die maximale Anzahl von Nachrichten an, die Sie mit jedem Aufruf von Peek abrufen können.
MessageMaxBytes	Ruft die maximale Anzahl von Bytes ab, die für den UTF-8-Text einer Nachricht zulässig sind.
MessagesUri	Ruft den URI-Endpunkt ab, der von den Nachrichten des Objekts verwendet wird.
Name	Ruft den Namen der Warteschlange ab.
Uri	Ruft den URI-Endpunkt ab, der vom -Objekt verwendet wird.

Methoden

ClearMessages(CancellationToken)	Löscht alle Nachrichten aus einer Warteschlange. Weitere Informationen finden Sie unter Meldungen löschen.
ClearMessagesAsync(CancellationToken)	Löscht alle Nachrichten aus einer Warteschlange. Weitere Informationen finden Sie unter Meldungen löschen.
Create(IDictionary<String,String>, CancellationToken)	Erstellt eine Warteschlange. Weitere Informationen finden Sie unter Erstellen einer Warteschlange.
CreateAsync(IDictionary<String,String>, CancellationToken)	Erstellt eine Warteschlange. Weitere Informationen finden Sie unter Erstellen einer Warteschlange.
CreateIfNotExists(IDictionary<String,String>, CancellationToken)	Der CreateIfNotExists(IDictionary<String,String>, CancellationToken) Vorgang erstellt eine neue Warteschlange unter dem angegebenen Konto. Wenn die Warteschlange bereits vorhanden ist, wird sie nicht geändert. Weitere Informationen finden Sie unter Erstellen einer Warteschlange.
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)	Der CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) Vorgang erstellt eine neue Warteschlange unter dem angegebenen Konto. Wenn die Warteschlange bereits vorhanden ist, wird sie nicht geändert. Weitere Informationen finden Sie unter Erstellen einer Warteschlange.
Delete(CancellationToken)	Löscht eine Warteschlange. Weitere Informationen finden Sie unter Löscht die Warteschlange.
DeleteAsync(CancellationToken)	Löscht eine Warteschlange. Weitere Informationen finden Sie unter Löscht die Warteschlange.
DeleteIfExists(CancellationToken)	Der DeleteIfExists(CancellationToken) Vorgang löscht die angegebene Warteschlange, sofern vorhanden. Weitere Informationen finden Sie unter Löscht die Warteschlange.
DeleteIfExistsAsync(CancellationToken)	Der DeleteIfExistsAsync(CancellationToken) Vorgang löscht die angegebene Warteschlange, sofern vorhanden. Weitere Informationen finden Sie unter Löscht die Warteschlange.
DeleteMessage(String, String, CancellationToken)	Entfernt die angegebene Nachricht dauerhaft aus der Warteschlange. Weitere Informationen finden Sie unter Nachricht löschen.
DeleteMessageAsync(String, String, CancellationToken)	Entfernt die angegebene Nachricht dauerhaft aus der Warteschlange. Weitere Informationen finden Sie unter Nachricht löschen.
Exists(CancellationToken)	Der Exists(CancellationToken) Vorgang kann für ein QueueClient aufgerufen werden, um festzustellen, ob die zugeordnete Warteschlange im Speicherkonto im Speicherdienst vorhanden ist.
ExistsAsync(CancellationToken)	Der ExistsAsync(CancellationToken) Vorgang kann für ein QueueClient aufgerufen werden, um festzustellen, ob die zugeordnete Warteschlange im Speicherkonto im Speicherdienst vorhanden ist.
GenerateSasUri(QueueSasBuilder)	Gibt GenerateSasUri(QueueSasBuilder) einen Uri zurück, der basierend auf den übergebenen Clienteigenschaften und dem übergebenen Generator einen SAS-URI des Warteschlangendiensts generiert. Weitere Informationen finden Sie unter Erstellen einer Dienst-SAS
GenerateSasUri(QueueSasPermissions, DateTimeOffset)	Gibt GenerateSasUri(QueueSasPermissions, DateTimeOffset) einen Uri zurück, der einen SAS-URI (Queue Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern generiert. Weitere Informationen finden Sie unter Erstellen einer Dienst-SAS.
GetAccessPolicy(CancellationToken)	Gibt Details zu allen gespeicherten Zugriffsrichtlinien zurück, die in der Warteschlange angegeben sind und mit Shared Access Signatures verwendet werden können. Weitere Informationen finden Sie unter Abrufen der Warteschlangen-ACL.
GetAccessPolicyAsync(CancellationToken)	Gibt Details zu allen gespeicherten Zugriffsrichtlinien zurück, die in der Warteschlange angegeben sind und mit Shared Access Signatures verwendet werden können. Weitere Informationen finden Sie unter Abrufen der Warteschlangen-ACL.
GetParentQueueServiceClientCore()	Erstellen Sie eine neue QueueServiceClient , die auf den Warteschlangendienst dieses QueueClientDiensts verweist. Die neue QueueServiceClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die QueueClient.
GetProperties(CancellationToken)	Ruft Warteschlangeneigenschaften und benutzerdefinierte Metadaten und Eigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet. Weitere Informationen finden Sie unter Abrufen von Warteschlangenmetadaten.
GetPropertiesAsync(CancellationToken)	Ruft Warteschlangeneigenschaften und benutzerdefinierte Metadaten und Eigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet. Weitere Informationen finden Sie unter Abrufen von Warteschlangenmetadaten.
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	Löst das -Ereignis aus MessageDecodingFailed .
PeekMessage(CancellationToken)	Ruft eine Nachricht von der Vorderseite der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht. Weitere Informationen finden Sie unter Einsehen von Nachrichten.
PeekMessageAsync(CancellationToken)	Ruft eine Nachricht von der Vorderseite der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht. Weitere Informationen finden Sie unter Einsehen von Nachrichten.
PeekMessages(Nullable<Int32>, CancellationToken)	Ruft eine oder mehrere Nachrichten von der Vorderseite der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht. Weitere Informationen finden Sie unter Einsehen von Nachrichten.
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	Ruft eine oder mehrere Nachrichten von der Vorderseite der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht. Weitere Informationen finden Sie unter Einsehen von Nachrichten.
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	Empfängt eine Nachricht vom Anfang der Warteschlange. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Ruft eine Nachricht von der Vorderseite der Warteschlange ab. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessages()	Empfängt eine oder mehrere Nachrichten vom Anfang der Warteschlange. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessages(CancellationToken)	Empfängt eine oder mehrere Nachrichten vom Anfang der Warteschlange. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Empfängt eine oder mehrere Nachrichten vom Anfang der Warteschlange. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessagesAsync()	Ruft eine oder mehrere Nachrichten vom Anfang der Warteschlange ab. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessagesAsync(CancellationToken)	Ruft eine oder mehrere Nachrichten vom Anfang der Warteschlange ab. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Ruft eine oder mehrere Nachrichten vom Anfang der Warteschlange ab. Weitere Informationen finden Sie unter Abrufen von Nachrichten.
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für die Vorgänge Dequeue und Peek nicht sichtbar sein soll. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessage(String)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessage(String, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für die Vorgänge Dequeue und Peek nicht sichtbar sein soll. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für die Vorgänge Dequeue und Peek nicht sichtbar sein soll. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessageAsync(String)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessageAsync(String, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Fügt eine neue Nachricht am Ende einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für die Vorgänge Dequeue und Peek nicht sichtbar sein soll. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Put Message.
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Shared Access Signatures verwendet werden kann. Weitere Informationen finden Sie unter Legen Sie die Warteschlangen-ACL fest.
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Shared Access Signatures verwendet werden kann. Weitere Informationen finden Sie unter Legen Sie die Warteschlangen-ACL fest.
SetMetadata(IDictionary<String,String>, CancellationToken)	Legt benutzerdefinierte Metadaten für die angegebene Warteschlange fest. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet. Weitere Informationen finden Sie unter Legen Sie Warteschlangenmetadaten fest.
SetMetadataAsync(IDictionary<String,String>, CancellationToken)	Legt benutzerdefinierte Metadaten für die angegebene Warteschlange fest. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet. Weitere Informationen finden Sie unter Legen Sie Warteschlangenmetadaten fest.
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)	Ändert das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Nachricht aktualisieren.
UpdateMessage(String, String, String, TimeSpan, CancellationToken)	Ändert das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Nachricht aktualisieren.
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	Ändert das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht konforme Nachrichten zu verarbeiten. Die codierte Nachricht kann bis zu 64 KiB für Versionen 2011-08-18 und höher oder 8 KiB in früheren Versionen groß sein. Weitere Informationen finden Sie unter Nachricht aktualisieren.
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	Ändert das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Nachrichten müssen ein Format aufweisen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Andernfalls MessageEncoding kann die Option auf Base64 festgelegt werden, um nicht kompatible Nachrichten zu verarbeiten. Die codierte Nachricht kann für Versionen 2011-08-18 und höher bis zu 64 KiB oder 8 KiB für frühere Versionen groß sein. Weitere Informationen finden Sie unter Nachricht aktualisieren.
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)	Erstellt eine neue instance der QueueClient -Klasse, wobei alle internen Elemente beibehalten, aber neue ClientSideEncryptionOptionsangegeben werden.

Erweiterungsmethoden

GetParentQueueServiceClient(QueueClient)	Erstellen Sie eine neue QueueServiceClient , die auf diesen QueueClientWarteschlangendienst verweist. Das neue QueueServiceClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die QueueClient.
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)	Erstellt eine neue instance der QueueClient -Klasse, wobei alle internen Elemente beibehalten, aber neue ClientSideEncryptionOptionsangegeben werden.