ServiceBusAdministrationClient class

Pacote:

@azure/service-bus

Todas as operações retornam promessas que resolvem 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 nome próprio, configurada usando as opções fornecidas
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Cria uma regra com nome próprio, configurada usando as opções fornecidas.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Cria uma regra com nome próprio, configurada usando as opções fornecidas.
createSubscription(string, string, CreateSubscriptionOptions)	Cria uma assinatura com nome próprio, configurada usando as opções fornecidas
createTopic(string, CreateTopicOptions)	Cria um tópico com nome próprio, 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 de 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 tempo de execução da fila, como detalhes da contagem de mensagens, use getQueueRuntimeProperties API.
getQueueRuntimeProperties(string, OperationOptions)	Retorna um objeto que representa as informações de tempo de execução da fila, como detalhes da contagem de mensagens.
getRule(string, string, string, OperationOptions)	Retorna um objeto que representa a Regra com o nome próprio 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 tempo de execução da assinatura, como detalhes da contagem de mensagens, use getSubscriptionRuntimeProperties API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Retorna um objeto que representa as informações de tempo de execução da Assinatura, como detalhes da contagem de mensagens.
getTopic(string, OperationOptions)	Retorna um objeto que representa o Topic e suas propriedades. Se você quiser obter as informações de tempo de execução do tópico, como detalhes da contagem de assinaturas, use getTopicRuntimeProperties API.
getTopicRuntimeProperties(string, OperationOptions)	Retorna um objeto que representa as informações de tempo de execução 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 tempo de execução das filas. .byPage() retorna um iterador iterável assíncrono para listar informações de tempo de execução 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 nas 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 nas páginas.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Retorna um iterador iterável assíncrono para listar informações de tempo de execução das assinaturas sob o tópico especificado. .byPage() retorna um iterador iterável assíncrono para listar informações de tempo de execução de assinaturas em páginas.
listTopics(OperationOptions)	Retorna um iterador assíncrono iterável para listar todos os tópicos. .byPage() retorna um iterador iterável assíncrono para listar os tópicos nas páginas.
listTopicsRuntimeProperties(OperationOptions)	Retorna um iterador iterável assíncrono para listar informações de tempo de execução dos tópicos. .byPage() retorna um iterador iterável assíncrono para listar informações de tempo de execução 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 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 interface QueueProperties.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Atualiza as propriedades na Regra pelo nome fornecido com base nas opções fornecidas. Todas as propriedades da regra devem ser definidas, mesmo que uma delas esteja 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 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 interface SubscriptionProperties.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Atualiza o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades do 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 interface TopicProperties.

Métodos Herdados

sendOperationRequest<T>(OperationArguments, OperationSpec)	Envie uma solicitação HTTP que é 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

Opções de Pipeline

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 Service Bus, que provavelmente será semelhante ao <seunamespace.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 interface TokenCredential em relação ao AAD, defina os "escopos" para o service-bus a ser ["https://servicebus.azure.net//user_impersonation"] para obter o token apropriado. Use o AzureNamedKeyCredential de @azure/core-auth se quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o campo name e key, respectivamente, em AzureNamedKeyCredential.

options

ServiceBusAdministrationClientOptions

Opções de Pipeline

Detalhes da Propriedade Herdada

pipeline

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

pipeline: Pipeline

Valor de Propriedade

Pipeline

herdado de ServiceClient.pipeline

Detalhes de Método

createQueue(string, CreateQueueOptions)

Cria uma fila com nome próprio, 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 suportar partições ou sessões) e as opções de operação que podem ser usadas para abortar, rastrear e controlar outras configurações na solicitação HTTP.

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

Devoluções

Promise<WithResponse<QueueProperties>>

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

Cria uma regra com nome próprio, 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 que a regra avalia.

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 desta operação

Devoluções

Promise<WithResponse<RuleProperties>>

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

Cria uma regra com nome próprio, 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 que a regra avalia.

ruleAction

SqlRuleAction

A expressão SQL like que pode ser executada na mensagem caso o filtro associado seja aplicado.

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 desta operação

Devoluções

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Cria uma assinatura com nome próprio, 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 suportar partições ou sessões) e as opções de operação que podem ser usadas para abortar, rastrear e controlar outras configurações na solicitação HTTP.

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

Devoluções

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Cria um tópico com nome próprio, 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 suportar 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 desta operação

Devoluções

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 desta operação

Devoluções

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 desta operação

Devoluções

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 desta operação

Devoluções

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 desta operação

Devoluções

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Retorna um objeto que representa os metadados relacionados a um namespace de 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.

Devoluções

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Retorna um objeto que representa a fila e suas propriedades. Se você quiser obter as informações de tempo de execução da fila, como detalhes da contagem de mensagens, use getQueueRuntimeProperties 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 desta operação

Devoluções

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Retorna um objeto que representa as informações de tempo de execução 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 desta operação

Devoluções

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Retorna um objeto que representa a Regra com o nome próprio 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 desta operação

Devoluções

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 tempo de execução da assinatura, como detalhes da contagem de mensagens, use getSubscriptionRuntimeProperties 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 desta operação

Devoluções

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Retorna um objeto que representa as informações de tempo de execução 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 desta operação

Devoluções

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Retorna um objeto que representa o Topic e suas propriedades. Se você quiser obter as informações de tempo de execução do tópico, como detalhes da contagem de assinaturas, use getTopicRuntimeProperties 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 desta operação

Devoluções

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Retorna um objeto que representa as informações de tempo de execução 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 desta operação

Devoluções

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

Devoluções

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Um asyncIterableIterator que suporta paginação.

listQueuesRuntimeProperties(OperationOptions)

Retorna um iterador iterável assíncrono para listar informações de tempo de execução das filas.

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

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

Parâmetros

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Um asyncIterableIterator que suporta 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 nas páginas.

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

Parâmetros

topicName

string

subscriptionName

string

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Um asyncIterableIterator que suporta 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 nas páginas.

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

Parâmetros

topicName

string

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Um asyncIterableIterator que suporta paginação.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Retorna um iterador iterável assíncrono para listar informações de tempo de execução das assinaturas sob o tópico especificado.

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

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

Parâmetros

topicName

string

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Um asyncIterableIterator que suporta paginação.

listTopics(OperationOptions)

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

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

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

Parâmetros

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Um asyncIterableIterator que suporta paginação.

listTopicsRuntimeProperties(OperationOptions)

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

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

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

Parâmetros

options

OperationOptions

Devoluções

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Um asyncIterableIterator que suporta 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.

Devoluções

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

Devoluções

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.

Devoluções

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.

Devoluções

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Atualiza 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 interface QueueProperties.

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.

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

Devoluções

Promise<WithResponse<QueueProperties>>

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

Atualiza as propriedades na Regra pelo nome fornecido com base nas opções fornecidas. Todas as propriedades da regra devem ser definidas, mesmo que uma delas esteja 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 para 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.

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

Devoluções

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Atualiza 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 interface SubscriptionProperties.

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.

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

Devoluções

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Atualiza o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades do 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 interface TopicProperties.

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.

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

Devoluções

Promise<WithResponse<TopicProperties>>

Detalhes do Método Herdado

sendOperationRequest<T>(OperationArguments, OperationSpec)

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

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

Parâmetros

operationArguments

OperationArguments

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

operationSpec

OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

Devoluções

Promise<T>

herdado de ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envie o httpRequest fornecido.

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

Parâmetros

request

PipelineRequest

Devoluções

Promise<PipelineResponse>

herdado de ServiceClient.sendRequest