clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.event_hub.clusters

Fields

The following fields are returned by SELECT queries:

get

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.
createdAt	string	The UTC time when the Event Hubs Cluster was created.
location	string	Resource location.
metricId	string	The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
sku	object	Properties of the cluster SKU.
status	string	Status of the Cluster resource.
supportsScaling	boolean	A value that indicates whether Scaling is Supported.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedAt	string	The UTC time when the Event Hubs Cluster was last updated.

list_by_resource_group

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.
createdAt	string	The UTC time when the Event Hubs Cluster was created.
location	string	Resource location.
metricId	string	The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
sku	object	Properties of the cluster SKU.
status	string	Status of the Cluster resource.
supportsScaling	boolean	A value that indicates whether Scaling is Supported.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedAt	string	The UTC time when the Event Hubs Cluster was last updated.

list_by_subscription

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.
createdAt	string	The UTC time when the Event Hubs Cluster was created.
location	string	Resource location.
metricId	string	The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
sku	object	Properties of the cluster SKU.
status	string	Status of the Cluster resource.
supportsScaling	boolean	A value that indicates whether Scaling is Supported.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedAt	string	The UTC time when the Event Hubs Cluster was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets the resource description of the specified Event Hubs Cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the available Event Hubs Clusters within an ARM resource group.
list_by_subscription	select	subscription_id		Lists the available Event Hubs Clusters within an ARM resource group.
create_or_update	insert	resource_group_name, cluster_name, subscription_id		Creates or updates an instance of an Event Hubs Cluster.
update	update	resource_group_name, cluster_name, subscription_id		Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
create_or_update	replace	resource_group_name, cluster_name, subscription_id		Creates or updates an instance of an Event Hubs Cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes an existing Event Hubs Cluster. This operation is idempotent.
list_available_cluster_region	exec	subscription_id		List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
list_namespaces	exec	resource_group_name, cluster_name, subscription_id		List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

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
cluster_name	string	The name of the Event Hubs Cluster. Required.
resource_group_name	string	Name of the resource group within the azure subscription. Required.
subscription_id	string

SELECT examples

get

Gets the resource description of the specified Event Hubs Cluster.

SELECT
id,
name,
createdAt,
location,
metricId,
sku,
status,
supportsScaling,
systemData,
tags,
type,
updatedAt
FROM azure.event_hub.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the available Event Hubs Clusters within an ARM resource group.

SELECT
id,
name,
createdAt,
location,
metricId,
sku,
status,
supportsScaling,
systemData,
tags,
type,
updatedAt
FROM azure.event_hub.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists the available Event Hubs Clusters within an ARM resource group.

SELECT
id,
name,
createdAt,
location,
metricId,
sku,
status,
supportsScaling,
systemData,
tags,
type,
updatedAt
FROM azure.event_hub.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an instance of an Event Hubs Cluster.

INSERT INTO azure.event_hub.clusters (
location,
tags,
sku,
properties,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clusters resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: sku
    description: |
      Properties of the cluster SKU.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      supportsScaling: {{ supportsScaling }}

UPDATE examples

update

Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

UPDATE azure.event_hub.clusters
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an instance of an Event Hubs Cluster.

REPLACE azure.event_hub.clusters
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes an existing Event Hubs Cluster. This operation is idempotent.

DELETE FROM azure.event_hub.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_available_cluster_region

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

EXEC azure.event_hub.clusters.list_available_cluster_region 
@subscription_id='{{ subscription_id }}' --required
;

list_namespaces

List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

EXEC azure.event_hub.clusters.list_namespaces 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;