Microsoft Azure

Azure Service Bus

Azure Service Bus client for managing Queues, Topics, and Subscriptions. For general OpenAPI tooling, replace the host with your namespace's fully qualified…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Service Bus client for managing Queues, Topics, and Subscriptions. For general OpenAPI tooling, replace the host with your namespace's fully qualified domain name before sending requests.

Endpoints 13

Namespace Operations

  • GETGet Namespace Properties/$namespaceinfo?api-version=stringGet the details about the Service Bus namespace.

Queue Operations

  • GETGet Queue or Topic/:entityName?enrich=false&api-version=stringGet the details about the Queue or Topic with the given entityName.
  • PUTCreate or update a queue or topic/:entityName?api-version=stringCreate or update a queue or topic at the provided entityName
  • DELETEDelete Queue or Topic/:entityName?api-version=stringDelete the Queue or Topic with the given entityName.
  • GETGet Queues or topics/$Resources/:entityType?$skip=0&$top=100&api-version=stringGet the details about the entities of the given Service Bus namespace.

Subscription Operations

  • GETGet subscriptions/:topicName/subscriptions?$skip=0&$top=100&api-version=stringGet the details about the subscriptions of the given topic.
  • GETGet Subscription/:topicName/subscriptions/:subscriptionName?enrich=false&api-version=stringGet the details about the subscription of a topic.
  • PUTCreate or update a subscription/:topicName/subscriptions/:subscriptionName?api-version=stringCreate or update a subscription
  • DELETEDelete Subscription/:topicName/subscriptions/:subscriptionName?api-version=stringDelete the subscription with the given topicName and subscriptionName.
  • GETGet rules of a topic subscription/:topicName/subscriptions/:subscriptionName/rules?$skip=0&$top=100&api-version=stringGet the details about the rules of the given topic subscription.

Rule Operations

  • GETGet Rule/:topicName/subscriptions/:subscriptionName/rules/:ruleName?enrich=false&api-version=stringGet the details about the rule of a subscription of a topic.
  • PUTCreate or update a rule/:topicName/subscriptions/:subscriptionName/rules/:ruleName?api-version=stringCreate or update a rule
  • DELETEDelete Subscription/:topicName/subscriptions/:subscriptionName/rules/:ruleName?api-version=stringDelete the rule with the given topicName, subscriptionName and ruleName.

API details

Base URL
https://example-namespace.servicebus.windows.net
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
13 operations on 7 pathsGET 7PUT 3DELETE 3
Main resources
Subscription Operations 5Queue Operations 4Topic Operations 4Rule Operations 3Namespace Operations 1
Response formats
application/atom+xml application/xml
Description format
Swagger 2.0, API version 2021-05

How to test the Azure Service Bus in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Service Bus collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Namespace Properties” (GET /$namespaceinfo?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Service Bus?

Azure Service Bus client for managing Queues, Topics, and Subscriptions. For general OpenAPI tooling, replace the host with your namespace's fully qualified… It is listed under Developer tools and has 13 endpoints.

Who publishes the Azure Service Bus?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Service Bus?

Requests go to https://example-namespace.servicebus.windows.net. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Service Bus?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Service Bus have?

13 operations on 7 paths (7 GET, 3 PUT, 3 DELETE). The largest groups are Subscription Operations, Queue Operations, Topic Operations, Rule Operations.

Is forking the Azure Service Bus free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.