clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.event_hubs.clusters

Fields

The following fields are returned by SELECT queries:

get

Event Hubs Cluster resource description returned successfully.

Name	Datatype	Description
location	string	Resource location.
properties	object	Event Hubs Cluster properties supplied in responses in List or Get operations.
sku	object	Properties of the cluster SKU.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_resource_group

Clusters returned successfully.

Name	Datatype	Description
location	string	Resource location.
properties	object	Event Hubs Cluster properties supplied in responses in List or Get operations.
sku	object	Properties of the cluster SKU.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_subscription

Clusters returned successfully.

Name	Datatype	Description
location	string	Resource location.
properties	object	Event Hubs Cluster properties supplied in responses in List or Get operations.
sku	object	Properties of the cluster SKU.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName		Gets the resource description of the specified Event Hubs Cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		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	subscriptionId, resourceGroupName, clusterName, data__location		Creates or updates an instance of an Event Hubs Cluster.
update	update	subscriptionId, resourceGroupName, clusterName		Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
delete	delete	subscriptionId, resourceGroupName, clusterName		Deletes an existing Event Hubs Cluster. This operation is idempotent.

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
clusterName	string	The name of the Event Hubs Cluster.
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 the resource description of the specified Event Hubs Cluster.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.event_hubs.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

list_by_resource_group

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 }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

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 }}' -- required
;

INSERT examples

create_or_update

Creates or updates an instance of an Event Hubs Cluster.

INSERT INTO azure.event_hubs.clusters (
data__sku,
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
clusterName
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}'
RETURNING
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: sku
      value: object
      description: |
        Properties of the cluster SKU.
    - name: properties
      value: object
      description: |
        Event Hubs Cluster properties supplied in responses in List or Get operations.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

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

UPDATE azure.event_hubs.clusters
SET 
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
RETURNING
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

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

DELETE FROM azure.event_hubs.clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
;