ServiceBusAdministrationClient Clase

Paquete:

com.azure.messaging.servicebus.administration

Artefacto Maven:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient

public final class ServiceBusAdministrationClient

Un cliente sincrónico para administrar un espacio de nombres de Service Bus. Se crean instancias a través de ServiceBusAdministrationClientBuilder.

Ejemplo: Creación del cliente asincrónico

En el ejemplo de código siguiente se muestra la creación del cliente de administración asincrónica. La credencial usada en el ejemplo siguiente es DefaultAzureCredential para la autenticación. Es adecuado para la mayoría de los escenarios, incluidos los entornos de desarrollo y producción locales. Además, se recomienda usar la identidad administrada para la autenticación en entornos de producción. Puede encontrar más información sobre las distintas formas de autenticación y sus tipos de credenciales correspondientes en la documentación de Azure Identity.

HttpLogOptions logOptions = new HttpLogOptions()
     .setLogLevel(HttpLogDetailLevel.HEADERS);

 // DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, tokenCredential)
     .httpLogOptions(logOptions)
     .buildClient();

Ejemplo: Creación de una cola

En el ejemplo siguiente se crea una cola con valores predeterminados. Los valores predeterminados se muestran en CreateQueueOptions().

QueueProperties queue = client.createQueue("my-new-queue");
 System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
     queue.getName(), queue.getLockDuration());

Ejemplo: Edición de una suscripción existente

En el ejemplo de código siguiente se muestra cómo actualizar una suscripción existente. Los usuarios deben capturar las propiedades de la suscripción, modificar las propiedades y, a continuación, pasar el objeto para actualizar el método.

// To update the subscription we have to:
 // 1. Get the subscription info from the service.
 // 2. Update the SubscriptionProperties we want to change.
 // 3. Call the updateSubscription() with the updated object.
 SubscriptionProperties subscription = client.getSubscription("my-topic", "my-subscription");

 System.out.println("Original delivery count: " + subscription.getMaxDeliveryCount());

 // Updating it to a new value.
 subscription.setMaxDeliveryCount(5);

 // Persisting the updates to the subscription object.
 SubscriptionProperties updated = client.updateSubscription(subscription);

 System.out.printf("Subscription updated. Name: %s. Delivery count: %s.%n",
     updated.getSubscriptionName(), updated.getMaxDeliveryCount());

Ejemplo: Enumeración de todas las colas

En el ejemplo de código siguiente se enumeran todas las colas del espacio de nombres de Service Bus.

client.listQueues().forEach(queue -> {
     System.out.printf("Queue [%s]. Lock Duration: %s.%n",
         queue.getName(), queue.getLockDuration());
 });

Ejemplo: Eliminar cola

En el ejemplo de código siguiente se muestra cómo eliminar una cola existente.

try {
     client.deleteQueue("my-existing-queue");
 } catch (AzureException exception) {
     System.err.println("Exception occurred deleting queue: " + exception);
 }

Resumen del método

