ServiceBusAdministrationClient class

Paquete:

@azure/service-bus

Todas las operaciones devuelven promesas que se resuelven en un objeto que tiene la salida pertinente. Estos objetos también tienen una propiedad denominada _response que puede usar si desea acceder a la respuesta directa desde el servicio.

Extends

ServiceClient

Constructores

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inicializa una nueva instancia de la clase ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Propiedades heredadas

pipeline

Canalización usada por este cliente para realizar solicitudes

Métodos

createQueue(string, CreateQueueOptions)	Crea una cola con un nombre determinado, configurada con las opciones especificadas.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Crea una regla con un nombre determinado, configurado mediante las opciones especificadas.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Crea una regla con un nombre determinado, configurado mediante las opciones especificadas.
createSubscription(string, string, CreateSubscriptionOptions)	Crea una suscripción con un nombre determinado, configurado con las opciones especificadas.
createTopic(string, CreateTopicOptions)	Crea un tema con un nombre determinado, configurado con las opciones especificadas.
deleteQueue(string, OperationOptions)	Elimina una cola.
deleteRule(string, string, string, OperationOptions)	Elimina una regla.
deleteSubscription(string, string, OperationOptions)	Elimina una suscripción.
deleteTopic(string, OperationOptions)	Elimina un tema.
getNamespaceProperties(OperationOptions)	Devuelve un objeto que representa los metadatos relacionados con un espacio de nombres de Service Bus.
getQueue(string, OperationOptions)	Devuelve un objeto que representa la cola y sus propiedades. Si desea obtener la información de Queue Runtime, como los detalles del recuento de mensajes, use la getQueueRuntimeProperties API.
getQueueRuntimeProperties(string, OperationOptions)	Devuelve un objeto que representa la información del tiempo de ejecución de cola, como los detalles del recuento de mensajes.
getRule(string, string, string, OperationOptions)	Devuelve un objeto que representa la regla con el nombre especificado junto con todas sus propiedades.
getSubscription(string, string, OperationOptions)	Devuelve un objeto que representa la suscripción y sus propiedades. Si desea obtener la información del entorno de ejecución de la suscripción, como los detalles del recuento de mensajes, use la getSubscriptionRuntimeProperties API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Devuelve un objeto que representa la información del entorno de ejecución de la suscripción, como los detalles del recuento de mensajes.
getTopic(string, OperationOptions)	Devuelve un objeto que representa el tema y sus propiedades. Si desea obtener la información del entorno de ejecución del tema, como los detalles del recuento de suscripciones, use la getTopicRuntimeProperties API.
getTopicRuntimeProperties(string, OperationOptions)	Devuelve un objeto que representa la información del entorno de ejecución del tema, como el recuento de suscripciones.
listQueues(OperationOptions)	Devuelve un iterador asincrónico para enumerar todas las colas. .byPage() devuelve un iterador asincrónico para enumerar las colas de las páginas.
listQueuesRuntimeProperties(OperationOptions)	Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las colas. .byPage() devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las colas en las páginas.
listRules(string, string, OperationOptions)	Devuelve un iterador asincrónico para enumerar todas las reglas de la suscripción especificada. .byPage() devuelve un iterador asincrónico para enumerar las reglas de las páginas.
listSubscriptions(string, OperationOptions)	Devuelve un iterador asincrónico para enumerar todas las suscripciones del tema especificado. .byPage() devuelve un iterador asincrónico para enumerar las suscripciones de las páginas.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las suscripciones en el tema especificado. .byPage() devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las suscripciones en las páginas.
listTopics(OperationOptions)	Devuelve un iterador asincrónico para enumerar todos los temas. .byPage() devuelve un iterador asincrónico para enumerar los temas de las páginas.
listTopicsRuntimeProperties(OperationOptions)	Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de los temas. .byPage() devuelve un iterador iterable asincrónico para enumerar la información en tiempo de ejecución de los temas de las páginas.
queueExists(string, OperationOptions)	Comprueba si existe o no una cola determinada.
ruleExists(string, string, string, OperationOptions)	Comprueba si existe o no una regla determinada.
subscriptionExists(string, string, OperationOptions)	Comprueba si existe una suscripción determinada en el tema o no.
topicExists(string, OperationOptions)	Comprueba si existe o no un tema determinado.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Novedades la cola en función de las propiedades de cola proporcionadas. Todas las propiedades de la cola deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getQueue(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateQueue(). Las propiedades que no se pueden actualizar se marcan como de solo lectura en la QueueProperties interfaz.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Novedades propiedades en la regla por el nombre especificado en función de las opciones especificadas. Todas las propiedades de regla deben establecerse aunque se actualice una de ellas. Por lo tanto, el flujo sugerido es usar la salida de getRule(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateRule().
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Novedades la suscripción en función de las propiedades de la suscripción proporcionadas. Todas las propiedades de suscripción deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getSubscription(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateSubscription(). Las propiedades que no se pueden actualizar se marcan como de solo lectura en la SubscriptionProperties interfaz.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Novedades el tema en función de las propiedades del tema proporcionadas. Todas las propiedades del tema deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getTopic(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateTopic(). Las propiedades que no se pueden actualizar se marcan como de solo lectura en la TopicProperties interfaz.

Métodos heredados

sendOperationRequest<T>(OperationArguments, OperationSpec)	Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.
sendRequest(PipelineRequest)	Envíe el httpRequest proporcionado.

Detalles del constructor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicializa una nueva instancia de la clase ServiceBusAdministrationClient.

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

Parámetros

connectionString

string

Cadena de conexión necesaria para que el cliente se conecte a Azure.

options

ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parámetros

fullyQualifiedNamespace

string

Espacio de nombres completo de la instancia de Service Bus que probablemente sea similar a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential

Objeto de credencial usado por el cliente para obtener el token para autenticar la conexión con el Azure Service Bus. Consulte @azure/identity para crear las credenciales. Si usa su propia implementación de la TokenCredential interfaz en AAD, establezca los "ámbitos" para que service-bus sea ["https://servicebus.azure.net//user_impersonation"] para obtener el token adecuado. Use from AzureNamedKeyCredential @azure/core-auth si desea pasar un SharedAccessKeyName elemento y SharedAccessKey sin usar una cadena de conexión. Estos campos se asignan al name campo y key respectivamente en AzureNamedKeyCredential.

options

ServiceBusAdministrationClientOptions

PipelineOptions

Detalles de las propiedades heredadas

pipeline

Canalización usada por este cliente para realizar solicitudes

pipeline: Pipeline

Valor de propiedad

Pipeline

Heredado de ServiceClient.pipeline

Detalles del método

createQueue(string, CreateQueueOptions)

Crea una cola con un nombre determinado, configurada con las opciones especificadas.

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

Parámetros

queueName

string

options

CreateQueueOptions

Opciones para configurar la cola que se va a crear (por ejemplo, puede configurar una cola para admitir particiones o sesiones) y las opciones de operación que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<QueueProperties>>

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

Crea una regla con un nombre determinado, configurado mediante las opciones 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 la expresión de filtro que evalúa la regla.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<RuleProperties>>

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

Crea una regla con un nombre determinado, configurado mediante las opciones 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 la expresión de filtro que evalúa la regla.

ruleAction

SqlRuleAction

La expresión sql like que se puede ejecutar en el mensaje debe aplicar el filtro asociado.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Crea una suscripción con un nombre determinado, configurado con las opciones especificadas.

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

Parámetros

topicName

string

subscriptionName

string

options

CreateSubscriptionOptions

Opciones para configurar la suscripción que se va a crear (por ejemplo, puede configurar una suscripción para admitir particiones o sesiones) y las opciones de operación que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Crea un tema con un nombre determinado, configurado con las opciones especificadas.

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

Parámetros

topicName

string

options

CreateTopicOptions

Opciones para configurar el tema que se va a crear (por ejemplo, puede configurar un tema para admitir particiones) y las opciones de operación que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Elimina una cola.

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

Parámetros

queueName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Elimina una regla.

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

Parámetros

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Elimina una suscripción.

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

Parámetros

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Elimina un tema.

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

Parámetros

topicName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Devuelve un objeto que representa los metadatos relacionados con un espacio de nombres de Service Bus.

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

Parámetros

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

Devoluciones

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Devuelve un objeto que representa la cola y sus propiedades. Si desea obtener la información de Queue Runtime, como los detalles del recuento de mensajes, use la getQueueRuntimeProperties API.

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

Parámetros

queueName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Devuelve un objeto que representa la información del tiempo de ejecución de cola, como los detalles del recuento de mensajes.

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

Parámetros

queueName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Devuelve un objeto que representa la regla con el nombre especificado junto con todas sus propiedades.

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

Parámetros

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Devuelve un objeto que representa la suscripción y sus propiedades. Si desea obtener la información del entorno de ejecución de la suscripción, como los detalles del recuento de mensajes, use la getSubscriptionRuntimeProperties API.

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

Parámetros

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Devuelve un objeto que representa la información del entorno de ejecución de la suscripción, como los detalles del recuento de mensajes.

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

Parámetros

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Devuelve un objeto que representa el tema y sus propiedades. Si desea obtener la información del entorno de ejecución del tema, como los detalles del recuento de suscripciones, use la getTopicRuntimeProperties API.

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

Parámetros

topicName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Devuelve un objeto que representa la información del entorno de ejecución del tema, como el recuento de suscripciones.

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

Parámetros

topicName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Devuelve un iterador asincrónico para enumerar todas las colas.

.byPage() devuelve un iterador asincrónico para enumerar las colas de las páginas.

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

Parámetros

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listQueuesRuntimeProperties(OperationOptions)

Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las colas.

.byPage() devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las colas en las páginas.

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

Parámetros

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listRules(string, string, OperationOptions)

Devuelve un iterador asincrónico para enumerar todas las reglas de la suscripción especificada.

.byPage() devuelve un iterador asincrónico para enumerar las reglas de las páginas.

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

Parámetros

topicName

string

subscriptionName

string

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listSubscriptions(string, OperationOptions)

Devuelve un iterador asincrónico para enumerar todas las suscripciones del tema especificado.

.byPage() devuelve un iterador asincrónico para enumerar las suscripciones de las páginas.

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

Parámetros

topicName

string

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las suscripciones en el tema especificado.

.byPage() devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de las suscripciones en las páginas.

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

Parámetros

topicName

string

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listTopics(OperationOptions)

Devuelve un iterador asincrónico para enumerar todos los temas.

.byPage() devuelve un iterador asincrónico para enumerar los temas de las páginas.

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

Parámetros

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

listTopicsRuntimeProperties(OperationOptions)

Devuelve un iterador asincrónico para enumerar la información en tiempo de ejecución de los temas.

.byPage() devuelve un iterador iterable asincrónico para enumerar la información en tiempo de ejecución de los temas de las páginas.

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

Parámetros

options

OperationOptions

Devoluciones

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator que admite la paginación.

queueExists(string, OperationOptions)

Comprueba si existe o no una cola determinada.

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

Parámetros

queueName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

Devoluciones

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Comprueba si existe o no una regla determinada.

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

Parámetros

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Devoluciones

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Comprueba si existe una suscripción determinada en el tema o no.

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

Parámetros

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

Devoluciones

Promise<boolean>

topicExists(string, OperationOptions)

Comprueba si existe o no un tema determinado.

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

Parámetros

topicName

string

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

Devoluciones

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Novedades la cola en función de las propiedades de cola proporcionadas. Todas las propiedades de la cola deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getQueue(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateQueue().

Las propiedades que no se pueden actualizar se marcan como de solo lectura en la QueueProperties interfaz.

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

Parámetros

queue

WithResponse<QueueProperties>

Objeto que representa las propiedades de la cola y la respuesta sin procesar. requiresSession, requiresDuplicateDetection, enablePartitioningy name no se pueden actualizar después de crear la cola.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<QueueProperties>>

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

Novedades propiedades en la regla por el nombre especificado en función de las opciones especificadas. Todas las propiedades de regla deben establecerse aunque se actualice una de ellas. Por lo tanto, el flujo sugerido es usar la salida de getRule(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateRule().

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

Parámetros

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

Opciones para configurar la regla que se actualiza y la respuesta sin procesar. Por ejemplo, puede configurar el filtro para que se aplique en el tema o la suscripción asociados.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Novedades la suscripción en función de las propiedades de la suscripción proporcionadas. Todas las propiedades de suscripción deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getSubscription(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateSubscription().

Las propiedades que no se pueden actualizar se marcan como de solo lectura en la SubscriptionProperties interfaz.

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

Parámetros

subscription

WithResponse<SubscriptionProperties>

Objeto que representa las propiedades de la suscripción y la respuesta sin procesar. subscriptionName, topicNamey requiresSession no se pueden actualizar después de crear la suscripción.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Novedades el tema en función de las propiedades del tema proporcionadas. Todas las propiedades del tema deben establecerse aunque solo un subconjunto de ellas sea realmente actualizable. Por lo tanto, el flujo sugerido es usar la salida de getTopic(), actualizar las propiedades deseadas en él y, a continuación, pasar el objeto modificado a updateTopic().

Las propiedades que no se pueden actualizar se marcan como de solo lectura en la TopicProperties interfaz.

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

Parámetros

topic

WithResponse<TopicProperties>

Objeto que representa las propiedades del tema y la respuesta sin procesar. requiresDuplicateDetection, enablePartitioningy name no se pueden actualizar después de crear el tema.

operationOptions

OperationOptions

Las opciones que se pueden usar para anular, realizar un seguimiento y controlar otras configuraciones en la solicitud HTTP.

A continuación se muestran los errores que se pueden esperar de esta operación.

Devoluciones

Promise<WithResponse<TopicProperties>>

Detalles de los métodos heredados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

operationArguments

OperationArguments

Argumentos de los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec

OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

Devoluciones

Promise<T>

Heredado de ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envíe el httpRequest proporcionado.

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

Parámetros

request

PipelineRequest

Devoluciones

Promise<PipelineResponse>

Heredado de ServiceClient.sendRequest