authorization_rules

Creates, updates, deletes, gets or lists an authorization_rules resource.

Overview

Name	authorization_rules
Type	Resource
Id	azure.event_hubs.authorization_rules

Fields

The following fields are returned by SELECT queries:

get

Event Hub AuthorizationRule successfully returned.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	The geo-location where the resource lives
properties		Properties supplied to create or update AuthorizationRule
systemData	object	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"

list

Event Hub AuthorizationRule returned successfully.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	The geo-location where the resource lives
properties		Properties supplied to create or update AuthorizationRule
systemData	object	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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, eventHubName, authorizationRuleName, subscriptionId		Gets an AuthorizationRule for an Event Hub by rule name.
list	select	resourceGroupName, namespaceName, eventHubName, subscriptionId		Gets the authorization rules for an Event Hub.
create_or_update	insert	resourceGroupName, namespaceName, eventHubName, authorizationRuleName, subscriptionId		Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
delete	delete	resourceGroupName, namespaceName, eventHubName, authorizationRuleName, subscriptionId		Deletes an Event Hub AuthorizationRule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
authorizationRuleName	string	The authorization rule name.
eventHubName	string	The Event Hub name
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets an AuthorizationRule for an Event Hub by rule name.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND eventHubName = '{{ eventHubName }}' -- required
AND authorizationRuleName = '{{ authorizationRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the authorization rules for an Event Hub.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND eventHubName = '{{ eventHubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

INSERT INTO azure.event_hubs.authorization_rules (
data__properties,
resourceGroupName,
namespaceName,
eventHubName,
authorizationRuleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ eventHubName }}',
'{{ authorizationRuleName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: authorization_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the authorization_rules resource.
    - name: namespaceName
      value: string
      description: Required parameter for the authorization_rules resource.
    - name: eventHubName
      value: string
      description: Required parameter for the authorization_rules resource.
    - name: authorizationRuleName
      value: string
      description: Required parameter for the authorization_rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the authorization_rules resource.
    - name: properties
      value: string
      description: |
        Properties supplied to create or update AuthorizationRule

DELETE examples

delete

Deletes an Event Hub AuthorizationRule.

DELETE FROM azure.event_hubs.authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND eventHubName = '{{ eventHubName }}' --required
AND authorizationRuleName = '{{ authorizationRuleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;