event_hubs

Creates, updates, deletes, gets or lists a event_hubs resource.

Overview

Name	event_hubs
Type	Resource
Id	azure.event_hubs.event_hubs

Fields

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 the Create Or Update Event Hub operation.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	eventHubName, namespaceName, resourceGroupName, subscriptionId	Gets an Event Hubs description for the specified Event Hub.
list_by_namespace	SELECT	namespaceName, resourceGroupName, subscriptionId	Gets all the Event Hubs in a Namespace.
create_or_update	INSERT	eventHubName, namespaceName, resourceGroupName, subscriptionId	Creates or updates a new Event Hub as a nested resource within a Namespace.
delete	DELETE	eventHubName, namespaceName, resourceGroupName, subscriptionId	Deletes an Event Hub from the specified Namespace and resource group.
regenerate_keys	EXEC	authorizationRuleName, eventHubName, namespaceName, resourceGroupName, subscriptionId, data__keyType	Regenerates the ACS and SAS connection strings for the Event Hub.

SELECT examples

Gets all the Event Hubs in a Namespace.

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

INSERT example

Use the following StackQL query and manifest file to create a new event_hubs resource.

All Properties

/*+ create */
INSERT INTO azure.event_hubs.event_hubs (
eventHubName,
namespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ eventHubName }}',
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string

DELETE example

Deletes the specified event_hubs resource.

/*+ delete */
DELETE FROM azure.event_hubs.event_hubs
WHERE eventHubName = '{{ eventHubName }}'
AND namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';