Partilhar via


ServiceBusAdministrationClient class

Todas as operações devolvem promessas que são resolvidas para um objeto que tem o resultado relevante. Estes objetos também têm uma propriedade chamada _response que pode utilizar se quiser aceder à resposta direta do serviço.

Extends

Construtores

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicializa uma nova instância da classe ServiceBusAdministrationClient.

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Propriedades Herdadas

pipeline

O pipeline utilizado por este cliente para fazer pedidos

Métodos

createQueue(string, CreateQueueOptions)

Cria uma fila com um determinado nome, configurada com as opções especificadas

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

Cria uma regra com um determinado nome, configurada com as opções especificadas.

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

Cria uma regra com um determinado nome, configurada com as opções especificadas.

createSubscription(string, string, CreateSubscriptionOptions)

Cria uma subscrição com um determinado nome, configurada com as opções especificadas

createTopic(string, CreateTopicOptions)

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

deleteQueue(string, OperationOptions)

Elimina uma fila.

deleteRule(string, string, string, OperationOptions)

Elimina uma regra.

deleteSubscription(string, string, OperationOptions)

Elimina uma subscrição.

deleteTopic(string, OperationOptions)

Elimina um tópico.

getNamespaceProperties(OperationOptions)

Devolve um objeto que representa os metadados relacionados com um espaço de nomes do service bus.

getQueue(string, OperationOptions)

Devolve um objeto que representa a Fila e as respetivas propriedades. Se quiser obter as informações do runtime de fila, como os detalhes da contagem de mensagens, utilize getQueueRuntimeProperties a API.

getQueueRuntimeProperties(string, OperationOptions)

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

getRule(string, string, string, OperationOptions)

Devolve um objeto que representa a Regra com o nome especificado juntamente com todas as respetivas propriedades.

getSubscription(string, string, OperationOptions)

Devolve um objeto que representa a Subscrição e as respetivas propriedades. Se quiser obter as informações do runtime da Subscrição, como os detalhes da contagem de mensagens, utilize getSubscriptionRuntimeProperties a API.

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Devolve um objeto que representa as informações do runtime da Subscrição, como os detalhes da contagem de mensagens.

getTopic(string, OperationOptions)

Devolve um objeto que representa o Tópico e as respetivas propriedades. Se quiser obter as informações do runtime do Tópico, como os detalhes da contagem de subscrições, utilize getTopicRuntimeProperties a API.

getTopicRuntimeProperties(string, OperationOptions)

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

listQueues(OperationOptions)

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

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

listQueuesRuntimeProperties(OperationOptions)

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

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

listRules(string, string, OperationOptions)

Devolve um iterador iterável assíncrono para listar todas as regras na subscrição especificada.

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

listSubscriptions(string, OperationOptions)

Devolve um iterador iterável assíncrono para listar todas as subscrições no tópico especificado.

.byPage() devolve um iterador iterável assíncrono para listar as subscrições nas páginas.

listSubscriptionsRuntimeProperties(string, OperationOptions)

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

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

listTopics(OperationOptions)

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

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

listTopicsRuntimeProperties(OperationOptions)

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

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

queueExists(string, OperationOptions)

Verifica se existe ou não uma determinada fila.

ruleExists(string, string, string, OperationOptions)

Verifica se existe ou não uma determinada regra.

