Microsoft.ServiceBus (preview:2018-01-01)

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

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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_CheckNameAvailability (new)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability
{
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 ,
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)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_List (new)
Description :  Gets all Alias(Disaster Recovery configurations)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs
{
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: List of Alias(Disaster Recovery configurations) ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration) ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_CreateOrUpdate (new)
Description :  Creates or updates a new Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: 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)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_Delete (new)
Description :  Deletes an Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_Get (new)
Description :  Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_BreakPairing (new)
Description :  This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_FailOver (new)
Description :  Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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 ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: False ,
}
{
properties:
{
Description: Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary. ,
Required: False ,
}
{
IsSafeFailover:
{
Description: Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_ListAuthorizationRules (new)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_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}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_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}/disasterRecoveryConfigs/{alias}/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 ,
alias:
{
Description: The Disaster Recovery configuration 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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListIpFilterRules (new)
Description :  Gets a list of IP Filter rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules
{
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 IpFilter Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateIpFilterRule (new)
Description :  Creates or updates an IpFilterRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter Rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
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: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteIpFilterRule (new)
Description :  Deletes an IpFilterRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetIpFilterRule (new)
Description :  Gets an IpFilterRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter 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: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PremiumMessagingRegions_List (new)
Description :  Gets the available premium messaging regions for servicebus
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/premiumMessagingRegions
{
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 PremiumMessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Queues_ListByNamespace (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Queues operation. ,
Required: False ,
}
[
{
properties:
{
Description: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of queues. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
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: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_ListBySubscriptions (new)
Description :  List all the rules within given topic-subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules
{
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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_CreateOrUpdate (new)
Description :  Creates a new rule and updates an existing rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
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 (200)

{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Delete (new)
Description :  Deletes an existing rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Get (new)
Description :  Retrieves the description for the specified rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The 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: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListVirtualNetworkRules (new)
Description :  Gets a list of VirtualNetwork rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules
{
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 VirtualNetwork Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateVirtualNetworkRule (new)
Description :  Creates or updates an VirtualNetworkRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network Rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace VirtualNetworkRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
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: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteVirtualNetworkRule (new)
Description :  Deletes an VirtualNetworkRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetVirtualNetworkRule (new)
Description :  Gets an VirtualNetworkRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network 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: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EventHubs_ListByNamespace (new)
Description :  Gets all the Event Hubs in a service bus Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/eventhubs
{
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 EventHubs operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Migrate (new)
Description :  This operation Migrate the given namespace to provided name type
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrate
{
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 ,
parameters:
{
Description: Parameters supplied to migrate namespace type. ,
Required: True ,
}
{
targetNamespaceType:
{
Description: Type of namespaces ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
Mixed: No description available. ,
EventHub: No description available. ,
Relay: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_List (new)
Description :  Gets all migrationConfigurations
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations
{
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: List of Migration Configs ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_CreateAndStartMigration (new)
Description :  Creates Migration configuration and starts migration of entities from Standard to Premium namespace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create Migration Configuration ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
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: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Delete (new)
Description :  Deletes a MigrationConfiguration
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Get (new)
Description :  Retrieves Migration Config
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_CompleteMigration (new)
Description :  This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Revert (new)
Description :  This operation reverts Migration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: 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)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
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: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: 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)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Gets the available PrivateEndpointConnections within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections
{
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: A collection of private endpoint connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private endpoint connection resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Creates or updates PrivateEndpointConnections of service namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes an existing Private Endpoint Connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a description for the specified Private Endpoint Connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets lists of resources that supports Privatelinks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources
{
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: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Required: False ,
}
string ,
requiredMembers:
{
Description: Required Members ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required Zone Names ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateNetworkRuleSet (new)
Description :  Create or update NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default
{
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 ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetNetworkRuleSet (new)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default
{
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)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListNetworkRuleSets (new)
Description :  Gets list of NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets
{
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 NetworkRuleSet operation. ,
Required: False ,
}
[
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Regions_ListBySku (new)
Description :  Gets the available Regions for a given sku
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/sku/{sku}/regions
{
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 ,
sku:
{
Description: The sku type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List PremiumMessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_ListByTopic (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Subscriptions operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of subscriptions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
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: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Topics_ListByNamespace (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Topics operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}
,
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: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: AuthorizationRule 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType ,
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)

{
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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_CheckNameAvailability (removed)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability
{
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 ,
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)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_List (removed)
Description :  Gets all Alias(Disaster Recovery configurations)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs
{
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: List of Alias(Disaster Recovery configurations) ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration) ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_CreateOrUpdate (removed)
Description :  Creates or updates a new Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: 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)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_Delete (removed)
Description :  Deletes an Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_Get (removed)
Description :  Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_BreakPairing (removed)
Description :  This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_FailOver (removed)
Description :  Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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 ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: False ,
}
{
properties:
{
Description: Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary. ,
Required: False ,
}
{
IsSafeFailover:
{
Description: Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_ListAuthorizationRules (removed)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: AuthorizationRule 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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_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}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration 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: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DisasterRecoveryConfigs_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}/disasterRecoveryConfigs/{alias}/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 ,
alias:
{
Description: The Disaster Recovery configuration 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 ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListIpFilterRules (removed)
Description :  Gets a list of IP Filter rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules
{
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 IpFilter Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateIpFilterRule (removed)
Description :  Creates or updates an IpFilterRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter Rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
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: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteIpFilterRule (removed)
Description :  Deletes an IpFilterRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetIpFilterRule (removed)
Description :  Gets an IpFilterRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
ipFilterRuleName:
{
Description: The IP Filter 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: Properties supplied to create or update IpFilterRules ,
Required: False ,
}
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: False ,
}
enum ,
filterName:
{
Description: IP Filter name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PremiumMessagingRegions_List (removed)
Description :  Gets the available premium messaging regions for servicebus
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/premiumMessagingRegions
{
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 PremiumMessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Queues_ListByNamespace (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Queues operation. ,
Required: False ,
}
[
{
properties:
{
Description: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of queues. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
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: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Queue Properties ,
Required: False ,
}
{
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
createdAt:
{
Description: The exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
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 ,
sizeInBytes:
{
Description: The size of the queue, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
messageCount:
{
Description: The number of messages in the queue. ,
Format: int64 ,
Required: False ,
}
integer ,
lockDuration:
{
Description: ISO 8601 timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. ,
Format: int32 ,
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 ,
defaultMessageTimeToLive:
{
Description: ISO 8601 default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
deadLetteringOnMessageExpiration:
{
Description: A value that indicates whether this queue has dead letter support when a message expires. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: A value that indicates whether the queue is to be partitioned across multiple message brokers. ,
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 ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_ListBySubscriptions (removed)
Description :  List all the rules within given topic-subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules
{
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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_CreateOrUpdate (removed)
Description :  Creates a new rule and updates an existing rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
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 (200)

{
properties:
{
Description: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Delete (removed)
Description :  Deletes an existing rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Get (removed)
Description :  Retrieves the description for the specified rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
{
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 ,
ruleName:
{
Description: The 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: Properties of Rule resource ,
Required: False ,
}
{
action:
{
Description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. ,
Required: False ,
}
{
sqlExpression:
{
Description: SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
filterType:
{
Description: Filter type that is evaluated against a BrokeredMessage. ,
Enum:
{
SqlFilter: No description available. ,
CorrelationFilter: No description available. ,
}
,
Required: False ,
}
enum ,
sqlFilter:
{
Description: Properties of sqlFilter ,
Required: False ,
}
{
sqlExpression:
{
Description: The SQL expression. e.g. MyProperty='ABC' ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
correlationFilter:
{
Description: Properties of correlationFilter ,
Required: False ,
}
{
properties:
{
Description: dictionary object for custom filters ,
Required: False ,
}
object ,
correlationId:
{
Description: Identifier of the correlation. ,
Required: False ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
Required: False ,
}
string ,
to:
{
Description: Address to send to. ,
Required: False ,
}
string ,
replyTo:
{
Description: Address of the queue to reply to. ,
Required: False ,
}
string ,
label:
{
Description: Application specific label. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session identifier. ,
Required: False ,
}
string ,
replyToSessionId:
{
Description: Session identifier to reply to. ,
Required: False ,
}
string ,
contentType:
{
Description: Content type of the message. ,
Required: False ,
}
string ,
requiresPreprocessing:
{
Description: Value that indicates whether the rule action requires preprocessing. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListVirtualNetworkRules (removed)
Description :  Gets a list of VirtualNetwork rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules
{
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 VirtualNetwork Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateVirtualNetworkRule (removed)
Description :  Creates or updates an VirtualNetworkRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network Rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace VirtualNetworkRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
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: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteVirtualNetworkRule (removed)
Description :  Deletes an VirtualNetworkRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network 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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetVirtualNetworkRule (removed)
Description :  Gets an VirtualNetworkRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The Virtual Network 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: Properties supplied to create or update VirtualNetworkRules ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EventHubs_ListByNamespace (removed)
Description :  Gets all the Event Hubs in a service bus Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/eventhubs
{
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 EventHubs operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Migrate (removed)
Description :  This operation Migrate the given namespace to provided name type
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrate
{
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 ,
parameters:
{
Description: Parameters supplied to migrate namespace type. ,
Required: True ,
}
{
targetNamespaceType:
{
Description: Type of namespaces ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
Mixed: No description available. ,
EventHub: No description available. ,
Relay: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_List (removed)
Description :  Gets all migrationConfigurations
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations
{
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: List of Migration Configs ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_CreateAndStartMigration (removed)
Description :  Creates Migration configuration and starts migration of entities from Standard to Premium namespace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create Migration Configuration ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
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: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Delete (removed)
Description :  Deletes a MigrationConfiguration
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Get (removed)
Description :  Retrieves Migration Config
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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: Properties required to the Create Migration Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Migration Configuration ,
Required: False ,
}
string ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
targetNamespace:
{
Description: Existing premium Namespace ARM Id name which has no entities, will be used for migration ,
Required: True ,
}
string ,
postMigrationName:
{
Description: Name to access Standard Namespace after migration ,
Required: True ,
}
string ,
migrationState:
{
Description: State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_CompleteMigration (removed)
Description :  This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationConfigs_Revert (removed)
Description :  This operation reverts Migration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
configName:
{
Description: The configuration name. Should always be "$default". ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: 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)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
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: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: 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)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of SKU ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. ,
Required: False ,
}
string ,
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 ,
metricId:
{
Description: Identifier for Azure Insights metrics ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  Gets the available PrivateEndpointConnections within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections
{
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: A collection of private endpoint connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private endpoint connection resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Creates or updates PrivateEndpointConnections of service namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes an existing Private Endpoint Connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets a description for the specified Private Endpoint Connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets lists of resources that supports Privatelinks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources
{
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: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Required: False ,
}
string ,
requiredMembers:
{
Description: Required Members ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required Zone Names ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateNetworkRuleSet (removed)
Description :  Create or update NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default
{
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 ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetNetworkRuleSet (removed)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default
{
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)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListNetworkRuleSets (removed)
Description :  Gets list of NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets
{
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 NetworkRuleSet operation. ,
Required: False ,
}
[
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Regions_ListBySku (removed)
Description :  Gets the available Regions for a given sku
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/sku/{sku}/regions
{
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 ,
sku:
{
Description: The sku type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List PremiumMessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_ListByTopic (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Subscriptions operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of subscriptions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
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: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of subscriptions resource. ,
Required: False ,
}
{
messageCount:
{
Description: Number of messages. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time there was a receive request to this subscription. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
lockDuration:
{
Description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. ,
Format: duration ,
Required: False ,
}
string ,
requiresSession:
{
Description: Value indicating if a subscription supports the concept of sessions. ,
Required: False ,
}
boolean ,
defaultMessageTimeToLive:
{
Description: ISO 8061 Default message timespan 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. ,
Format: duration ,
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 ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: Number of maximum deliveries. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
forwardTo:
{
Description: Queue/Topic name to forward the messages ,
Required: False ,
}
string ,
forwardDeadLetteredMessagesTo:
{
Description: Queue/Topic name to forward the Dead Letter message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Topics_ListByNamespace (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 ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Topics operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
properties:
{
Description: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}
,
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: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: Properties of topic resource. ,
Required: False ,
}
{
sizeInBytes:
{
Description: Size of the topic, in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
accessedAt:
{
Description: Last time the message was sent, or a request was received, for this topic. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionCount:
{
Description: Number of subscriptions. ,
Format: int32 ,
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 ,
transferMessageCount:
{
Description: Number of messages transferred to another queue, topic, or subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
transferDeadLetterMessageCount:
{
Description: Number of messages transferred into dead letters. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
defaultMessageTimeToLive:
{
Description: ISO 8601 Default message timespan 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. ,
Format: duration ,
Required: False ,
}
string ,
maxSizeInMegabytes:
{
Description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: Value indicating if this topic requires duplicate detection. ,
Required: False ,
}
boolean ,
duplicateDetectionHistoryTimeWindow:
{
Description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enableBatchedOperations:
{
Description: Value that indicates whether server-side batched operations are enabled. ,
Required: False ,
}
boolean ,
status:
{
Description: Enumerates the possible values for the status of a messaging entity. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
supportOrdering:
{
Description: Value that indicates whether the topic supports ordering. ,
Required: False ,
}
boolean ,
autoDeleteOnIdle:
{
Description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
enablePartitioning:
{
Description: Value that indicates whether the topic to be partitioned across multiple message brokers is 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}