Namespaces - Authorization Rules - Create Or Update Authorization Rule

Creates or updates an AuthorizationRule for a Namespace.

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

URI Parameters

Name In Required Type Description
authorizationRuleName
path True
  • string

The authorization rule 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.

Request Body

Name Required Type Description
properties.rights True
  • string[]

The rights associated with the rule.

Responses

Name Type Description
200 OK

Namespace AuthorizationRule created

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

NameSpaceAuthorizationRuleCreate

Sample Request

PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/authorizationRules/sdk-Authrules-1746?api-version=2021-01-01-preview
{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules/sdk-Authrules-1746",
  "name": "sdk-Authrules-1746",
  "type": "Microsoft.EventHub/Namespaces/AuthorizationRules",
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ]
  }
}

Definitions

AuthorizationRule

Single item in a List or Get AuthorizationRule operation

createdByType

The type of identity that created the resource.

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.

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.

systemData

The system meta data relating to this resource.

type
  • string

Resource type.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorResponse

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
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

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

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

The type of identity that last modified the resource.