Namespaces - Authorization Rules - List Authorization Rules

Gets the authorization rules for a namespace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules?api-version=2024-01-01

URI Parameters

Name In Required Type Description
namespaceName
path True

string

The namespace name

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

SBAuthorizationRuleListResult

Namespace authorization rules returned successfully.

Other Status Codes

ErrorResponse

ServiceBus error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

NameSpaceAuthorizationRuleListAll

Sample request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2024-01-01

Sample response

{
  "value": [
    {
      "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey",
      "name": "RootManageSharedAccessKey",
      "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Manage",
          "Send"
        ]
      }
    },
    {
      "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/sdk-AuthRules-1788",
      "name": "sdk-AuthRules-1788",
      "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    }
  ]
}

Definitions

Name Description
AccessRights

The rights associated with the rule.

createdByType

The type of identity that created the resource.

Error

The error object.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

The resource management error response.

SBAuthorizationRule

Description of a namespace authorization rule.

SBAuthorizationRuleListResult

The response to the List Namespace operation.

systemData

Metadata pertaining to creation and last modification of the resource.

AccessRights

The rights associated with the rule.

Name Type Description
Listen

string

Manage

string

Send

string

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

The error object.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorResponse[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorResponse

The resource management error response.

Name Type Description
error

Error

The error object.

SBAuthorizationRule

Description of a namespace authorization rule.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.rights

AccessRights[]

The rights associated with the rule.

systemData

systemData

The system meta data relating to this resource.

type

string

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

SBAuthorizationRuleListResult

The response to the List Namespace operation.

Name Type Description
nextLink

string

Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules.

value

SBAuthorizationRule[]

Result of the List Authorization Rules operation.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The type of identity that last modified the resource.

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.