ServiceBusManagementClient (stable:2021-05)

2025/09/26 • 13 new methods

Entity_Get (new)
Description :  Get the details about the Queue or Topic with the given entityName.
Reference :  Link ¶

⚼ Request

GET:  /{entityName}
{
enrich:
{
Description: A query parameter that sets enrich to true or false. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Entity_Put (new)
Description :  Create or update a queue or topic at the provided entityName
Reference :  Link ¶

⚼ Request

PUT:  /{entityName}
{
requestBody:
{
Description: Parameters required to make or edit a queue or topic. ,
Required: True ,
}
object ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
If-Match:
{
Description: Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (201)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Entity_Delete (new)
Description :  Delete the Queue or Topic with the given entityName.
Reference :  Link ¶

⚼ Request

DELETE:  /{entityName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
listSubscriptions (new)
Description :  Get the details about the subscriptions of the given topic.
Reference :  Link ¶

⚼ Request

GET:  /{topicName}/subscriptions
{
$skip:
{
Format: int32 ,
Required: False ,
}
integer ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Subscription_Get (new)
Description :  Get the details about the subscription of a topic.
Reference :  Link ¶

⚼ Request

GET:  /{topicName}/subscriptions/{subscriptionName}
{
enrich:
{
Description: A query parameter that sets enrich to true or false. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Subscription_Put (new)
Description :  Create or update a subscription
Reference :  Link ¶

⚼ Request

PUT:  /{topicName}/subscriptions/{subscriptionName}
{
requestBody:
{
Description: Parameters required to make or edit a subscription. ,
Required: True ,
}
object ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
If-Match:
{
Description: Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (201)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Subscription_Delete (new)
Description :  Delete the subscription with the given topicName and subscriptionName.
Reference :  Link ¶

⚼ Request

DELETE:  /{topicName}/subscriptions/{subscriptionName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
listRules (new)
Description :  Get the details about the rules of the given topic subscription.
Reference :  Link ¶

⚼ Request

GET:  /{topicName}/subscriptions/{subscriptionName}/rules
{
$skip:
{
Format: int32 ,
Required: False ,
}
integer ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Rule_Get (new)
Description :  Get the details about the rule of a subscription of a topic.
Reference :  Link ¶

⚼ Request

GET:  /{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
enrich:
{
Description: A query parameter that sets enrich to true or false. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Rule_Put (new)
Description :  Create or update a rule
Reference :  Link ¶

⚼ Request

PUT:  /{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
requestBody:
{
Description: Parameters required to make or edit a rule. ,
Required: True ,
}
object ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
If-Match:
{
Description: Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (201)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Rule_Delete (new)
Description :  Delete the rule with the given topicName, subscriptionName and ruleName.
Reference :  Link ¶

⚼ Request

DELETE:  /{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
Namespace_Get (new)
Description :  Get the details about the Service Bus namespace.
Reference :  Link ¶

⚼ Request

GET:  /$namespaceinfo
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The URL of the GET request ,
Required: False ,
}
string ,
title:
{
Description: The name of the namespace. ,
Required: True ,
}
object ,
updated:
{
Description: The timestamp for when this namespace was last updated ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: The author that created this resource ,
Required: False ,
}
{
name:
{
Description: The Service Bus namespace ,
Required: False ,
}
string ,
}
,
link:
{
Description: The URL for the HTTP request ,
Required: False ,
}
{
href:
{
Description: The URL of the GET request ,
Required: False ,
}
string ,
rel:
{
Description: What the link href is relative to ,
Required: False ,
}
string ,
}
,
content:
{
Description: Information about the namespace. ,
Required: False ,
}
{
type:
{
Description: Type of content in namespace info response ,
Required: True ,
}
string ,
NamespaceProperties:
{
Description: The metadata related to a Service Bus namespace. ,
Required: True ,
}
{
alias:
{
Description: Alias for the geo-disaster recovery Service Bus namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The exact time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
messagingSku:
{
Description: The SKU for the messaging entity. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
messagingUnits:
{
Description: The number of messaging units allocated to the namespace. ,
Format: int32 ,
Required: False ,
}
integer ,
modifiedTime:
{
Description: The exact time the namespace was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the namespace ,
Required: False ,
}
string ,
namespaceType:
{
Description: The type of entities the namespace can contain. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
Mixed: No description available. ,
EventHub: No description available. ,
Relay: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}
listEntities (new)
Description :  Get the details about the entities of the given Service Bus namespace.
Reference :  Link ¶

⚼ Request

GET:  /$Resources/{entityType}
{
$skip:
{
Format: int32 ,
Required: False ,
}
integer ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. ,
}
string ,
x-ms-version:
{
Description: The version of the REST protocol used to process the request. ,
}
string ,
}
,
$schema:
{
Description: The error response from Service Bus. ,
}
{
code:
{
Description: The service error code. ,
Format: int32 ,
Required: False ,
}
integer ,
detail:
{
Description: The service error message. ,
Required: False ,
}
string ,
}
,
}