Azure Service Bus REST API

Azure Service Bus provides cloud-enabled communication with enterprise messaging and relayed communication that helps you connect on-premises solutions with the cloud.

The REST APIs fall into the following categories:

  • Azure Resource Manager: APIs that perform Resource Manager operations, and have /providers/Microsoft.ServiceBus/ as part of the request URI.
  • Service Bus service: APIs that enable operations directly on the Service Bus service, and have the public cloud endpoint namespaceName.servicebus.windows.net in the request URI. Other possible domain names are as follows:
    • Azure Germany: namespaceName.servicebus.cloudapi.de
    • Azure China: namespaceName.servicebus.chinacloudapi.cn
    • United States government: namespaceName.servicebus.usgovcloudapi.net
  • "Classic" or RDFE management: APIs that provide programmatic access to much of the functionality available through the Azure portal. These APIs have management.core.windows.net in the URI.

REST operation groups

The Service Bus REST API provides operations for working with the following resources:

Azure Resource Manager

Resource Manager APIs are management APIs that perform operations on Service Bus entities, such as namespaces, queues, and topics. They are useful in scenarios that enable global authentication, rather than at the namespace or entity level.

Operation group Description
Namespaces Provides operations for managing Service Bus namespaces.
Queues Operations for managing Service Bus queues.
Subscriptions Operations for managing Service Bus topic subscriptions.
Topics Operations for managing Service Bus topics.

Service Bus service

Service Bus service APIs access the Service Bus service directly, and perform various management operations at the entity level, rather than at the namespace level (such as sending a message to a queue. These APIs use SAS authentication.

RDFE management

These management APIs provide programmatic access to much of the functionality available through the Azure portal.

Service Bus also has a set of RDFE APIs that enable you to manage Service Bus entity metrics.

See also