ServiceBusAdministrationClient class

Referência

Pacote:: @azure/service-bus

Todas as operações retornam promessas que são resolvidas para um objeto que tem a saída relevante. Esses objetos também têm uma propriedade chamada _response que você pode usar se quiser acessar a resposta direta do serviço.

Extends: ServiceClient

Construtores

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inicializa uma nova instância da classe ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Propriedades herdadas

pipeline

O pipeline usado por este cliente para fazer solicitações

Métodos

createQueue(string, CreateQueueOptions)	Cria uma fila com determinado nome, configurada usando as opções fornecidas
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Cria uma regra com determinado nome, configurada usando as opções fornecidas.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Cria uma regra com determinado nome, configurada usando as opções fornecidas.
createSubscription(string, string, CreateSubscriptionOptions)	Cria uma assinatura com determinado nome, configurada usando as opções fornecidas
createTopic(string, CreateTopicOptions)	Cria um tópico com determinado nome, configurado usando as opções fornecidas
deleteQueue(string, OperationOptions)	Exclui uma fila.
deleteRule(string, string, string, OperationOptions)	Exclui uma regra.
deleteSubscription(string, string, OperationOptions)	Exclui uma assinatura.
deleteTopic(string, OperationOptions)	Exclui um tópico.
getNamespaceProperties(OperationOptions)	Retorna um objeto que representa os metadados relacionados a um namespace do barramento de serviço.
getQueue(string, OperationOptions)	Retorna um objeto que representa a Fila e suas propriedades. Se você quiser obter as informações de runtime da fila, como detalhes da contagem de mensagens, use `getQueueRuntimeProperties` a API.
getQueueRuntimeProperties(string, OperationOptions)	Retorna um objeto que representa as informações de runtime da fila, como detalhes da contagem de mensagens.
getRule(string, string, string, OperationOptions)	Retorna um objeto que representa a Regra com o nome fornecido junto com todas as suas propriedades.
getSubscription(string, string, OperationOptions)	Retorna um objeto que representa a Assinatura e suas propriedades. Se você quiser obter as informações de runtime da assinatura, como detalhes da contagem de mensagens, use `getSubscriptionRuntimeProperties` a API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Retorna um objeto que representa as informações de runtime da assinatura, como detalhes da contagem de mensagens.
getTopic(string, OperationOptions)	Retorna um objeto que representa o Tópico e suas propriedades. Se você quiser obter as informações de runtime do Tópico, como detalhes da contagem de assinaturas, use `getTopicRuntimeProperties` a API.
getTopicRuntimeProperties(string, OperationOptions)	Retorna um objeto que representa as informações de runtime do Tópico, como a contagem de assinaturas.
listQueues(OperationOptions)	Retorna um iterador iterável assíncrono para listar todas as filas. .byPage() retorna um iterador iterável assíncrono para listar as filas nas páginas.
listQueuesRuntimeProperties(OperationOptions)	Retorna um iterador iterável assíncrono para listar informações de runtime das filas. .byPage() retorna um iterador iterável assíncrono para listar informações de runtime das filas nas páginas.
listRules(string, string, OperationOptions)	Retorna um iterador iterável assíncrono para listar todas as regras na assinatura especificada. .byPage() retorna um iterador iterável assíncrono para listar as regras em páginas.
listSubscriptions(string, OperationOptions)	Retorna um iterador iterável assíncrono para listar todas as assinaturas no tópico especificado. .byPage() retorna um iterador iterável assíncrono para listar as assinaturas em páginas.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Retorna um iterador iterável assíncrono para listar informações de runtime das assinaturas no tópico especificado. .byPage() retorna um iterador iterável assíncrono para listar informações de runtime de assinaturas em páginas.
listTopics(OperationOptions)	Retorna um iterador iterável assíncrono para listar todos os tópicos. .byPage() retorna um iterador iterável assíncrono para listar os tópicos em páginas.
listTopicsRuntimeProperties(OperationOptions)	Retorna um iterador iterável assíncrono para listar informações de runtime dos tópicos. .byPage() retorna um iterador iterável assíncrono para listar informações de runtime dos tópicos nas páginas.
queueExists(string, OperationOptions)	Verifica se uma determinada fila existe ou não.
ruleExists(string, string, string, OperationOptions)	Verifica se uma determinada regra existe ou não.
subscriptionExists(string, string, OperationOptions)	Verifica se uma determinada assinatura existe no tópico ou não.
topicExists(string, OperationOptions)	Verifica se um determinado tópico existe ou não.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Atualizações a fila com base nas propriedades da fila fornecidas. Todas as propriedades da fila devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de `getQueue()`, atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para `updateQueue()`. As propriedades que não podem ser atualizadas são marcadas como somente leitura na `QueueProperties` interface.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Atualizações propriedades na Regra pelo nome fornecido com base nas opções fornecidas. Todas as propriedades da regra devem ser definidas mesmo se uma delas estiver sendo atualizada. Portanto, o fluxo sugerido é usar a saída de `getRule()`, atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Atualizações a assinatura com base nas propriedades de assinatura fornecidas. Todas as propriedades de assinatura devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de `getSubscription()`, atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para `updateSubscription()`. As propriedades que não podem ser atualizadas são marcadas como somente leitura na `SubscriptionProperties` interface.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Atualizações o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades de tópico devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de `getTopic()`, atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para `updateTopic()`. As propriedades que não podem ser atualizadas são marcadas como somente leitura na `TopicProperties` interface.

