Entities Discovery

Article
12/19/2023

Discovers messaging entities.

Request

You can construct the Entities Discovery request as follows.

Method	Request URI	HTTP Version
GET	https://{serviceNamespace}.servicebus.windows.net/{path}	HTTP/1.1

Request Headers

The following table describes required and optional request headers.

Request Header	Description
Authorization	Specifies a Shared Access Signature (SAS) token with "Manage" rights. See Service Bus authentication with Shared Access Signatures for details.

Request Body

None.

Response

The response includes an HTTP status code and a set of response headers.

Response Codes

Code	Description
200	OK.
401	Unauthorized. The request isn't authorized.

Note

In order for the HTTP GET request be interpreted as a “Discovery” operation, the name addressed by the URL must not be occupied. If the name is taken, the HTTP GET request is interpreted as a “Get” operation.

For information about status codes, see Status and Error Codes.

Response Headers

The response for this operation includes the following headers. The response might also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header	Description
Content-type	Content-Type: application/atom+xml; type=entry

Response Body

Upon success, the response includes an Atom feed listing immediate children of current node is returned. For example:

<?xml version="1.0" encoding="utf-8" ?>  
<feed xmlns='http://www.w3.org/2005/Atom'>  
  <entry>  
    <id>https://{serviceNamespace}.servicebus.Windows.net/{path}</id>  
    <published>{createdTime}</published>  
    <updated>{lastUpdatedTime}</updated>  
    <link rel='self'>https://{serviceNamespace}.servicebus.Windows.net/{path}</link>  
    <content type='application/xml'>  
      {description}
    </content>  
  </entry>  
</feed>

For the possible content of the {description} element, see Overview.

Share via