Freigeben über


ServiceBusAdministrationClient class

Alle Vorgänge geben Zusagen zurück, die in ein Objekt aufgelöst werden, das über die relevante Ausgabe verfügt. Diese Objekte verfügen auch über eine Eigenschaft namens _response , die Sie verwenden können, wenn Sie auf die direkte Antwort des Diensts zugreifen möchten.

Extends

Konstruktoren

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Initialisiert eine neue Instanz der ServiceBusAdministrationClient-Klasse.

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Geerbte Eigenschaften

pipeline

Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird

Methoden

createQueue(string, CreateQueueOptions)

Erstellt eine Warteschlange mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert ist

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

Erstellt eine Regel mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert wird.

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

Erstellt eine Regel mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert wird.

createSubscription(string, string, CreateSubscriptionOptions)

Erstellt ein Abonnement mit einem angegebenen Namen, das mithilfe der angegebenen Optionen konfiguriert ist

createTopic(string, CreateTopicOptions)

Erstellt ein Thema mit einem angegebenen Namen, das mithilfe der angegebenen Optionen konfiguriert ist

deleteQueue(string, OperationOptions)

Löscht eine Warteschlange.

deleteRule(string, string, string, OperationOptions)

Löscht eine Regel.

deleteSubscription(string, string, OperationOptions)

Löscht ein Abonnement.

deleteTopic(string, OperationOptions)

Löscht ein Thema.

getNamespaceProperties(OperationOptions)

Gibt ein Objekt zurück, das die Metadaten im Zusammenhang mit einem Service Bus-Namespace darstellt.

getQueue(string, OperationOptions)

Gibt ein Objekt zurück, das die Warteschlange und ihre Eigenschaften darstellt. Wenn Sie die Warteschlangenlaufzeitinformationen wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie getQueueRuntimeProperties die API.

getQueueRuntimeProperties(string, OperationOptions)

Gibt ein Objekt zurück, das die Warteschlangenlaufzeitinformationen wie Details zur Nachrichtenanzahl darstellt.

getRule(string, string, string, OperationOptions)

Gibt ein Objekt zurück, das die Regel mit dem angegebenen Namen zusammen mit allen zugehörigen Eigenschaften darstellt.

getSubscription(string, string, OperationOptions)

Gibt ein Objekt zurück, das das Abonnement und seine Eigenschaften darstellt. Wenn Sie die Informationen zur Abonnementlaufzeit wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie getSubscriptionRuntimeProperties die API.

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Gibt ein Objekt zurück, das die Informationen zur Abonnementlaufzeit wie Details zur Nachrichtenanzahl darstellt.

getTopic(string, OperationOptions)

Gibt ein Objekt zurück, das das Thema und seine Eigenschaften darstellt. Wenn Sie die Themenlaufzeitinformationen wie Details zur Abonnementanzahl abrufen möchten, verwenden Sie getTopicRuntimeProperties die API.

getTopicRuntimeProperties(string, OperationOptions)

Gibt ein Objekt zurück, das die Themenlaufzeitinformationen wie die Abonnementanzahl darstellt.