Métodos herdados

sendOperationRequest<T>(OperationArguments, OperationSpec)	Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.
sendRequest(PipelineRequest)	Envie o httpRequest fornecido.

Detalhes do construtor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicializa uma nova instância da classe ServiceBusAdministrationClient.

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

Parâmetros

connectionString: string

A cadeia de conexão necessária para o cliente se conectar ao Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parâmetros

fullyQualifiedNamespace: string

O namespace totalmente qualificado da instância do Barramento de Serviço que provavelmente será semelhante a .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Um objeto de credencial usado pelo cliente para obter o token para autenticar a conexão com o Barramento de Serviço do Azure. Consulte @azure/identity para criar as credenciais. Se você estiver usando sua própria implementação da TokenCredential interface no AAD, defina os "escopos" para o barramento de serviço para ["https://servicebus.azure.net//user_impersonation"] obter o token apropriado. Use o AzureNamedKeyCredential de @azure/core-auth se você quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o name campo e key , respectivamente, em AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Detalhes das propriedades herdadas

pipeline

O pipeline usado por este cliente para fazer solicitações

pipeline: Pipeline

Valor da propriedade

Pipeline

Herdado de ServiceClient.pipeline

Detalhes do método

createQueue(string, CreateQueueOptions)

Cria uma fila com determinado nome, configurada usando as opções fornecidas

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

Parâmetros

queueName: string

options: CreateQueueOptions

Opções para configurar a Fila que está sendo criada (por exemplo, você pode configurar uma fila para dar suporte a partições ou sessões) e as opções de operação que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<QueueProperties>>

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

Cria uma regra com determinado nome, configurada usando as opções fornecidas.

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

Parâmetros

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Define a expressão de filtro avaliada pela regra.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<RuleProperties>>

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

Cria uma regra com determinado nome, configurada usando as opções fornecidas.

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

Parâmetros

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Define a expressão de filtro avaliada pela regra.

ruleAction: SqlRuleAction

A expressão semelhante ao SQL que pode ser executada na mensagem deve ser aplicada ao filtro associado.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Cria uma assinatura com determinado nome, configurada usando as opções fornecidas

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

Parâmetros

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Opções para configurar a Assinatura que está sendo criada (por exemplo, você pode configurar uma Assinatura para dar suporte a partições ou sessões) e as opções de operação que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Cria um tópico com determinado nome, configurado usando as opções fornecidas

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

Parâmetros

topicName: string

options: CreateTopicOptions

Opções para configurar o Tópico que está sendo criado (por exemplo, você pode configurar um tópico para dar suporte a partições) e as opções de operação que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Exclui uma fila.

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

Parâmetros

queueName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Exclui uma regra.

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

Parâmetros

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Exclui uma assinatura.

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

Parâmetros

topicName: string