Modificador y tipo	Método y descripción
QueueProperties	createQueue(String queueName) Crea una cola con el nombre especificado.
QueueProperties	createQueue(String queueName, CreateQueueOptions queueOptions) Crea una cola con .CreateQueueOptions
Response<QueueProperties>	createQueueWithResponse(String queueName, CreateQueueOptions queueOptions, Context context) Crea una cola y devuelve la cola creada además de la respuesta HTTP.
RuleProperties	createRule(String topicName, String subscriptionName, String ruleName) Crea una regla en el tema y la suscripción especificados.
RuleProperties	createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions) Crea una regla con .CreateRuleOptions
Response<RuleProperties>	createRuleWithResponse(String topicName, String subscriptionName, String ruleName, CreateRuleOptions ruleOptions, Context context) Crea una regla y devuelve la regla creada además de la respuesta HTTP.
SubscriptionProperties	createSubscription(String topicName, String subscriptionName) Crea una suscripción con los nombres de suscripción y el tema especificados.
SubscriptionProperties	createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions) Crea una suscripción con .CreateSubscriptionOptions
SubscriptionProperties	createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions) Crea una suscripción con una regla predeterminada mediante y CreateSubscriptionOptionsCreateRuleOptions.
Response<SubscriptionProperties>	createSubscriptionWithResponse(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions, Context context) Crea una suscripción y devuelve la suscripción creada además de la respuesta HTTP.
Response<SubscriptionProperties>	createSubscriptionWithResponse(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions, Context context) Crea una suscripción con una regla predeterminada configurada y devuelve la suscripción creada además de la respuesta HTTP.
TopicProperties	createTopic(String topicName) Crea un tema con el nombre especificado.
TopicProperties	createTopic(String topicName, CreateTopicOptions topicOptions) Crea un tema con CreateTopicOptions.
Response<TopicProperties>	createTopicWithResponse(String topicName, CreateTopicOptions topicOptions, Context context) Crea un tema y devuelve el tema creado además de la respuesta HTTP.
void	deleteQueue(String queueName) Elimina una cola que coincide con queueName.
Response<Void>	deleteQueueWithResponse(String queueName, Context context) Elimina una cola que coincide queueName y devuelve la respuesta HTTP.
void	deleteRule(String topicName, String subscriptionName, String ruleName) Elimina una regla que coincide con ruleName.
Response<Void>	deleteRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context) Elimina una regla que coincide ruleName y devuelve la respuesta HTTP.
void	deleteSubscription(String topicName, String subscriptionName) Elimina una suscripción que coincide con en el subscriptionName tema topicName.
Response<Void>	deleteSubscriptionWithResponse(String topicName, String subscriptionName, Context context) Elimina una suscripción que coincide subscriptionName y devuelve la respuesta HTTP.
void	deleteTopic(String topicName) Elimina un tema que coincide con topicName.
Response<Void>	deleteTopicWithResponse(String topicName, Context context) Elimina un tema que coincide topicName y devuelve la respuesta HTTP.
NamespaceProperties	getNamespaceProperties() Obtiene información sobre el espacio de nombres de Service Bus.
Response<NamespaceProperties>	getNamespacePropertiesWithResponse(Context context) Obtiene información sobre el espacio de nombres de Service Bus junto con su respuesta HTTP.
QueueProperties	getQueue(String queueName) Obtiene información sobre la cola.
boolean	getQueueExists(String queueName) Obtiene si existe una cola con queueName en el espacio de nombres de Service Bus.
Response<Boolean>	getQueueExistsWithResponse(String queueName, Context context) Obtiene si existe una cola con queueName en el espacio de nombres de Service Bus.
QueueRuntimeProperties	getQueueRuntimeProperties(String queueName) Obtiene las propiedades en tiempo de ejecución sobre la cola.
Response<QueueRuntimeProperties>	getQueueRuntimePropertiesWithResponse(String queueName, Context context) Obtiene las propiedades en tiempo de ejecución de la cola junto con su respuesta HTTP.
Response<QueueProperties>	getQueueWithResponse(String queueName, Context context) Obtiene información sobre la cola junto con su respuesta HTTP.
RuleProperties	getRule(String topicName, String subscriptionName, String ruleName) Obtiene una regla del espacio de nombres del servicio.
Response<RuleProperties>	getRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context) Obtiene una regla del espacio de nombres del servicio.
SubscriptionProperties	getSubscription(String topicName, String subscriptionName) Obtiene información sobre la cola.
boolean	getSubscriptionExists(String topicName, String subscriptionName) Obtiene si existe una suscripción dentro de un tema.
Response<Boolean>	getSubscriptionExistsWithResponse(String topicName, String subscriptionName, Context context) Obtiene si existe una suscripción dentro de un tema.
SubscriptionRuntimeProperties	getSubscriptionRuntimeProperties(String topicName, String subscriptionName) Obtiene las propiedades en tiempo de ejecución sobre la suscripción.
Response<SubscriptionRuntimeProperties>	getSubscriptionRuntimePropertiesWithResponse(String topicName, String subscriptionName, Context context) Obtiene las propiedades en tiempo de ejecución sobre la suscripción.
Response<SubscriptionProperties>	getSubscriptionWithResponse(String topicName, String subscriptionName, Context context) Obtiene información sobre la suscripción junto con su respuesta HTTP.
TopicProperties	getTopic(String topicName) Obtiene información sobre el tema.
boolean	getTopicExists(String topicName) Obtiene si existe un tema con topicName en el espacio de nombres de Service Bus.
Response<Boolean>	getTopicExistsWithResponse(String topicName, Context context) Obtiene si existe un tema con topicName en el espacio de nombres de Service Bus.
TopicRuntimeProperties	getTopicRuntimeProperties(String topicName) Obtiene propiedades en tiempo de ejecución sobre el tema.
Response<TopicRuntimeProperties>	getTopicRuntimePropertiesWithResponse(String topicName, Context context) Obtiene las propiedades en tiempo de ejecución sobre el tema con su respuesta HTTP.
Response<TopicProperties>	getTopicWithResponse(String topicName, Context context) Obtiene información sobre el tema junto con su respuesta HTTP.
PagedIterable<QueueProperties>	listQueues() Captura todas las colas del espacio de nombres de Service Bus.
PagedIterable<QueueProperties>	listQueues(Context context) Captura todas las colas del espacio de nombres de Service Bus.
PagedIterable<RuleProperties>	listRules(String topicName, String subscriptionName) Captura todas las reglas de un tema y una suscripción.
PagedIterable<RuleProperties>	listRules(String topicName, String subscriptionName, Context context) Captura todas las reglas de un tema y una suscripción.
PagedIterable<SubscriptionProperties>	listSubscriptions(String topicName) Captura todas las suscripciones de un tema.
PagedIterable<SubscriptionProperties>	listSubscriptions(String topicName, Context context) Captura todas las suscripciones de un tema.
PagedIterable<TopicProperties>	listTopics() Captura todos los temas del espacio de nombres de Service Bus.
PagedIterable<TopicProperties>	listTopics(Context context) Captura todos los temas del espacio de nombres de Service Bus.
QueueProperties	updateQueue(QueueProperties queue) Novedades una cola con el especificadoQueueProperties.
Response<QueueProperties>	updateQueueWithResponse(QueueProperties queue, Context context) Novedades una cola con el especificadoQueueProperties.
RuleProperties	updateRule(String topicName, String subscriptionName, RuleProperties rule) Novedades una regla con el especificadoRuleProperties.
Response<RuleProperties>	updateRuleWithResponse(String topicName, String subscriptionName, RuleProperties rule, Context context) Novedades una regla con el especificadoRuleProperties.
SubscriptionProperties	updateSubscription(SubscriptionProperties subscription) Novedades una suscripción con el especificadoSubscriptionProperties.
Response<SubscriptionProperties>	updateSubscriptionWithResponse(SubscriptionProperties subscription, Context context) Novedades una suscripción con el especificadoSubscriptionProperties.
TopicProperties	updateTopic(TopicProperties topic) Novedades un tema con el especificadoTopicProperties.
Response<TopicProperties>	updateTopicWithResponse(TopicProperties topic, Context context) Novedades un tema con el especificadoTopicProperties.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del método

