ServiceBusAdministrationClient class

Ссылка

Пакет:: @azure/service-bus

Все операции возвращают обещания, разрешающие объекту с соответствующими выходными данными. Эти объекты также имеют свойство с именем _response, которое можно использовать, если вы хотите получить прямой ответ от службы.

Extends: ServiceClient

Конструкторы

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Инициализирует новый экземпляр класса ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Унаследованные свойства

pipeline

Конвейер, используемый этим клиентом для выполнения запросов

Методы

createQueue(string, CreateQueueOptions)	Создает очередь с заданным именем, настроенную с помощью заданных параметров
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Создает правило с заданным именем, настроенным с помощью заданных параметров.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Создает правило с заданным именем, настроенным с помощью заданных параметров.
createSubscription(string, string, CreateSubscriptionOptions)	Создает подписку с заданным именем, настроенную с помощью заданных параметров
createTopic(string, CreateTopicOptions)	Создает раздел с заданным именем, настроенный с помощью заданных параметров
deleteQueue(string, OperationOptions)	Удаляет очередь.
deleteRule(string, string, string, OperationOptions)	Удаляет правило.
deleteSubscription(string, string, OperationOptions)	Удаляет подписку.
deleteTopic(string, OperationOptions)	Удаляет раздел.
getNamespaceProperties(OperationOptions)	Возвращает объект, представляющий метаданные, связанные с пространством имен служебной шины.
getQueue(string, OperationOptions)	Возвращает объект, представляющий очередь и его свойства. Если вы хотите получить сведения о среде выполнения очереди, например сведения о количестве сообщений, используйте API `getQueueRuntimeProperties`.
getQueueRuntimeProperties(string, OperationOptions)	Возвращает объект, представляющий сведения о среде выполнения очереди, например сведения о количестве сообщений.
getRule(string, string, string, OperationOptions)	Возвращает объект, представляющий правило с заданным именем, а также все его свойства.
getSubscription(string, string, OperationOptions)	Возвращает объект, представляющий подписку и его свойства. Если вы хотите получить сведения о среде выполнения подписки, например сведения о количестве сообщений, используйте API `getSubscriptionRuntimeProperties`.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Возвращает объект, представляющий сведения о среде выполнения подписки, такие как сведения о количестве сообщений.
getTopic(string, OperationOptions)	Возвращает объект, представляющий раздел и его свойства. Если вы хотите получить сведения о среде выполнения раздела, такие как сведения о количестве подписок, используйте API `getTopicRuntimeProperties`.
getTopicRuntimeProperties(string, OperationOptions)	Возвращает объект, представляющий сведения о среде выполнения темы, такие как количество подписок.
listQueues(OperationOptions)	Возвращает асинхронный итератор для перечисления всех очередей. .byPage() возвращает асинхронный итератор для перечисления очередей на страницах.
listQueuesRuntimeProperties(OperationOptions)	Возвращает асинхронный итератор для перечисления сведений о среде выполнения очередей. .byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения очередей на страницах.
listRules(string, string, OperationOptions)	Возвращает асинхронный итератор для перечисления всех правил в указанной подписке. .byPage() возвращает асинхронный итератор для перечисления правил на страницах.
listSubscriptions(string, OperationOptions)	Возвращает асинхронный итератор для перечисления всех подписок в указанном разделе. .byPage() возвращает асинхронный итератор для перечисления подписок на страницах.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Возвращает асинхронный итератор для перечисления сведений о среде выполнения подписок в указанном разделе. .byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения подписок на страницах.
listTopics(OperationOptions)	Возвращает асинхронный итератор для перечисления всех разделов. .byPage() возвращает асинхронный итератор для перечисления тем на страницах.
listTopicsRuntimeProperties(OperationOptions)	Возвращает асинхронный итератор для перечисления сведений о среде выполнения тем. .byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения тем на страницах.
queueExists(string, OperationOptions)	Проверяет, существует ли данная очередь или нет.
ruleExists(string, string, string, OperationOptions)	Проверяет, существует ли данное правило или нет.
subscriptionExists(string, string, OperationOptions)	Проверяет, существует ли данная подписка в разделе или нет.
topicExists(string, OperationOptions)	Проверяет, существует ли данный раздел или нет.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Обновляет очередь на основе указанных свойств очереди. Все свойства очереди должны быть заданы, хотя только подмножество из них фактически обновляется. Поэтому предлагаемый поток — использовать выходные данные из `getQueue()`, обновить требуемые свойства в нем, а затем передать измененный объект в `updateQueue()`. Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе `QueueProperties`.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Обновляет свойства правила по заданному имени на основе заданных параметров. Все свойства правила должны быть заданы, даже если одно из них обновляется. Поэтому предлагаемый поток — использовать выходные данные из `getRule()`, обновить требуемые свойства в нем, а затем передать измененный объект в `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Обновляет подписку на основе указанных свойств подписки. Все свойства подписки должны быть заданы, хотя только подмножество из них фактически обновлялось. Поэтому предлагаемый поток — использовать выходные данные из `getSubscription()`, обновить требуемые свойства в нем, а затем передать измененный объект в `updateSubscription()`. Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе `SubscriptionProperties`.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Обновляет раздел на основе предоставленных свойств раздела. Все свойства раздела должны быть заданы, даже если только подмножество из них фактически обновляется. Поэтому предлагаемый поток — использовать выходные данные из `getTopic()`, обновить требуемые свойства в нем, а затем передать измененный объект в `updateTopic()`. Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе `TopicProperties`.

Наследуемые методы

sendOperationRequest<T>(OperationArguments, OperationSpec)	Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.
sendRequest(PipelineRequest)	Отправьте предоставленный httpRequest.

Сведения о конструкторе

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Инициализирует новый экземпляр класса ServiceBusAdministrationClient.

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

Параметры

connectionString: string

Строка подключения, необходимая для подключения клиента к Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Параметры

fullyQualifiedNamespace: string

Полное пространство имен экземпляра служебной шины, которое, скорее всего, будет похоже на .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Объект учетных данных, используемый клиентом для проверки подлинности соединения с служебной шиной Azure. Сведения о создании учетных данных см. в разделе @azure/identity. Если вы используете собственную реализацию интерфейса TokenCredential для AAD, задайте для служебной шины ["https://servicebus.azure.net//user_impersonation"] для получения соответствующего маркера. Используйте AzureNamedKeyCredential из @azure/core-auth, если вы хотите передать SharedAccessKeyName и SharedAccessKey без использования строки подключения. Эти поля сопоставляют с полем name и key соответственно в AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Сведения об унаследованном свойстве

pipeline

Конвейер, используемый этим клиентом для выполнения запросов

pipeline: Pipeline

Значение свойства

Pipeline

унаследован от ServiceClient.pipeline

Сведения о методе

createQueue(string, CreateQueueOptions)

Создает очередь с заданным именем, настроенную с помощью заданных параметров

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

Параметры

queueName: string

options: CreateQueueOptions

Параметры настройки создаваемой очереди (например, можно настроить очередь для поддержки секций или сеансов) и параметры операции, которые можно использовать для прерывания, трассировки и управления другими конфигурациями в HTTP-запросе.

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<QueueProperties>>

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

Создает правило с заданным именем, настроенным с помощью заданных параметров.

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

Параметры

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Определяет выражение фильтра, которое вычисляет правило.

operationOptions: OperationOptions

Параметры, которые можно использовать для прерывания, трассировки и управления другими конфигурациями в HTTP-запросе.

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<RuleProperties>>

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

Создает правило с заданным именем, настроенным с помощью заданных параметров.

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

Параметры

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Определяет выражение фильтра, которое вычисляет правило.

ruleAction: SqlRuleAction

Sql, например выражение, которое может быть выполнено в сообщении, должно применяться связанный фильтр.

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Создает подписку с заданным именем, настроенную с помощью заданных параметров

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

Параметры

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Параметры настройки создаваемой подписки (например, вы можете настроить подписку для поддержки секций или сеансов) и параметры операции, которые можно использовать для прерывания, трассировки и управления другими конфигурациями в HTTP-запросе.

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Создает раздел с заданным именем, настроенный с помощью заданных параметров

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

Параметры

topicName: string

options: CreateTopicOptions

Параметры настройки создаваемого раздела (например, можно настроить раздел для поддержки секций) и параметры операции, которые можно использовать для прерывания, трассировки и управления другими конфигурациями в HTTP-запросе.

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Удаляет очередь.

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

Параметры

queueName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Удаляет правило.

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

Параметры

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Удаляет подписку.

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

Параметры

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Удаляет раздел.

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

Параметры

topicName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Возвращает объект, представляющий метаданные, связанные с пространством имен служебной шины.

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

Параметры

operationOptions: OperationOptions

Возвращаемое значение

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Возвращает объект, представляющий очередь и его свойства. Если вы хотите получить сведения о среде выполнения очереди, например сведения о количестве сообщений, используйте API getQueueRuntimeProperties.

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

Параметры

queueName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Возвращает объект, представляющий сведения о среде выполнения очереди, например сведения о количестве сообщений.

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

Параметры

queueName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Возвращает объект, представляющий правило с заданным именем, а также все его свойства.

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

Параметры

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Возвращает объект, представляющий подписку и его свойства. Если вы хотите получить сведения о среде выполнения подписки, например сведения о количестве сообщений, используйте API getSubscriptionRuntimeProperties.

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

Параметры

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Возвращает объект, представляющий сведения о среде выполнения подписки, такие как сведения о количестве сообщений.

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

Параметры

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Возвращает объект, представляющий раздел и его свойства. Если вы хотите получить сведения о среде выполнения раздела, такие как сведения о количестве подписок, используйте API getTopicRuntimeProperties.

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

Параметры

topicName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Возвращает объект, представляющий сведения о среде выполнения темы, такие как количество подписок.

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

Параметры

topicName: string

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Возвращает асинхронный итератор для перечисления всех очередей.

.byPage() возвращает асинхронный итератор для перечисления очередей на страницах.

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

Параметры

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listQueuesRuntimeProperties(OperationOptions)

Возвращает асинхронный итератор для перечисления сведений о среде выполнения очередей.

.byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения очередей на страницах.

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

Параметры

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listRules(string, string, OperationOptions)

Возвращает асинхронный итератор для перечисления всех правил в указанной подписке.

.byPage() возвращает асинхронный итератор для перечисления правил на страницах.

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

Параметры

topicName: string

subscriptionName: string

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listSubscriptions(string, OperationOptions)

Возвращает асинхронный итератор для перечисления всех подписок в указанном разделе.

.byPage() возвращает асинхронный итератор для перечисления подписок на страницах.

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

Параметры

topicName: string

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Возвращает асинхронный итератор для перечисления сведений о среде выполнения подписок в указанном разделе.

.byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения подписок на страницах.

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

Параметры

topicName: string

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listTopics(OperationOptions)

Возвращает асинхронный итератор для перечисления всех разделов.

.byPage() возвращает асинхронный итератор для перечисления тем на страницах.

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

Параметры

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

listTopicsRuntimeProperties(OperationOptions)

Возвращает асинхронный итератор для перечисления сведений о среде выполнения тем.

.byPage() возвращает асинхронный итератор для перечисления сведений о среде выполнения тем на страницах.

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

Параметры

options: OperationOptions

Возвращаемое значение

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

queueExists(string, OperationOptions)

Проверяет, существует ли данная очередь или нет.

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

Параметры

queueName: string

operationOptions: OperationOptions

Возвращаемое значение

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Проверяет, существует ли данное правило или нет.

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

Параметры

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Возвращаемое значение

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Проверяет, существует ли данная подписка в разделе или нет.

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

Параметры

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Возвращаемое значение

Promise<boolean>

topicExists(string, OperationOptions)

Проверяет, существует ли данный раздел или нет.

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

Параметры

topicName: string

operationOptions: OperationOptions

Возвращаемое значение

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Обновляет очередь на основе указанных свойств очереди. Все свойства очереди должны быть заданы, хотя только подмножество из них фактически обновляется. Поэтому предлагаемый поток — использовать выходные данные из getQueue(), обновить требуемые свойства в нем, а затем передать измененный объект в updateQueue().

Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе QueueProperties.

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

Параметры

queue: WithResponse<QueueProperties>

Объект, представляющий свойства очереди и необработанный ответ. requiresSession, requiresDuplicateDetection, enablePartitioningи name невозможно обновить после создания очереди.

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<QueueProperties>>

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

Обновляет свойства правила по заданному имени на основе заданных параметров. Все свойства правила должны быть заданы, даже если одно из них обновляется. Поэтому предлагаемый поток — использовать выходные данные из getRule(), обновить требуемые свойства в нем, а затем передать измененный объект в updateRule().

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

Параметры

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Параметры настройки обновляемого правила и необработанного ответа. Например, можно настроить фильтр для применения к связанному разделу или подписке.

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Обновляет подписку на основе указанных свойств подписки. Все свойства подписки должны быть заданы, хотя только подмножество из них фактически обновлялось. Поэтому предлагаемый поток — использовать выходные данные из getSubscription(), обновить требуемые свойства в нем, а затем передать измененный объект в updateSubscription().

Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе SubscriptionProperties.

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

Параметры

subscription: WithResponse<SubscriptionProperties>

Объект, представляющий свойства подписки и необработанный ответ. subscriptionName, topicNameи requiresSession невозможно обновить после создания подписки.

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Обновляет раздел на основе предоставленных свойств раздела. Все свойства раздела должны быть заданы, даже если только подмножество из них фактически обновляется. Поэтому предлагаемый поток — использовать выходные данные из getTopic(), обновить требуемые свойства в нем, а затем передать измененный объект в updateTopic().

Свойства, которые не могут быть обновлены, помечены как чтение в интерфейсе TopicProperties.

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

Параметры

topic: WithResponse<TopicProperties>

Объект, представляющий свойства раздела и необработанный ответ. requiresDuplicateDetection, enablePartitioningи name невозможно обновить после создания раздела.

operationOptions: OperationOptions

Ниже приведены ошибки, которые можно ожидать от этой операции.

Возвращаемое значение

Promise<WithResponse<TopicProperties>>

Сведения о наследуемом методе

sendOperationRequest<T>(OperationArguments, OperationSpec)

Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.

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

Параметры

operationArguments: OperationArguments

Аргументы, из которыми будут заполнены шаблонные значения HTTP-запроса.

operationSpec: OperationSpec

ОперацияSpec, используемая для заполнения httpRequest.

Возвращаемое значение

Promise<T>

унаследован от ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Отправьте предоставленный httpRequest.

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

Параметры

request: PipelineRequest

Возвращаемое значение

Promise<PipelineResponse>

наследуется от serviceClient.sendRequest

Поделиться через

ServiceBusAdministrationClient class

Конструкторы

Унаследованные свойства

Методы

Наследуемые методы

Сведения о конструкторе

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Параметры

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Параметры

Сведения об унаследованном свойстве

pipeline

Значение свойства

Сведения о методе

createQueue(string, CreateQueueOptions)

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

createSubscription(string, string, CreateSubscriptionOptions)

Параметры

Возвращаемое значение

createTopic(string, CreateTopicOptions)

Параметры

Возвращаемое значение

deleteQueue(string, OperationOptions)

Параметры

Возвращаемое значение

deleteRule(string, string, string, OperationOptions)

Параметры

Возвращаемое значение

deleteSubscription(string, string, OperationOptions)

Параметры

Возвращаемое значение

deleteTopic(string, OperationOptions)

Параметры

Возвращаемое значение

getNamespaceProperties(OperationOptions)

Параметры

Возвращаемое значение

getQueue(string, OperationOptions)

Параметры

Возвращаемое значение

getQueueRuntimeProperties(string, OperationOptions)

Параметры

Возвращаемое значение

getRule(string, string, string, OperationOptions)

Параметры

Возвращаемое значение

getSubscription(string, string, OperationOptions)

Параметры

Возвращаемое значение

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Параметры

Возвращаемое значение

getTopic(string, OperationOptions)

Параметры

Возвращаемое значение

getTopicRuntimeProperties(string, OperationOptions)

Параметры

Возвращаемое значение

listQueues(OperationOptions)

Параметры

Возвращаемое значение

listQueuesRuntimeProperties(OperationOptions)

Параметры

Возвращаемое значение

listRules(string, string, OperationOptions)

Параметры

Возвращаемое значение

listSubscriptions(string, OperationOptions)

Параметры

Возвращаемое значение

listSubscriptionsRuntimeProperties(string, OperationOptions)

Параметры