subscriptionName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Exclui um tópico.

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

Parâmetros

topicName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Retorna um objeto que representa os metadados relacionados a um namespace do barramento de serviço.

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

Parâmetros

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Retornos

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Retorna um objeto que representa a Fila e suas propriedades. Se você quiser obter as informações de runtime da fila, como detalhes da contagem de mensagens, use getQueueRuntimeProperties a API.

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

Parâmetros

queueName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Retorna um objeto que representa as informações de runtime da fila, como detalhes da contagem de mensagens.

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

Parâmetros

queueName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Retorna um objeto que representa a Regra com o nome fornecido junto com todas as suas propriedades.

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

Parâmetros

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Retorna um objeto que representa a Assinatura e suas propriedades. Se você quiser obter as informações de runtime da assinatura, como detalhes da contagem de mensagens, use getSubscriptionRuntimeProperties a API.

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

Parâmetros

topicName: string

subscriptionName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Retorna um objeto que representa as informações de runtime da assinatura, como detalhes da contagem de mensagens.

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

Parâmetros

topicName: string

subscriptionName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Retorna um objeto que representa o Tópico e suas propriedades. Se você quiser obter as informações de runtime do Tópico, como detalhes da contagem de assinaturas, use getTopicRuntimeProperties a API.

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

Parâmetros

topicName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Retorna um objeto que representa as informações de runtime do Tópico, como a contagem de assinaturas.

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

Parâmetros

topicName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

A seguir estão os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Retorna um iterador iterável assíncrono para listar todas as filas.

.byPage() retorna um iterador iterável assíncrono para listar as filas nas páginas.

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

Parâmetros

options: OperationOptions

Retornos

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listQueuesRuntimeProperties(OperationOptions)

Retorna um iterador iterável assíncrono para listar informações de runtime das filas.

.byPage() retorna um iterador iterável assíncrono para listar informações de runtime das filas nas páginas.

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

Parâmetros

options: OperationOptions

Retornos

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listRules(string, string, OperationOptions)

Retorna um iterador iterável assíncrono para listar todas as regras na assinatura especificada.

.byPage() retorna um iterador iterável assíncrono para listar as regras em páginas.

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

Parâmetros

topicName: string

subscriptionName: string

options: OperationOptions

Retornos

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listSubscriptions(string, OperationOptions)

Retorna um iterador iterável assíncrono para listar todas as assinaturas no tópico especificado.

.byPage() retorna um iterador iterável assíncrono para listar as assinaturas em páginas.

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

Parâmetros

topicName: string

options: OperationOptions

Retornos

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Retorna um iterador iterável assíncrono para listar informações de runtime das assinaturas no tópico especificado.

.byPage() retorna um iterador iterável assíncrono para listar informações de runtime de assinaturas em páginas.

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

Parâmetros

topicName: string

options: OperationOptions

Retornos

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listTopics(OperationOptions)

Retorna um iterador iterável assíncrono para listar todos os tópicos.

.byPage() retorna um iterador iterável assíncrono para listar os tópicos em páginas.

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

Parâmetros

options: OperationOptions

Retornos

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listTopicsRuntimeProperties(OperationOptions)

Retorna um iterador iterável assíncrono para listar informações de runtime dos tópicos.

.byPage() retorna um iterador iterável assíncrono para listar informações de runtime dos tópicos nas páginas.

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

Parâmetros

options: OperationOptions

Retornos

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

queueExists(string, OperationOptions)

Verifica se uma determinada fila existe ou não.

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

Parâmetros

queueName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Retornos

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Verifica se uma determinada regra existe ou não.

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

Parâmetros

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Retornos

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Verifica se uma determinada assinatura existe no tópico ou não.

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

Parâmetros

topicName: string

subscriptionName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Retornos

Promise<boolean>

topicExists(string, OperationOptions)

Verifica se um determinado tópico existe ou não.

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

Parâmetros

topicName: string

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Retornos

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Atualizações a fila com base nas propriedades da fila fornecidas. Todas as propriedades da fila devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de getQueue(), atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para updateQueue().

As propriedades que não podem ser atualizadas são marcadas como somente leitura na QueueProperties interface.

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

