Share via

Authorization Rules - Namespaces - List Authorization Rules

Service:
Event Hubs
API Version:
2024-01-01

Gets a list of authorization rules for a Namespace.

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

URI Parameters

Name In Required Type Description
namespaceName
 path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

The Namespace name
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Name of the resource group within the azure subscription.
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

Client API Version.

Responses

Name Type Description
200 OK

AuthorizationRuleListResult

Namespace AuthorizationRule successfully returned.
Other Status Codes

ErrorResponse

Eventhub 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

ListAuthorizationRules

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey",
      "name": "RootManageSharedAccessKey",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Manage",
          "Send"
        ]
      }
    },
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules?api-version=2017-04-01/sdk-Authrules-1746",
      "name": "sdk-Authrules-1746",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    }
  ]
}

Definitions

Name Description
AccessRights

The rights associated with the rule.
AuthorizationRule

Single item in a List or Get AuthorizationRule operation
AuthorizationRuleListResult

The response from the List namespace operation.
createdByType

The type of identity that created the resource.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
systemData

Metadata pertaining to creation and last modification of the resource.

AccessRights

Enumeration

The rights associated with the rule.

Value Description
Manage
Send
Listen

AuthorizationRule

Object

Single item in a List or Get AuthorizationRule operation

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"

AuthorizationRuleListResult

Object

The response from the List namespace operation.

Name Type Description
nextLink

string

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

AuthorizationRule[]

Result of the List Authorization Rules operation.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
error

ErrorDetail

The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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.