createQueue

public QueueProperties createQueue(String queueName)

Crea una cola con el nombre especificado.

Parameters:

queueName - Nombre de la cola que se va a crear.

Returns:

Cola creada.

createQueue

public QueueProperties createQueue(String queueName, CreateQueueOptions queueOptions)

Crea una cola con .CreateQueueOptions

Parameters:

queueName - Nombre de la cola que se va a crear.

queueOptions - Información sobre la cola que se va a crear.

Returns:

Cola creada.

createQueueWithResponse

public Response createQueueWithResponse(String queueName, CreateQueueOptions queueOptions, Context context)

Crea una cola y devuelve la cola creada además de la respuesta HTTP.

Parameters:

queueName - Nombre de la cola que se va a crear.

queueOptions - Información sobre la cola que se va a crear.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Cola creada además de la respuesta HTTP.

createRule

public RuleProperties createRule(String topicName, String subscriptionName, String ruleName)

Crea una regla en el tema y la suscripción especificados.

Parameters:

topicName - Nombre del tema asociado a la regla.

subscriptionName - Nombre de la suscripción asociada a la regla.

ruleName - Nombre de la regla.

Returns:

Información sobre la regla creada.

createRule

public RuleProperties createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions)

Crea una regla con .CreateRuleOptions

Parameters:

topicName - Nombre del tema asociado a la regla.

ruleName - Nombre de la regla.

subscriptionName - Nombre de la suscripción asociada a la regla.

ruleOptions - Información sobre la regla que se va a crear.

Returns:

Información sobre la regla creada.

createRuleWithResponse

public Response createRuleWithResponse(String topicName, String subscriptionName, String ruleName, CreateRuleOptions ruleOptions, Context context)

Crea una regla y devuelve la regla creada además de la respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la regla.

