clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.event_hubs.clusters

Fields

Name	Datatype	Description
location	string	Resource location.
properties	object	Event Hubs Cluster properties supplied in responses in List or Get operations.
sku	object	SKU parameters particular to a cluster instance.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Gets the resource description of the specified Event Hubs Cluster.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists the available Event Hubs Clusters within an ARM resource group
list_by_subscription	SELECT	subscriptionId	Lists the available Event Hubs Clusters within an ARM resource group
create_or_update	INSERT	clusterName, resourceGroupName, subscriptionId	Creates or updates an instance of an Event Hubs Cluster.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes an existing Event Hubs Cluster. This operation is idempotent.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

SELECT examples

Lists the available Event Hubs Clusters within an ARM resource group

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.event_hubs.clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.event_hubs.clusters (
clusterName,
resourceGroupName,
subscriptionId,
sku,
properties,
location,
tags
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ sku }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: capacity
          value: integer
    - 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: properties
      value:
        - name: createdAt
          value: string
        - name: provisioningState
          value: string
        - name: updatedAt
          value: string
        - name: metricId
          value: string
        - name: status
          value: string
        - name: supportsScaling
          value: boolean
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE azure.event_hubs.clusters
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified clusters resource.

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