ServiceBusAdministrationClient class

Referenz

Paket:: @azure/service-bus

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

Extends: ServiceClient

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 verwendet wird, um Anforderungen zu stellen

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 ist.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Erstellt eine Regel mit dem angegebenen Namen, die mithilfe der angegebenen Optionen konfiguriert ist.
createSubscription(string, string, CreateSubscriptionOptions)	Erstellt ein Abonnement mit einem bestimmten Namen, konfiguriert mithilfe der angegebenen Optionen
createTopic(string, CreateTopicOptions)	Erstellt ein Thema mit dem 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 Servicebusnamespace darstellt.
getQueue(string, OperationOptions)	Gibt ein Objekt zurück, das die Warteschlange und die zugehörigen Eigenschaften darstellt. Wenn Sie die Informationen zur Warteschlangenlaufzeit wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie `getQueueRuntimeProperties`-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 dessen Eigenschaften darstellt. Wenn Sie die Abonnementlaufzeitinformationen wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie `getSubscriptionRuntimeProperties`-API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Gibt ein Objekt zurück, das die Abonnementlaufzeitinformationen wie Details zur Anzahl von Nachrichten darstellt.
getTopic(string, OperationOptions)	Gibt ein Objekt zurück, das das Thema und dessen Eigenschaften darstellt. Wenn Sie die Informationen zur Themenlaufzeit wie Details zur Abonnementanzahl abrufen möchten, verwenden Sie `getTopicRuntimeProperties`-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, um alle Warteschlangen auflisten zu können. .byPage() gibt einen asynchronen iterablen Iterator zurück, um die Warteschlangen auf Seiten auflisten zu können.
listQueuesRuntimeProperties(OperationOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Warteschlangen auflisten zu können. .byPage() gibt einen asynchronen iterablen Iterator zurück, um Laufzeitinformationen der Warteschlangen auf Seiten auflisten.
listRules(string, string, OperationOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um alle Regeln unter dem angegebenen Abonnement auflisten zu können. .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 auflisten zu können. .byPage() gibt einen asynchronen iterablen Iterator zurück, um die Abonnements auf Seiten auflisten zu können.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Abonnements unter dem angegebenen Thema auflisten zu können. .byPage() gibt einen asynchronen iterablen Iterator zurück, um Laufzeitinformationen von Abonnements auf Seiten auflisten.
listTopics(OperationOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um alle Themen auflisten zu können. .byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Themen auf Seiten auflisten.
listTopicsRuntimeProperties(OperationOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Themen auflisten zu können. .byPage() gibt einen asynchronen iterablen Iterator zurück, um Laufzeitinformationen der Themen auf Seiten auflisten.
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 oder nicht.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Aktualisiert die Warteschlange basierend auf den bereitgestellten Warteschlangeneigenschaften. Alle Warteschlangeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge dieser Eigenschaften tatsächlich aktualisierbar ist. Daher besteht der vorgeschlagene Fluss darin, die Ausgabe von `getQueue()`zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an `updateQueue()`zu übergeben. Die nicht aktualisierten Eigenschaften werden in der `QueueProperties`-Schnittstelle als schreibgeschützt gekennzeichnet.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Aktualisiert die Eigenschaften der Regel anhand der angegebenen Optionen anhand des angegebenen Namens. Alle Regeleigenschaften müssen festgelegt werden, auch wenn eine dieser Eigenschaften aktualisiert wird. Daher besteht der vorgeschlagene Fluss darin, die Ausgabe von `getRule()`zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an `updateRule()`zu übergeben.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Aktualisiert das Abonnement basierend auf den bereitgestellten Abonnementeigenschaften. Alle Abonnementeigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher besteht der vorgeschlagene Fluss darin, die Ausgabe von `getSubscription()`zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an `updateSubscription()`zu übergeben. Die nicht aktualisierten Eigenschaften werden in der `SubscriptionProperties`-Schnittstelle als schreibgeschützt gekennzeichnet.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Aktualisiert das Thema basierend auf den bereitgestellten Themeneigenschaften. Alle Themeneigenschaften müssen festgelegt werden, obwohl nur eine Teilmenge von ihnen tatsächlich aktualisierbar ist. Daher besteht der vorgeschlagene Fluss darin, die Ausgabe von `getTopic()`zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an `updateTopic()`zu übergeben. Die nicht aktualisierten Eigenschaften werden in der `TopicProperties`-Schnittstelle als schreibgeschützt gekennzeichnet.

Geerbte Methoden

sendOperationRequest<T>(OperationArguments, OperationSpec)	Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten 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 erforderlich ist, um eine Verbindung mit Azure herzustellen.

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 mit .servicebus.windows.net vergleichbar ist.

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" fest, damit der Servicebus ["https://servicebus.azure.net//user_impersonation"] wird, um das entsprechende Token abzurufen. Verwenden Sie die AzureNamedKeyCredential aus @azure/Core-Auth, wenn Sie eine SharedAccessKeyName und SharedAccessKey ohne Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem feld name bzw. key feld in AzureNamedKeyCredentialzugeordnet.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Geerbte Eigenschaftsdetails

pipeline

Die Pipeline, die von diesem Client verwendet wird, um Anforderungen zu stellen

pipeline: Pipeline

Eigenschaftswert

Pipeline

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 für die Unterstützung von Partitionen oder Sitzungen 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 von diesem Vorgang erwartet werden können.

Gibt zurück

Promise<WithResponse<QueueProperties>>

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

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

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<RuleProperties>>

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

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

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, sollte der zugeordnete Filter angewendet werden.

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

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

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 (Beispielsweise können Sie ein Abonnement für die Unterstützung von Partitionen oder Sitzungen 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 von diesem Vorgang erwartet werden können.

Gibt zurück

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Erstellt ein Thema mit dem 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 für die 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 von diesem Vorgang erwartet werden können.

Gibt zurück

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Löscht eine Warteschlange.

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

Parameter

queueName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Im Folgenden finden Sie Fehler, die von 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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Im Folgenden finden Sie Fehler, die von 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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Im Folgenden finden Sie Fehler, die von 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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Im Folgenden finden Sie Fehler, die von 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 Servicebusnamespace darstellt.

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

Parameter

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Gibt zurück

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Gibt ein Objekt zurück, das die Warteschlange und die zugehörigen Eigenschaften darstellt. Wenn Sie die Informationen zur Warteschlangenlaufzeit wie Details zur Nachrichtenanzahl abrufen möchten, verwenden Sie getQueueRuntimeProperties-API.

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

Parameter

queueName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<QueueProperties>>

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<QueueRuntimeProperties>>

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

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

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Gibt ein Objekt zurück, das die Abonnementlaufzeitinformationen wie Details zur Anzahl von Nachrichten darstellt.

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

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

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

Parameter

topicName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<TopicProperties>>

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

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

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

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

Parameter

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listQueuesRuntimeProperties(OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Warteschlangen auflisten zu können.

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

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

Parameter

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listRules(string, string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Regeln unter dem angegebenen Abonnement auflisten zu können.

.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

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listSubscriptions(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Abonnements unter dem angegebenen Thema auflisten zu können.

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

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

Parameter

topicName: string

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um Laufzeitinformationen der Abonnements unter dem angegebenen Thema auflisten zu können.

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

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

Parameter

topicName: string

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

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 iterierbaren Iterator zurück, um die Themen auf Seiten auflisten.

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

Parameter

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listTopicsRuntimeProperties(OperationOptions)

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

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

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

Parameter

options: OperationOptions

Gibt zurück

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert 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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Gibt zurück

Promise<boolean>

topicExists(string, OperationOptions)

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

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

Parameter

topicName: string

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

Gibt zurück

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

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

Die nicht aktualisierten Eigenschaften werden in der QueueProperties-Schnittstelle als schreibgeschützt gekennzeichnet.

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

Parameter

queue: WithResponse<QueueProperties>

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

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<QueueProperties>>

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

Aktualisiert die Eigenschaften der Regel anhand der angegebenen Optionen anhand des angegebenen Namens. Alle Regeleigenschaften müssen festgelegt werden, auch wenn eine dieser Eigenschaften aktualisiert wird. Daher besteht der vorgeschlagene Fluss darin, die Ausgabe von getRule()zu verwenden, die gewünschten Eigenschaften darin zu aktualisieren und dann das geänderte Objekt an updateRule()zu ü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. Sie können z. B. den Filter so konfigurieren, dass er auf zugeordnetes Thema/Abonnement angewendet wird.

operationOptions: OperationOptions

Die Optionen, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

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

Die nicht aktualisierten Eigenschaften werden in der SubscriptionProperties-Schnittstelle als schreibgeschützt gekennzeichnet.

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

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

Die nicht aktualisierten Eigenschaften werden in der TopicProperties-Schnittstelle als schreibgeschützt gekennzeichnet.

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, mit denen andere Konfigurationen in der HTTP-Anforderung abgebrochen, nachverfolgt und gesteuert werden können.

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

Gibt zurück

Promise<WithResponse<TopicProperties>>

Details zur geerbten Methode

sendOperationRequest<T>(OperationArguments, OperationSpec)

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

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

Parameter

operationArguments: OperationArguments

Die Argumente, aus denen die vorlagenbasierten Werte der HTTP-Anforderung ausgefüllt werden.

operationSpec: OperationSpec

Die OperationSpec, die zum Auffüllen der 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

Freigeben über

ServiceBusAdministrationClient class

Konstruktoren

Geerbte Eigenschaften

Methoden

Geerbte Methoden

Details zum Konstruktor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parameter

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parameter

Geerbte Eigenschaftsdetails

pipeline

Eigenschaftswert

Details zur Methode

createQueue(string, CreateQueueOptions)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createSubscription(string, string, CreateSubscriptionOptions)

Parameter

Gibt zurück

createTopic(string, CreateTopicOptions)

Parameter

Gibt zurück

deleteQueue(string, OperationOptions)

Parameter

Gibt zurück

deleteRule(string, string, string, OperationOptions)

Parameter

Gibt zurück

deleteSubscription(string, string, OperationOptions)

Parameter

Gibt zurück

deleteTopic(string, OperationOptions)

Parameter

Gibt zurück

getNamespaceProperties(OperationOptions)

Parameter

Gibt zurück

getQueue(string, OperationOptions)

Parameter

Gibt zurück

getQueueRuntimeProperties(string, OperationOptions)

Parameter

Gibt zurück

getRule(string, string, string, OperationOptions)

Parameter

Gibt zurück

getSubscription(string, string, OperationOptions)

Parameter

Gibt zurück

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parameter

Gibt zurück

getTopic(string, OperationOptions)

Parameter

Gibt zurück

getTopicRuntimeProperties(string, OperationOptions)

Parameter

Gibt zurück

listQueues(OperationOptions)

Parameter

Gibt zurück

listQueuesRuntimeProperties(OperationOptions)

Parameter

Gibt zurück

listRules(string, string, OperationOptions)

Parameter

Gibt zurück

listSubscriptions(string, OperationOptions)

Parameter

Gibt zurück

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parameter