subscriptionName - Nombre de la suscripción asociada a la regla.

ruleName - Nombre de la regla.

ruleOptions - Información sobre la regla que se va a crear.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Regla creada además de la respuesta HTTP.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName)

Crea una suscripción con los nombres de suscripción y el tema especificados.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

Returns:

Información sobre la suscripción creada.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions)

Crea una suscripción con .CreateSubscriptionOptions

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

subscriptionOptions - Información sobre la suscripción que se va a crear.

Returns:

Información sobre la suscripción creada.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions)

Crea una suscripción con una regla predeterminada mediante y CreateSubscriptionOptionsCreateRuleOptions.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

ruleName - Nombre de la regla predeterminada con la que se debe crear la suscripción.

subscriptionOptions - Objeto CreateSubscriptionOptions que describe la suscripción que se va a crear.

ruleOptions - Objeto CreateRuleOptions que describe la regla predeterminada. Si es null, se creará el filtro de paso a través.

Returns:

Información sobre la suscripción creada.

createSubscriptionWithResponse

public Response createSubscriptionWithResponse(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions, Context context)

Crea una suscripción y devuelve la suscripción creada además de la respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

subscriptionOptions - Información sobre la suscripción que se va a crear.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

La suscripción creada además de la respuesta HTTP.

createSubscriptionWithResponse

public Response createSubscriptionWithResponse(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions, Context context)

Crea una suscripción con una regla predeterminada configurada y devuelve la suscripción creada además de la respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

ruleName - Nombre de la regla predeterminada con la que se debe crear la suscripción.

subscriptionOptions - Objeto CreateSubscriptionOptions que describe la suscripción que se va a crear.

ruleOptions - Objeto CreateRuleOptions que describe la regla predeterminada. Si es null, se creará el filtro de paso a través.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

La suscripción creada además de la respuesta HTTP.

createTopic

public TopicProperties createTopic(String topicName)

Crea un tema con el nombre especificado.

Parameters:

topicName - Nombre del tema que se va a crear.

Returns:

Información sobre el tema creado.

createTopic

public TopicProperties createTopic(String topicName, CreateTopicOptions topicOptions)

Crea un tema con CreateTopicOptions.

Parameters:

topicName - Nombre del tema que se va a crear.

topicOptions - Información sobre el tema que se va a crear.

Returns:

Información sobre el tema creado.

createTopicWithResponse

public Response createTopicWithResponse(String topicName, CreateTopicOptions topicOptions, Context context)

Crea un tema y devuelve el tema creado además de la respuesta HTTP.

Parameters:

topicName - Nombre del tema que se va a crear.

topicOptions - Información sobre el tema que se va a crear.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

El tema creado además de la respuesta HTTP.

deleteQueue

public void deleteQueue(String queueName)

Elimina una cola que coincide con queueName.

Parameters:

queueName - Nombre de la cola que se va a eliminar.

deleteQueueWithResponse

public Response deleteQueueWithResponse(String queueName, Context context)

Elimina una cola que coincide queueName y devuelve la respuesta HTTP.

Parameters:

queueName - Nombre de la cola que se va a eliminar.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP cuando la cola se elimina correctamente.

deleteRule

public void deleteRule(String topicName, String subscriptionName, String ruleName)

Elimina una regla que coincide con ruleName.

Parameters:

topicName - Nombre del tema asociado a la regla que se va a eliminar.

subscriptionName - Nombre de la suscripción asociada a la regla que se va a eliminar.

ruleName - Nombre de la regla que se va a eliminar.

deleteRuleWithResponse

public Response deleteRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context)

Elimina una regla que coincide ruleName y devuelve la respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la regla que se va a eliminar.

subscriptionName - Nombre de la suscripción asociada a la regla que se va a eliminar.

ruleName - Nombre de la regla que se va a eliminar.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP.

deleteSubscription

public void deleteSubscription(String topicName, String subscriptionName)

Elimina una suscripción que coincide con en el subscriptionName tema topicName.

Parameters:

topicName - Nombre del tema asociado a la suscripción que se va a eliminar.

subscriptionName - Nombre de la suscripción que se va a eliminar.

deleteSubscriptionWithResponse

public Response deleteSubscriptionWithResponse(String topicName, String subscriptionName, Context context)

