ServiceBusAdministrationClient class

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

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

Параметры

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

Параметры

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

pipeline: Pipeline

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

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

Параметры

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

Отправьте HTTP-запрос, который заполняется с помощью предоставленного operationSpec.

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

Параметры

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

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

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

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

Параметры

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

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