Parâmetros

queue: WithResponse<QueueProperties>

Objeto que representa as propriedades da fila e a resposta bruta. requiresSession, requiresDuplicateDetection, enablePartitioninge name não podem ser atualizados após a criação da fila.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Veja a seguir os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<QueueProperties>>

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

Atualizações propriedades na Regra pelo nome fornecido com base nas opções fornecidas. Todas as propriedades da regra devem ser definidas mesmo se uma delas estiver sendo atualizada. Portanto, o fluxo sugerido é usar a saída de getRule(), atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para updateRule().

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

Parâmetros

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Opções para configurar a Regra que está sendo atualizada e a resposta bruta. Por exemplo, você pode configurar o filtro a ser aplicado no Tópico/Assinatura associado.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Veja a seguir os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Atualizações a assinatura com base nas propriedades de assinatura fornecidas. Todas as propriedades de assinatura devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de getSubscription(), atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para updateSubscription().

As propriedades que não podem ser atualizadas são marcadas como somente leitura na SubscriptionProperties interface.

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

Parâmetros

subscription: WithResponse<SubscriptionProperties>

Objeto que representa as propriedades da assinatura e a resposta bruta. subscriptionName, topicNamee requiresSession não podem ser atualizados após a criação da assinatura.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Veja a seguir os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Atualizações o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades de tópico devem ser definidas mesmo que apenas um subconjunto delas seja realmente atualizável. Portanto, o fluxo sugerido é usar a saída de getTopic(), atualizar as propriedades desejadas nele e, em seguida, passar o objeto modificado para updateTopic().

As propriedades que não podem ser atualizadas são marcadas como somente leitura na TopicProperties interface.

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

Parâmetros

topic: WithResponse<TopicProperties>

Objeto que representa as propriedades do tópico e a resposta bruta. requiresDuplicateDetection, enablePartitioninge name não podem ser atualizados após a criação do tópico.

operationOptions: OperationOptions

As opções que podem ser usadas para anular, rastrear e controlar outras configurações na solicitação HTTP.

Veja a seguir os erros que podem ser esperados nesta operação

Retornos

Promise<WithResponse<TopicProperties>>

Detalhes do método herdado

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments: OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec: OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

Retornos

Promise<T>

Herdado de ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envie o httpRequest fornecido.

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

Parâmetros

request: PipelineRequest

Retornos

Promise<PipelineResponse>

Herdado de ServiceClient.sendRequest

Compartilhar via

ServiceBusAdministrationClient class

Construtores

Propriedades herdadas

Métodos

Métodos herdados

Detalhes do construtor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parâmetros

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parâmetros

Detalhes das propriedades herdadas

pipeline

Valor da propriedade

Detalhes do método

createQueue(string, CreateQueueOptions)

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

createSubscription(string, string, CreateSubscriptionOptions)

Parâmetros

Retornos

createTopic(string, CreateTopicOptions)

Parâmetros

Retornos

deleteQueue(string, OperationOptions)

Parâmetros

Retornos

deleteRule(string, string, string, OperationOptions)

Parâmetros

Retornos

deleteSubscription(string, string, OperationOptions)

Parâmetros

Retornos

deleteTopic(string, OperationOptions)

Parâmetros

Retornos

getNamespaceProperties(OperationOptions)

Parâmetros

Retornos

getQueue(string, OperationOptions)

Parâmetros

Retornos

getQueueRuntimeProperties(string, OperationOptions)

Parâmetros

Retornos

getRule(string, string, string, OperationOptions)

Parâmetros

Retornos

getSubscription(string, string, OperationOptions)

Parâmetros

Retornos

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parâmetros

Retornos

getTopic(string, OperationOptions)

Parâmetros

Retornos

getTopicRuntimeProperties(string, OperationOptions)

Parâmetros

Retornos

listQueues(OperationOptions)

Parâmetros

Retornos

listQueuesRuntimeProperties(OperationOptions)

Parâmetros

Retornos

listRules(string, string, OperationOptions)

Parâmetros

Retornos

listSubscriptions(string, OperationOptions)

Parâmetros

Retornos

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parâmetros