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)	Возвращает объект , представляющий объект Queue и ее свойства. Если вы хотите получить сведения о среде выполнения очередей, например сведения о количестве сообщений, используйте `getQueueRuntimeProperties` API.
getQueueRuntimeProperties(string, OperationOptions)	Возвращает объект , представляющий сведения о среде выполнения очереди, например сведения о количестве сообщений.
getRule(string, string, string, OperationOptions)	Возвращает объект , представляющий правило с заданным именем и всеми его свойствами.
getSubscription(string, string, OperationOptions)	Возвращает объект , представляющий подписку и ее свойства. Если вы хотите получить сведения о среде выполнения подписки, например сведения о количестве сообщений, используйте `getSubscriptionRuntimeProperties` API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Возвращает объект , представляющий сведения о времени выполнения подписки, например сведения о количестве сообщений.
getTopic(string, OperationOptions)	Возвращает объект , представляющий объект Topic и его свойства. Если вы хотите получить сведения о среде выполнения раздела, например сведения о количестве подписок, используйте `getTopicRuntimeProperties` API.
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-запрос, который заполняется с помощью предоставленного operationSpec.
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 Используйте параметр from @azure/core-auth, если вы хотите передать и SharedAccessKeyNameSharedAccessKey без использования строки подключения. Эти поля сопоставляют с полем 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)

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

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)

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

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)

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

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-запрос, который заполняется с помощью предоставленного operationSpec.

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

Параметры

operationArguments: OperationArguments

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

operationSpec: OperationSpec

Параметр OperationSpec, используемый для заполнения httpRequest.

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

Promise<T>

Наследуется от ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

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

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

Параметры

request: PipelineRequest

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

Promise<PipelineResponse>

Наследуется от ServiceClient.sendRequest

Share via

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)

Параметры