Disaster Recovery Configs - List Authorization Rules

Gets a list of authorization rules for a Namespace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules?api-version=2017-04-01

URI Parameters

Name In Required Type Description
alias
path True
  • string

The Disaster Recovery configuration name

namespaceName
path True
  • string

The Namespace name

resourceGroupName
path True
  • string

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

Namespace AuthorizationRule successfully returned.

Other Status Codes

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/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules?api-version=2017-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/RootManageSharedAccessKey",
      "name": "RootManageSharedAccessKey",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Manage",
          "Send"
        ]
      }
    },
    {
      "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1067",
      "name": "sdk-Authrules-1067",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    },
    {
      "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1684",
      "name": "sdk-Authrules-1684",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    },
    {
      "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879",
      "name": "sdk-Authrules-4879",
      "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    }
  ]
}

Definitions

AuthorizationRule

Single item in a List or Get AuthorizationRule operation

AuthorizationRuleListResult

The response from the List namespace operation.

ErrorResponse

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

AuthorizationRule

Single item in a List or Get AuthorizationRule operation

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.rights
  • string[]

The rights associated with the rule.

type
  • string

Resource type

AuthorizationRuleListResult

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

Result of the List Authorization Rules operation.

ErrorResponse

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

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.