listQueues(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, der alle Warteschlangen auflistet.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Warteschlangen in Seiten auflisten zu können.

listQueuesRuntimeProperties(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zum Auflisten der Laufzeitinformationen der Warteschlangen zurück.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Warteschlangen auf Seiten auflisten.

listRules(string, string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, der alle Regeln unter dem angegebenen Abonnement auflistet.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Regeln auf Seiten auflisten zu können.

listSubscriptions(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Abonnements unter dem angegebenen Thema aufzulisten.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Abonnements auf Seiten aufzulisten.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Abonnements unter dem angegebenen Thema aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen von Abonnements auf Seiten aufzulisten.

listTopics(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Themen auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Themen auf Seiten auflisten zu können.

listTopicsRuntimeProperties(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zum Auflisten der Laufzeitinformationen der Themen zurück.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Themen auf Seiten auflisten zu können.

queueExists(string, OperationOptions)

Überprüft, ob eine bestimmte Warteschlange vorhanden ist oder nicht.

ruleExists(string, string, string, OperationOptions)

Überprüft, ob eine bestimmte Regel vorhanden ist oder nicht.

subscriptionExists(string, string, OperationOptions)

Überprüft, ob ein bestimmtes Abonnement im Thema vorhanden ist oder nicht.

topicExists(string, OperationOptions)

Überprüft, ob ein bestimmtes Thema vorhanden ist.

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Aktualisierungen die Warteschlange basierend auf den bereitgestellten Warteschlangeneigenschaften. Alle Warteschlangeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getQueue()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateQueue()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der QueueProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

Aktualisierungen Eigenschaften für die Regel anhand des angegebenen Namens basierend auf den angegebenen Optionen. Alle Regeleigenschaften müssen auch dann festgelegt werden, wenn eine davon aktualisiert wird. Daher ist der vorgeschlagene Flow, die Ausgabe von getRule()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateRule()übergeben.

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Aktualisierungen das Abonnement basierend auf den bereitgestellten Abonnementeigenschaften. Alle Abonnementeigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge davon tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getSubscription()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateSubscription()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der SubscriptionProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Aktualisierungen das Thema basierend auf den bereitgestellten Themeneigenschaften. Alle Themeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getTopic()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateTopic()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der TopicProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

Geerbte Methoden

sendOperationRequest<T>(OperationArguments, OperationSpec)

Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird.

sendRequest(PipelineRequest)

Senden Sie die bereitgestellte httpRequest.

Details zum Konstruktor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Initialisiert eine neue Instanz der ServiceBusAdministrationClient-Klasse.

new ServiceBusAdministrationClient(connectionString: string, options?: ServiceBusAdministrationClientOptions)

Parameter

connectionString

string

Die Verbindungszeichenfolge, die für den Client zum Herstellen einer Verbindung mit Azure erforderlich ist.

options
ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

new ServiceBusAdministrationClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential, options?: ServiceBusAdministrationClientOptions)

Parameter

fullyQualifiedNamespace

string

Der vollqualifizierte Namespace Ihrer Service Bus-Instanz, der wahrscheinlich dem servicebus.windows.net ähnelt.

credential

TokenCredential | NamedKeyCredential

Ein Anmeldeinformationsobjekt, das vom Client verwendet wird, um das Token abzurufen, um die Verbindung mit dem Azure Service Bus zu authentifizieren. Informationen zum Erstellen der Anmeldeinformationen finden Sie unter @azure/Identität. Wenn Sie Ihre eigene Implementierung der TokenCredential Schnittstelle für AAD verwenden, legen Sie die "Bereiche" für Service-Bus so fest, dass das entsprechende Token abgerufen wird ["https://servicebus.azure.net//user_impersonation"] . Verwenden Sie from AzureNamedKeyCredential @azure/core-auth, wenn Sie und SharedAccessKeyNameSharedAccessKey ohne Verwendung einer Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem name Feld und key in AzureNamedKeyCredentialzugeordnet.

options
ServiceBusAdministrationClientOptions

PipelineOptions

Geerbte Eigenschaftsdetails

pipeline

Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird

pipeline: Pipeline

Eigenschaftswert

Geerbt von ServiceClient.pipeline

Details zur Methode

createQueue(string, CreateQueueOptions)

Erstellt eine Warteschlange mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert ist

function createQueue(queueName: string, options?: CreateQueueOptions): Promise<WithResponse<QueueProperties>>

Parameter

queueName

string

options
CreateQueueOptions

Optionen zum Konfigurieren der zu erstellenden Warteschlange (Sie können z. B. eine Warteschlange zur Unterstützung von Partitionen oder Sitzungen konfigurieren) und die Vorgangsoptionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

Erstellt eine Regel mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert wird.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parameter

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Definiert den Filterausdruck, den die Regel auswertet.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

Erstellt eine Regel mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert wird.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, ruleAction: SqlRuleAction, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parameter

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Definiert den Filterausdruck, den die Regel auswertet.

ruleAction
SqlRuleAction

Der SQL-ähnliche Ausdruck, der für die Nachricht ausgeführt werden kann, wenn der zugeordnete Filter angewendet wird.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

createSubscription(string, string, CreateSubscriptionOptions)

Erstellt ein Abonnement mit einem angegebenen Namen, das mithilfe der angegebenen Optionen konfiguriert ist

function createSubscription(topicName: string, subscriptionName: string, options?: CreateSubscriptionOptions): Promise<WithResponse<SubscriptionProperties>>

Parameter

topicName

string

subscriptionName

string

options
CreateSubscriptionOptions

Optionen zum Konfigurieren des zu erstellenden Abonnements (Sie können z. B. ein Abonnement für die Unterstützung von Partitionen oder Sitzungen konfigurieren) und die Vorgangsoptionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

createTopic(string, CreateTopicOptions)

Erstellt ein Thema mit einem angegebenen Namen, das mithilfe der angegebenen Optionen konfiguriert ist

function createTopic(topicName: string, options?: CreateTopicOptions): Promise<WithResponse<TopicProperties>>

Parameter

topicName

string

options
CreateTopicOptions

Optionen zum Konfigurieren des zu erstellenden Themas (Sie können z. B. ein Thema zur Unterstützung von Partitionen konfigurieren) und die Vorgangsoptionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen in der HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

deleteQueue(string, OperationOptions)

Löscht eine Warteschlange.

function deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameter

queueName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Löscht eine Regel.

function deleteRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameter

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Löscht ein Abonnement.

function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameter

topicName

string

subscriptionName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Löscht ein Thema.

function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameter

topicName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Gibt ein Objekt zurück, das die Metadaten im Zusammenhang mit einem Service Bus-Namespace darstellt.

function getNamespaceProperties(operationOptions?: OperationOptions): Promise<WithResponse<NamespaceProperties>>

Parameter

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Gibt zurück

getQueue(string, OperationOptions)

Gibt ein Objekt zurück, das die Warteschlange und ihre Eigenschaften darstellt. Wenn Sie die Warteschlangenlaufzeitinformationen wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie getQueueRuntimeProperties die API.

function getQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

Parameter

queueName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getQueueRuntimeProperties(string, OperationOptions)

Gibt ein Objekt zurück, das die Warteschlangenlaufzeitinformationen wie Details zur Nachrichtenanzahl darstellt.

function getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueRuntimeProperties>>

Parameter

queueName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getRule(string, string, string, OperationOptions)

Gibt ein Objekt zurück, das die Regel mit dem angegebenen Namen zusammen mit allen zugehörigen Eigenschaften darstellt.

function getRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parameter

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getSubscription(string, string, OperationOptions)

Gibt ein Objekt zurück, das das Abonnement und seine Eigenschaften darstellt. Wenn Sie die Informationen zur Abonnementlaufzeit wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie getSubscriptionRuntimeProperties die API.

function getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

Parameter

topicName

string

subscriptionName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Gibt ein Objekt zurück, das die Informationen zur Abonnementlaufzeit wie Details zur Nachrichtenanzahl darstellt.

function getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionRuntimeProperties>>

Parameter

topicName

string

subscriptionName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getTopic(string, OperationOptions)

Gibt ein Objekt zurück, das das Thema und seine Eigenschaften darstellt. Wenn Sie die Themenlaufzeitinformationen wie Details zur Abonnementanzahl abrufen möchten, verwenden Sie getTopicRuntimeProperties die API.

function getTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

Parameter

topicName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

getTopicRuntimeProperties(string, OperationOptions)

Gibt ein Objekt zurück, das die Themenlaufzeitinformationen wie die Abonnementanzahl darstellt.

function getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicRuntimeProperties>>

Parameter

topicName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

listQueues(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, der alle Warteschlangen auflistet.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Warteschlangen in Seiten auflisten zu können.

function listQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Parameter

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listQueuesRuntimeProperties(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zum Auflisten der Laufzeitinformationen der Warteschlangen zurück.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Warteschlangen auf Seiten auflisten.

function listQueuesRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Parameter

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listRules(string, string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, der alle Regeln unter dem angegebenen Abonnement auflistet.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Regeln auf Seiten auflisten zu können.

function listRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Parameter

topicName

string

subscriptionName

string

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listSubscriptions(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Abonnements unter dem angegebenen Thema aufzulisten.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Abonnements auf Seiten aufzulisten.

function listSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Parameter

topicName

string

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Abonnements unter dem angegebenen Thema aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen von Abonnements auf Seiten aufzulisten.

function listSubscriptionsRuntimeProperties(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Parameter

topicName

string

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listTopics(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Themen auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Themen auf Seiten auflisten zu können.

function listTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Parameter

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

listTopicsRuntimeProperties(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zum Auflisten der Laufzeitinformationen der Themen zurück.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Themen auf Seiten auflisten zu können.

function listTopicsRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Parameter

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

queueExists(string, OperationOptions)

Überprüft, ob eine bestimmte Warteschlange vorhanden ist oder nicht.

function queueExists(queueName: string, operationOptions?: OperationOptions): Promise<boolean>

Parameter

queueName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Gibt zurück

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Überprüft, ob eine bestimmte Regel vorhanden ist oder nicht.

function ruleExists(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<boolean>

Parameter

topicName

string

subscriptionName

string

ruleName

string

operationOptions
OperationOptions

Gibt zurück

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Überprüft, ob ein bestimmtes Abonnement im Thema vorhanden ist oder nicht.

function subscriptionExists(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<boolean>

Parameter

topicName

string

subscriptionName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Gibt zurück

Promise<boolean>

topicExists(string, OperationOptions)

Überprüft, ob ein bestimmtes Thema vorhanden ist.

function topicExists(topicName: string, operationOptions?: OperationOptions): Promise<boolean>

Parameter

topicName

string

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Gibt zurück

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Aktualisierungen die Warteschlange basierend auf den bereitgestellten Warteschlangeneigenschaften. Alle Warteschlangeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getQueue()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateQueue()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der QueueProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

function updateQueue(queue: WithResponse<QueueProperties>, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

Parameter

queue

WithResponse<QueueProperties>

Objekt, das die Eigenschaften der Warteschlange und die Unformatierte Antwort darstellt. requiresSession, requiresDuplicateDetection, enablePartitioningund name können nach dem Erstellen der Warteschlange nicht aktualisiert werden.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

Aktualisierungen Eigenschaften für die Regel anhand des angegebenen Namens basierend auf den angegebenen Optionen. Alle Regeleigenschaften müssen auch dann festgelegt werden, wenn eine davon aktualisiert wird. Daher ist der vorgeschlagene Flow, die Ausgabe von getRule()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateRule()übergeben.

function updateRule(topicName: string, subscriptionName: string, rule: WithResponse<RuleProperties>, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parameter

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

Optionen zum Konfigurieren der zu aktualisierenden Regel und der unformatierten Antwort. Beispielsweise können Sie den Filter so konfigurieren, dass er auf das zugeordnete Thema/Abonnement angewendet wird.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Aktualisierungen das Abonnement basierend auf den bereitgestellten Abonnementeigenschaften. Alle Abonnementeigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge davon tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getSubscription()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateSubscription()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der SubscriptionProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

function updateSubscription(subscription: WithResponse<SubscriptionProperties>, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

Parameter

subscription

WithResponse<SubscriptionProperties>

Objekt, das die Eigenschaften des Abonnements und die unformatierte Antwort darstellt. subscriptionName, topicNameund requiresSession können nach dem Erstellen des Abonnements nicht aktualisiert werden.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Aktualisierungen das Thema basierend auf den bereitgestellten Themeneigenschaften. Alle Themeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher ist der vorgeschlagene Flow, die Ausgabe von getTopic()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an zu updateTopic()übergeben.

Die Eigenschaften, die nicht aktualisiert werden können, werden in der TopicProperties Schnittstelle als schreibgeschützte Eigenschaften markiert.

function updateTopic(topic: WithResponse<TopicProperties>, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

Parameter

topic

WithResponse<TopicProperties>

Objekt, das die Eigenschaften des Themas und die unformatierte Antwort darstellt. requiresDuplicateDetection, enablePartitioningund name können nach dem Erstellen des Themas nicht aktualisiert werden.

operationOptions
OperationOptions

Die Optionen, die zum Abbrechen, Nachverfolgen und Steuern anderer Konfigurationen für die HTTP-Anforderung verwendet werden können.

Im Folgenden finden Sie Fehler, die bei diesem Vorgang erwartet werden können.

Gibt zurück

Details zur geerbten Methode

sendOperationRequest<T>(OperationArguments, OperationSpec)

Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameter

operationArguments
OperationArguments

Die Argumente, aus denen die Vorlagenwerte der HTTP-Anforderung aufgefüllt werden.

operationSpec
OperationSpec

Die OperationSpec, die zum Auffüllen von httpRequest verwendet werden soll.

Gibt zurück

Promise<T>

Geerbt von ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Senden Sie die bereitgestellte httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameter

request
PipelineRequest

Gibt zurück

Promise<PipelineResponse>

Geerbt von ServiceClient.sendRequest