Elimina una suscripción que coincide subscriptionName y devuelve la respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la suscripción que se va a eliminar.

subscriptionName - Nombre de la suscripción que se va a eliminar.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP.

deleteTopic

public void deleteTopic(String topicName)

Elimina un tema que coincide con topicName.

Parameters:

topicName - Nombre del tema que se va a eliminar.

deleteTopicWithResponse

public Response deleteTopicWithResponse(String topicName, Context context)

Elimina un tema que coincide topicName y devuelve la respuesta HTTP.

Parameters:

topicName - Nombre del tema que se va a eliminar.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP.

getNamespaceProperties

public NamespaceProperties getNamespaceProperties()

Obtiene información sobre el espacio de nombres de Service Bus.

Returns:

Información sobre el espacio de nombres de Service Bus.

getNamespacePropertiesWithResponse

public Response getNamespacePropertiesWithResponse(Context context)

Obtiene información sobre el espacio de nombres de Service Bus junto con su respuesta HTTP.

Parameters:

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Información sobre el espacio de nombres y la respuesta HTTP asociada.

getQueue

public QueueProperties getQueue(String queueName)

Obtiene información sobre la cola.

Parameters:

queueName - Nombre de la cola para obtener información sobre.

Returns:

Información sobre la cola.

getQueueExists

public boolean getQueueExists(String queueName)

Obtiene si existe una cola con queueName en el espacio de nombres de Service Bus.

Parameters:

queueName - Nombre de la cola.

Returns:

true si la cola existe; de lo contrario false, .

getQueueExistsWithResponse

public Response getQueueExistsWithResponse(String queueName, Context context)

Obtiene si existe una cola con queueName en el espacio de nombres de Service Bus.

Parameters:

queueName - Nombre de la cola.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP y true si la cola existe; de lo contrario false, .

getQueueRuntimeProperties

public QueueRuntimeProperties getQueueRuntimeProperties(String queueName)

Obtiene las propiedades en tiempo de ejecución sobre la cola.

Parameters:

queueName - Nombre de la cola para obtener información sobre.

Returns:

Propiedades en tiempo de ejecución sobre la cola.

getQueueRuntimePropertiesWithResponse

public Response getQueueRuntimePropertiesWithResponse(String queueName, Context context)

Obtiene las propiedades en tiempo de ejecución de la cola junto con su respuesta HTTP.

Parameters:

queueName - Nombre de la cola para obtener información sobre.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Propiedades en tiempo de ejecución sobre la cola y la respuesta HTTP asociada.

getQueueWithResponse

public Response getQueueWithResponse(String queueName, Context context)

Obtiene información sobre la cola junto con su respuesta HTTP.

Parameters:

queueName - Nombre de la cola para obtener información sobre.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Información sobre la cola y la respuesta HTTP asociada.

getRule

public RuleProperties getRule(String topicName, String subscriptionName, String ruleName)

Obtiene una regla del espacio de nombres del servicio. Solo se deserializan los siguientes tipos de datos en los parámetros Filters y Action: string, int, long, boolean, double y OffsetDateTime. Otros tipos de datos devolverían su valor de cadena.

Parameters:

topicName - Nombre del tema relativo al espacio de nombres de Service Bus.

subscriptionName - Nombre de suscripción al que pertenece la regla.

ruleName - Nombre de la regla que se va a recuperar.

Returns:

Regla asociada.

getRuleWithResponse

public Response getRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context)

Obtiene una regla del espacio de nombres del servicio. Solo se deserializan los siguientes tipos de datos en los parámetros Filters y Action: string, int, long, bool, double y OffsetDateTime. Otros tipos de datos devolverían su valor de cadena.

Parameters:

topicName - Nombre del tema relativo al espacio de nombres de Service Bus.

subscriptionName - Nombre de suscripción al que pertenece la regla.

ruleName - Nombre de la regla que se va a recuperar.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Regla asociada con la respuesta HTTP correspondiente.

getSubscription

public SubscriptionProperties getSubscription(String topicName, String subscriptionName)

Obtiene información sobre la cola.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción para obtener información sobre.

Returns:

Información sobre la suscripción.

getSubscriptionExists

public boolean getSubscriptionExists(String topicName, String subscriptionName)

Obtiene si existe una suscripción dentro de un tema.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

Returns:

true si la suscripción existe.

getSubscriptionExistsWithResponse

