Microsoft.ServiceBus (stable:2015-08-01)

2025/09/26 • 40 new, 40 deleted methods

Operations_List (new)
Description :  Lists all of the available ServiceBus REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceBus/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.ServiceBus ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (new)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the given namespace name ,
Required: True ,
}
{
name:
{
Description: The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Value indicating namespace is availability, true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
}
Namespaces_ListBySubscription (new)
Description :  Gets all the available namespaces within the subscription, irrespective of the resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (new)
Description :  Gets the available namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (new)
Description :  Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
location:
{
Description: Namespace location. ,
Required: True ,
}
string ,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Namespace tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Namespaces_Delete (new)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}
Namespaces_Get (new)
Description :  Gets a description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
Namespaces_Update (new)
Description :  Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update a namespace resource. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Namespaces_ListAuthorizationRules (new)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Namespaces_GetAuthorizationRule (new)
Description :  Gets an authorization rule for a namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Namespaces_ListKeys (new)
Description :  Gets the primary and secondary connection strings for the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Namespaces_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings for the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Queues_ListAll (new)
Description :  Gets the queues within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Queues operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of queues. ,
Required: False ,
}
string ,
}
Queues_CreateOrUpdate (new)
Description :  Creates or updates a Service Bus queue. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a queue resource. ,
Required: True ,
}
{
name:
{
Description: Queue name. ,
Required: False ,
}
string ,
location:
{
Description: location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Queues_Delete (new)
Description :  Deletes a queue from the specified namespace in a resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Queues_Get (new)
Description :  Returns a description for the specified queue.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Queues_ListAuthorizationRules (new)
Description :  Gets all authorization rules for a queue.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Queues_CreateOrUpdateAuthorizationRule (new)
Description :  Creates an authorization rule for a queue.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_PostAuthorizationRule (new)
Description :  Gets an authorization rule for a queue by rule name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_DeleteAuthorizationRule (new)
Description :  Deletes a queue authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Queues_GetAuthorizationRule (new)
Description :  Gets an authorization rule for a queue by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_ListKeys (new)
Description :  Primary and secondary connection strings to the queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Queues_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Topics_ListAll (new)
Description :  Gets all the topics in a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Topics operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of topics. ,
Required: False ,
}
string ,
}
Topics_CreateOrUpdate (new)
Description :  Creates a topic in the specified namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a topic resource. ,
Required: True ,
}
{
name:
{
Description: Topic name. ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Topics_Delete (new)
Description :  Deletes a topic from the specified namespace and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Topics_Get (new)
Description :  Returns a description for the specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Topics_ListAuthorizationRules (new)
Description :  Gets authorization rules for a topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Topics_CreateOrUpdateAuthorizationRule (new)
Description :  Creates an authorization rule for the specified topic.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_PostAuthorizationRule (new)
Description :  Returns the specified authorization rule.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_GetAuthorizationRule (new)
Description :  Returns the specified authorization rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_DeleteAuthorizationRule (new)
Description :  Deletes a topic authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Topics_ListKeys (new)
Description :  Gets the primary and secondary connection strings for the topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Topics_RegenerateKeys (new)
Description :  Regenerates primary or secondary connection strings for the topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Subscriptions_ListAll (new)
Description :  List all the subscriptions under a specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Subscriptions operation. ,
Required: False ,
}
[
{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of subscriptions. ,
Required: False ,
}
string ,
}
Subscriptions_CreateOrUpdate (new)
Description :  Creates a topic subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a subscription resource. ,
Required: True ,
}
{
location:
{
Description: Subscription data center location. ,
Required: True ,
}
string ,
type:
{
Description: Resource manager type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Subscriptions_Delete (new)
Description :  Deletes a subscription from the specified topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Subscriptions_Get (new)
Description :  Returns a subscription description for the specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available ServiceBus REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceBus/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.ServiceBus ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (removed)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the given namespace name ,
Required: True ,
}
{
name:
{
Description: The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Value indicating namespace is availability, true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
}
Namespaces_ListBySubscription (removed)
Description :  Gets all the available namespaces within the subscription, irrespective of the resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (removed)
Description :  Gets the available namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (removed)
Description :  Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
location:
{
Description: Namespace location. ,
Required: True ,
}
string ,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Namespace tags. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Namespaces_Delete (removed)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}
Namespaces_Get (removed)
Description :  Gets a description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}
Namespaces_Update (removed)
Description :  Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update a namespace resource. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: State of the namespace. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Activating: No description available. ,
Enabling: No description available. ,
Active: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Removing: No description available. ,
Removed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
createACSNamespace:
{
Description: Indicates whether to create an ACS namespace. ,
Required: False ,
}
boolean ,
enabled:
{
Description: Specifies whether this instance is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Namespaces_ListAuthorizationRules (removed)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Namespaces_GetAuthorizationRule (removed)
Description :  Gets an authorization rule for a namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Namespaces_ListKeys (removed)
Description :  Gets the primary and secondary connection strings for the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Namespaces_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings for the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Queues_ListAll (removed)
Description :  Gets the queues within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Queues operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of queues. ,
Required: False ,
}
string ,
}
Queues_CreateOrUpdate (removed)
Description :  Creates or updates a Service Bus queue. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a queue resource. ,
Required: True ,
}
{
name:
{
Description: Queue name. ,
Required: False ,
}
string ,
location:
{
Description: location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Queues_Delete (removed)
Description :  Deletes a queue from the specified namespace in a resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Queues_Get (removed)
Description :  Returns a description for the specified queue.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Queue Properties definition. ,
Required: False ,
}
{
lockDuration:
{
Description: The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time a message was sent, or the last time there was a receive request to this queue. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the queue. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: A value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: A value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: A value that indicates whether the queue supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Queues_ListAuthorizationRules (removed)
Description :  Gets all authorization rules for a queue.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Queues_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates an authorization rule for a queue.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_PostAuthorizationRule (removed)
Description :  Gets an authorization rule for a queue by rule name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_DeleteAuthorizationRule (removed)
Description :  Deletes a queue authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Queues_GetAuthorizationRule (removed)
Description :  Gets an authorization rule for a queue by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Queues_ListKeys (removed)
Description :  Primary and secondary connection strings to the queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Queues_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
queueName:
{
Description: The queue name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Topics_ListAll (removed)
Description :  Gets all the topics in a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Topics operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of topics. ,
Required: False ,
}
string ,
}
Topics_CreateOrUpdate (removed)
Description :  Creates a topic in the specified namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a topic resource. ,
Required: True ,
}
{
name:
{
Description: Topic name. ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Topics_Delete (removed)
Description :  Deletes a topic from the specified namespace and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Topics_Get (removed)
Description :  Returns a description for the specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Topic Properties definition. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
duplicateDetectionHistoryTimeWindow:
{
Description: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
enableExpress:
{
Description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. ,
Required: False ,
}
boolean ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. ,
Required: False ,
}
boolean ,
filteringMessagesBeforePublishing:
{
Description: Whether messages should be filtered before publishing. ,
Required: False ,
}
boolean ,
isAnonymousAccessible:
{
Description: Value that indicates whether the message is accessible anonymously. ,
Required: False ,
}
boolean ,
isExpress:
{
Required: False ,
}
boolean ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
Required: False ,
}
integer ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Topics_ListAuthorizationRules (removed)
Description :  Gets authorization rules for a topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules. ,
Required: False ,
}
string ,
}
Topics_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates an authorization rule for the specified topic.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
location:
{
Description: data center location. ,
Required: False ,
}
string ,
name:
{
Description: Name of the authorization rule. ,
Required: False ,
}
string ,
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_PostAuthorizationRule (removed)
Description :  Returns the specified authorization rule.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_GetAuthorizationRule (removed)
Description :  Returns the specified authorization rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
Topics_DeleteAuthorizationRule (removed)
Description :  Deletes a topic authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Topics_ListKeys (removed)
Description :  Gets the primary and secondary connection strings for the topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Topics_RegenerateKeys (removed)
Description :  Regenerates primary or secondary connection strings for the topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the authorization rule. ,
Required: True ,
}
{
Policykey:
{
Description: Key that needs to be regenerated. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}
Subscriptions_ListAll (removed)
Description :  List all the subscriptions under a specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Subscriptions operation. ,
Required: False ,
}
[
{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of subscriptions. ,
Required: False ,
}
string ,
}
Subscriptions_CreateOrUpdate (removed)
Description :  Creates a topic subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a subscription resource. ,
Required: True ,
}
{
location:
{
Description: Subscription data center location. ,
Required: True ,
}
string ,
type:
{
Description: Resource manager type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Subscriptions_Delete (removed)
Description :  Deletes a subscription from the specified topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
Subscriptions_Get (removed)
Description :  Returns a subscription description for the specified topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
topicName:
{
Description: The topic name. ,
Required: True ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Subscription Resource. ,
Required: False ,
}
{
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
autoDeleteOnIdle:
{
Description: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Required: False ,
}
string ,
countDetails:
{
Description: Message Count Details. ,
Required: False ,
}
{
activeMessageCount:
{
Description: Number of active messages in the queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
deadLetterMessageCount:
{
Description: Number of messages that are dead lettered. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledMessageCount:
{
Description: Number of scheduled messages. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
defaultMessageTimeToLive:
{
Description: Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. ,
Required: False ,
}
string ,
deadLetteringOnFilterEvaluationExceptions:
{
Description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. ,
Required: False ,
}
boolean ,
deadLetteringOnMessageExpiration:
{
Description: Value that indicates whether a subscription has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
entityAvailabilityStatus:
{
Description: Entity availability status for the topic. ,
Enum:
{
Available: No description available. ,
Limited: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Value that indicates whether the entity description is read-only. ,
Required: False ,
}
boolean ,
lockDuration:
{
Description: The lock duration time span for the subscription. ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
ReceiveDisabled: No description available. ,
Renaming: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}