subscriptionExists(string, string, OperationOptions)

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

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 de fila fornecidas. Todas as propriedades da fila têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getQueue(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateQueue().

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

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

Atualizações propriedades na Regra pelo nome indicado com base nas opções especificadas. Todas as propriedades da regra têm de ser definidas mesmo que uma delas esteja a ser atualizada. Por conseguinte, o fluxo sugerido é utilizar a saída de getRule(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateRule().

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Atualizações a subscrição com base nas propriedades de subscrição fornecidas. Todas as propriedades da subscrição têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getSubscription(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateSubscription().

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

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Atualizações o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades do tópico têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getTopic(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateTopic().

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

Métodos Herdados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie um pedido HTTP que seja preenchido com 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 ligação necessária para que o cliente se ligue ao Azure.

options
ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parâmetros

fullyQualifiedNamespace

string

O espaço de nomes completamente qualificado da sua instância do Service Bus, que provavelmente será semelhante a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential

Um objeto de credencial utilizado pelo cliente para obter o token para autenticar a ligação com o Azure Service Bus. Veja @azure/identidade para criar as credenciais. Se estiver a utilizar a sua própria implementação da TokenCredential interface no AAD, defina os "âmbitos" do service-bus para ["https://servicebus.azure.net//user_impersonation"] obter o token adequado. Utilize a AzureNamedKeyCredential de @azure/core-auth se quiser transmitir um SharedAccessKeyName e SharedAccessKey sem utilizar uma cadeia de ligação. Estes campos mapeiam para o name campo e key , respetivamente, em AzureNamedKeyCredential.

options
ServiceBusAdministrationClientOptions

PipelineOptions

Detalhes da Propriedade Herdada

pipeline

O pipeline utilizado por este cliente para fazer pedidos

pipeline: Pipeline

Valor de Propriedade

Herdado de ServiceClient.pipeline

Detalhes de Método

createQueue(string, CreateQueueOptions)

Cria uma fila com um determinado nome, configurada com as opções especificadas

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

Parâmetros

queueName

string

options
CreateQueueOptions

Opções para configurar a Fila que está a ser criada (por exemplo, pode configurar uma fila para suportar partições ou sessões) e as opções de operação que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

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

Cria uma regra com um determinado nome, configurada com as opções especificadas.

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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

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

Cria uma regra com um determinado nome, configurada com as opções especificadas.

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 semelhante ao SQL que pode ser executada na mensagem deve aplicar-se o filtro associado.

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

createSubscription(string, string, CreateSubscriptionOptions)

Cria uma subscrição com um determinado nome, configurada com as opções especificadas

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

Parâmetros

topicName

string

subscriptionName

string

options
CreateSubscriptionOptions

Opções para configurar a Subscrição que está a ser criada (por exemplo, pode configurar uma Subscrição para suportar partições ou sessões) e as opções de operação que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

createTopic(string, CreateTopicOptions)

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

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

Parâmetros

topicName

string

options
CreateTopicOptions

Opções para configurar o Tópico que está a ser criado (por exemplo, pode configurar um tópico para suportar partições) e as opções de operação que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

deleteQueue(string, OperationOptions)

Elimina uma fila.

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

Parâmetros

queueName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Elimina 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Elimina uma subscrição.

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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Elimina um tópico.

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

Parâmetros

topicName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Devolve um objeto que representa os metadados relacionados com um espaço de nomes do service bus.

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

Parâmetros

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Devoluções

getQueue(string, OperationOptions)

Devolve um objeto que representa a Fila e as respetivas propriedades. Se quiser obter as informações do runtime de fila, como os detalhes da contagem de mensagens, utilize getQueueRuntimeProperties a API.

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

Parâmetros

queueName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getQueueRuntimeProperties(string, OperationOptions)

Devolve um objeto que representa as informações do runtime da fila, como os 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getRule(string, string, string, OperationOptions)

Devolve um objeto que representa a Regra com o nome especificado juntamente com todas as respetivas 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getSubscription(string, string, OperationOptions)

Devolve um objeto que representa a Subscrição e as respetivas propriedades. Se quiser obter as informações do runtime da Subscrição, como os detalhes da contagem de mensagens, utilize 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Devolve um objeto que representa as informações do runtime da Subscrição, como os 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getTopic(string, OperationOptions)

Devolve um objeto que representa o Tópico e as respetivas propriedades. Se quiser obter as informações do runtime do Tópico, como os detalhes da contagem de subscrições, utilize getTopicRuntimeProperties a API.

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

Parâmetros

topicName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

getTopicRuntimeProperties(string, OperationOptions)

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

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

Parâmetros

topicName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados nesta operação

Devoluções

listQueues(OperationOptions)

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

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

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

Parâmetros

Devoluções

Um asyncIterableIterator que suporta paginação.

listQueuesRuntimeProperties(OperationOptions)

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

.byPage() devolve 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

Devoluções

Um asyncIterableIterator que suporta paginação.

listRules(string, string, OperationOptions)

Devolve um iterador iterável assíncrono para listar todas as regras na subscrição especificada.

.byPage() devolve 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

Devoluções

Um asyncIterableIterator que suporta a paginação.

listSubscriptions(string, OperationOptions)

Devolve um iterador iterável assíncrono para listar todas as subscrições no tópico especificado.

.byPage() devolve um iterador iterável assíncrono para listar as subscrições nas páginas.

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

Parâmetros

topicName

string

Devoluções

Um asyncIterableIterator que suporta a paginação.

listSubscriptionsRuntimeProperties(string, OperationOptions)

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

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

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

Parâmetros

topicName

string

Devoluções

Um asyncIterableIterator que suporta a paginação.

listTopics(OperationOptions)

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

.byPage() devolve 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

Devoluções

Um asyncIterableIterator que suporta a paginação.

listTopicsRuntimeProperties(OperationOptions)

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

.byPage() devolve 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

Devoluções

Um asyncIterableIterator que suporta a paginação.

queueExists(string, OperationOptions)

Verifica se existe ou não uma determinada fila.

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

Parâmetros

queueName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Devoluções

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Verifica se existe ou não uma determinada regra.

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 existe ou não uma determinada subscrição no tópico.

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

Parâmetros

topicName

string

subscriptionName

string

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido 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 utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Devoluções

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Atualizações a fila com base nas propriedades de fila fornecidas. Todas as propriedades da fila têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getQueue(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateQueue().

As propriedades que não podem ser atualizadas são marcadas como só de 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 não processada. requiresSession, requiresDuplicateDetection, enablePartitioninge name não pode ser atualizado depois de criar a fila.

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados desta operação

Devoluções

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

Atualizações propriedades na Regra pelo nome indicado com base nas opções especificadas. Todas as propriedades da regra têm de ser definidas mesmo que uma delas esteja a ser atualizada. Por conseguinte, o fluxo sugerido é utilizar a saída de getRule(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir 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 a ser atualizada e a resposta não processada. Por exemplo, pode configurar o filtro para aplicar no Tópico/Subscrição associado.

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados desta operação

Devoluções

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Atualizações a subscrição com base nas propriedades de subscrição fornecidas. Todas as propriedades da subscrição têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getSubscription(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateSubscription().

As propriedades que não podem ser atualizadas são marcadas como só de 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 subscrição e a resposta não processada. subscriptionName, topicNamee requiresSession não pode ser atualizado depois de criar a subscrição.

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados desta operação

Devoluções

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Atualizações o tópico com base nas propriedades do tópico fornecidas. Todas as propriedades do tópico têm de ser definidas, embora apenas um subconjunto das mesmas seja realmente atualizável. Por conseguinte, o fluxo sugerido é utilizar a saída de getTopic(), atualizar as propriedades pretendidas no mesmo e, em seguida, transmitir o objeto modificado para updateTopic().

As propriedades que não podem ser atualizadas são marcadas como só de 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 não processada. requiresDuplicateDetection, enablePartitioninge name não pode ser atualizado depois de criar o tópico.

operationOptions
OperationOptions

As opções que podem ser utilizadas para abortar, rastrear e controlar outras configurações no pedido HTTP.

Seguem-se erros que podem ser esperados desta operação

Devoluções

Detalhes do Método Herdado

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie um pedido HTTP que seja preenchido com 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 do pedido HTTP serão preenchidos.

operationSpec
OperationSpec

O OperationSpec a utilizar 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