Microsoft.ServiceBus (preview:2025-05-01)

2025/07/25 • 70 new 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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 (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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of queues. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
Required: False ,
}
integer ,
requiresDuplicateDetection:
{
Description: A value indicating if this queue requires duplicate detection. ,
Required: False ,
}
boolean ,
requiresSession:
{
Description: A value that indicates whether the queue supports the concept of sessions. ,
Required: False ,
}
boolean ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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)

{
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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 ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
}
,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 ,
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: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the namespace. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
keyVersion:
{
Description: Version of KeyVault ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Service Bus namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name for namespace ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
premiumMessagingPartitions:
{
Description: The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 ,
Format: int32 ,
Required: False ,
}
integer ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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_Failover (new)
Description :  GeoDR Failover
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/failover
{
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 ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
primaryLocation:
{
Description: Query parameter for the new primary location after failover. ,
Required: False ,
}
string ,
force:
{
Description: If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfiguration_List (new)
Description :  Gets list of current NetworkSecurityPerimeterConfiguration for Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations
{
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 NetworkSecurityPerimeterConfigurations ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of NetworkSecurityPerimeter configuration propagation ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
InvalidResponse: No description available. ,
Succeeded: No description available. ,
SucceededWithIssues: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
NoAssociationMode: No description available. ,
EnforcedMode: No description available. ,
LearningMode: No description available. ,
AuditMode: No description available. ,
UnspecifiedMode: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about current network profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
string ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
isBackingResource:
{
Description: True if the ServiceBus namespace is backed by another Azure resource and not visible to end users. ,
Required: False ,
}
boolean ,
applicableFeatures:
{
Description: Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane. ,
Required: False ,
}
[
string ,
]
,
parentAssociationName:
{
Description: Source Resource Association name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM Id of source resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.ServiceBus/Namespaces" or "Microsoft.ServiceBus/Namespaces/ServiceBus" ,
Required: False ,
}
string ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of NetworkSecurityPerimeterConfiguration list. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description :  Refreshes any information about the association.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}/reconcile
{
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 ,
resourceAssociationName:
{
Description: The ResourceAssociation Name ,
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 ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_GetResourceAssociationName (new)
Description :  Return a NetworkSecurityPerimeterConfigurations resourceAssociationName
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}
{
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 ,
resourceAssociationName:
{
Description: The ResourceAssociation Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of NetworkSecurityPerimeter configuration propagation ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
InvalidResponse: No description available. ,
Succeeded: No description available. ,
SucceededWithIssues: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
NoAssociationMode: No description available. ,
EnforcedMode: No description available. ,
LearningMode: No description available. ,
AuditMode: No description available. ,
UnspecifiedMode: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about current network profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
string ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
isBackingResource:
{
Description: True if the ServiceBus namespace is backed by another Azure resource and not visible to end users. ,
Required: False ,
}
boolean ,
applicableFeatures:
{
Description: Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane. ,
Required: False ,
}
[
string ,
]
,
parentAssociationName:
{
Description: Source Resource Association name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM Id of source resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.ServiceBus/Namespaces" or "Microsoft.ServiceBus/Namespaces/ServiceBus" ,
Required: False ,
}
string ,
location:
{
Description: The geo-location where the resource lives ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
isClientAffine:
{
Description: Value that indicates whether the subscription has an affinity to the client id. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
clientAffineProperties:
{
Description: Properties specific to client affine subscriptions. ,
Required: False ,
}
{
clientId:
{
Description: Indicates the Client ID of the application that created the client-affine subscription. ,
Required: False ,
}
string ,
isDurable:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is durable or not. ,
Required: False ,
}
boolean ,
isShared:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is shared or not. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of subscriptions. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
isClientAffine:
{
Description: Value that indicates whether the subscription has an affinity to the client id. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
clientAffineProperties:
{
Description: Properties specific to client affine subscriptions. ,
Required: False ,
}
{
clientId:
{
Description: Indicates the Client ID of the application that created the client-affine subscription. ,
Required: False ,
}
string ,
isDurable:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is durable or not. ,
Required: False ,
}
boolean ,
isShared:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is shared or not. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
isClientAffine:
{
Description: Value that indicates whether the subscription has an affinity to the client id. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
clientAffineProperties:
{
Description: Properties specific to client affine subscriptions. ,
Required: False ,
}
{
clientId:
{
Description: Indicates the Client ID of the application that created the client-affine subscription. ,
Required: False ,
}
string ,
isDurable:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is durable or not. ,
Required: False ,
}
boolean ,
isShared:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is shared or not. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
isClientAffine:
{
Description: Value that indicates whether the subscription has an affinity to the client id. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
clientAffineProperties:
{
Description: Properties specific to client affine subscriptions. ,
Required: False ,
}
{
clientId:
{
Description: Indicates the Client ID of the application that created the client-affine subscription. ,
Required: False ,
}
string ,
isDurable:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is durable or not. ,
Required: False ,
}
boolean ,
isShared:
{
Description: For client-affine subscriptions, this value indicates whether the subscription is shared or not. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of topics. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: 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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
maxMessageSizeInKilobytes:
{
Description: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. ,
Format: int64 ,
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 ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}