public Response getSubscriptionExistsWithResponse(String topicName, String subscriptionName, Context context)

Obtiene si existe una suscripción dentro de un tema.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP y true si la suscripción existe; de lo contrario false, .

getSubscriptionRuntimeProperties

public SubscriptionRuntimeProperties getSubscriptionRuntimeProperties(String topicName, String subscriptionName)

Obtiene las propiedades en tiempo de ejecución sobre la suscripción.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción para obtener información sobre.

Returns:

Propiedades en tiempo de ejecución sobre la suscripción.

getSubscriptionRuntimePropertiesWithResponse

public Response getSubscriptionRuntimePropertiesWithResponse(String topicName, String subscriptionName, Context context)

Obtiene las propiedades en tiempo de ejecución sobre la suscripción.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción para obtener información sobre.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Propiedades en tiempo de ejecución sobre la suscripción.

getSubscriptionWithResponse

public Response getSubscriptionWithResponse(String topicName, String subscriptionName, Context context)

Obtiene información sobre la suscripción junto con su respuesta HTTP.

Parameters:

topicName - Nombre del tema asociado a la suscripción.

subscriptionName - Nombre de la suscripción para obtener información sobre.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Información sobre la suscripción y la respuesta HTTP asociada.

getTopic

public TopicProperties getTopic(String topicName)

Obtiene información sobre el tema.

Parameters:

topicName - Nombre del tema sobre el que obtener información.

Returns:

Información sobre el tema.

getTopicExists

public boolean getTopicExists(String topicName)

Obtiene si existe un tema con topicName en el espacio de nombres de Service Bus.

Parameters:

topicName - Nombre del tema.

Returns:

true si el tema existe.

getTopicExistsWithResponse

public Response getTopicExistsWithResponse(String topicName, Context context)

Obtiene si existe un tema con topicName en el espacio de nombres de Service Bus.

Parameters:

topicName - Nombre del tema.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Respuesta HTTP y true si el tema existe; de lo contrario false, .

getTopicRuntimeProperties

public TopicRuntimeProperties getTopicRuntimeProperties(String topicName)

Obtiene propiedades en tiempo de ejecución sobre el tema.

Parameters:

topicName - Nombre del tema sobre el que obtener información.

Returns:

Propiedades en tiempo de ejecución sobre el tema.

getTopicRuntimePropertiesWithResponse

public Response getTopicRuntimePropertiesWithResponse(String topicName, Context context)

Obtiene las propiedades en tiempo de ejecución sobre el tema con su respuesta HTTP.

Parameters:

topicName - Nombre del tema sobre el que obtener información.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Propiedades en tiempo de ejecución sobre el tema y la respuesta HTTP asociada.

getTopicWithResponse

public Response getTopicWithResponse(String topicName, Context context)

Obtiene información sobre el tema junto con su respuesta HTTP.

Parameters:

topicName - Nombre del tema sobre el que obtener información.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Información sobre el tema y la respuesta HTTP asociada.

listQueues

public PagedIterable listQueues()

Captura todas las colas del espacio de nombres de Service Bus.

Returns:

PagedIterable de en el espacio de QueueProperties nombres de Service Bus.

listQueues

public PagedIterable listQueues(Context context)

Captura todas las colas del espacio de nombres de Service Bus.

Parameters:

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

PagedIterable de en el espacio de QueueProperties nombres de Service Bus.

listRules

public PagedIterable listRules(String topicName, String subscriptionName)

Captura todas las reglas de un tema y una suscripción.

Parameters:

topicName - Nombre del tema con el que se deben recuperar todas las reglas.

subscriptionName - Nombre de la suscripción para la que se deben recuperar todas las reglas.

Returns:

Iterable de RuleProperties para y topicNamesubscriptionName.

listRules

public PagedIterable listRules(String topicName, String subscriptionName, Context context)

Captura todas las reglas de un tema y una suscripción.

Parameters:

topicName - Nombre del tema con el que se deben recuperar todas las reglas.

subscriptionName - Nombre de la suscripción para la que se deben recuperar todas las reglas.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Iterable de RuleProperties para y topicNamesubscriptionName.

listSubscriptions

public PagedIterable listSubscriptions(String topicName)

Captura todas las suscripciones de un tema.

Parameters:

topicName - Nombre del tema con el que se deben recuperar todas las suscripciones.

Returns:

Iterable paginado de SubscriptionProperties para .topicName

listSubscriptions

public PagedIterable listSubscriptions(String topicName, Context context)

Captura todas las suscripciones de un tema.

Parameters:

topicName - Nombre del tema con el que se deben recuperar todas las suscripciones.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Iterable paginado de SubscriptionProperties para .topicName

listTopics

public PagedIterable listTopics()

Captura todos los temas del espacio de nombres de Service Bus.

Returns:

Iterable paginado de en el espacio de nombres de TopicProperties Service Bus.

listTopics

public PagedIterable listTopics(Context context)

Captura todos los temas del espacio de nombres de Service Bus.

Parameters:

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Iterable paginado de en el espacio de nombres de TopicProperties Service Bus.

updateQueue

public QueueProperties updateQueue(QueueProperties queue)

Novedades una cola con el especificadoQueueProperties. QueueProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getQueue(String queueName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setLockDuration(Duration lockDuration)
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
• setMaxDeliveryCount(Integer maxDeliveryCount)

Parameters:

queue - Información sobre la cola que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

Returns:

Cola actualizada.

updateQueueWithResponse

public Response updateQueueWithResponse(QueueProperties queue, Context context)

Novedades una cola con el especificadoQueueProperties. QueueProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getQueue(String queueName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setLockDuration(Duration lockDuration)
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
• setMaxDeliveryCount(Integer maxDeliveryCount)

Parameters:

queue - Información sobre la cola que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Cola actualizada con su respuesta HTTP.

updateRule

public RuleProperties updateRule(String topicName, String subscriptionName, RuleProperties rule)

Novedades una regla con el especificadoRuleProperties. RuleProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getRule(String topicName, String subscriptionName, String ruleName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Parameters:

topicName - Nombre del tema en el que se actualiza la regla.

subscriptionName - Nombre de la suscripción para la que se actualiza la regla.

rule - Información sobre la regla que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

Returns:

Regla actualizada.

updateRuleWithResponse

public Response updateRuleWithResponse(String topicName, String subscriptionName, RuleProperties rule, Context context)

Novedades una regla con el especificadoRuleProperties. RuleProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getRule(String topicName, String subscriptionName, String ruleName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Parameters:

topicName - Nombre del tema en el que se actualiza la regla.

subscriptionName - Nombre de la suscripción para la que se actualiza la regla.

rule - Información sobre la regla que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Mono que devuelve la regla actualizada además de la respuesta HTTP.

updateSubscription

public SubscriptionProperties updateSubscription(SubscriptionProperties subscription)

Novedades una suscripción con el especificadoSubscriptionProperties. SubscriptionProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getSubscription(String topicName, String subscriptionName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setLockDuration(Duration lockDuration)
• setMaxDeliveryCount(int maxDeliveryCount)

Parameters:

subscription - Información sobre la suscripción que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

Returns:

Se ha actualizado la suscripción además de la respuesta HTTP.

updateSubscriptionWithResponse

public Response updateSubscriptionWithResponse(SubscriptionProperties subscription, Context context)

Novedades una suscripción con el especificadoSubscriptionProperties. SubscriptionProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getSubscription(String topicName, String subscriptionName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setLockDuration(Duration lockDuration)
• setMaxDeliveryCount(int maxDeliveryCount)

Parameters:

subscription - Información sobre la suscripción que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Se ha actualizado la suscripción además de la respuesta HTTP.

updateTopic

public TopicProperties updateTopic(TopicProperties topic)

Novedades un tema con el especificadoTopicProperties. TopicProperties Debe rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getTopic(String topicName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Parameters:

topic - Información sobre el tema que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

Returns:

El tema actualizado.

updateTopicWithResponse

public Response updateTopicWithResponse(TopicProperties topic, Context context)

Novedades un tema con el especificadoTopicProperties. debe TopicProperties rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:

1. getTopic(String topicName)
2. Actualizar los elementos necesarios.
3. Pase la descripción actualizada a este método.

Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:

• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Parameters:

topic - Información sobre el tema que se va a actualizar. Debe proporcionar todos los valores de propiedad que se desean en la entidad actualizada. Los valores que no se proporcionen se establecen en los valores predeterminados del servicio.

context - Contexto adicional que se pasa a través de la canalización HTTP durante la llamada al servicio.

Returns:

Tema actualizado con su respuesta HTTP.