clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.stream_analytics.clusters

Fields

vw_clusters

Name	Datatype	Description
capacity_allocated	text	field from the properties object
capacity_assigned	text	field from the properties object
clusterName	text	field from the properties object
cluster_id	text	field from the properties object
created_date	text	field from the properties object
etag	text	The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
subscriptionId	text	field from the properties object
tags	text	Resource tags.

clusters

Name	Datatype	Description
etag	string	The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
location	string	The geo-location where the resource lives
properties	object	The properties associated with a Stream Analytics cluster.
sku	object	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Gets information about the specified cluster.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all of the clusters in the given resource group.
list_by_subscription	SELECT	subscriptionId	Lists all of the clusters in the given subscription.
create_or_update	INSERT	clusterName, resourceGroupName, subscriptionId	Creates a Stream Analytics Cluster or replaces an already existing cluster.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes the specified cluster.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

SELECT examples

Lists all of the clusters in the given subscription.

vw_clusters

SELECT
capacity_allocated,
capacity_assigned,
clusterName,
cluster_id,
created_date,
etag,
location,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags
FROM azure.stream_analytics.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.stream_analytics.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.stream_analytics.clusters (
clusterName,
resourceGroupName,
subscriptionId,
tags,
location,
sku,
properties
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: capacity
          value: integer
    - name: etag
      value: string
    - name: properties
      value:
        - name: createdDate
          value: string
        - name: clusterId
          value: string
        - name: provisioningState
          value: []
        - name: capacityAllocated
          value: integer
        - name: capacityAssigned
          value: integer

UPDATE example

Updates a clusters resource.

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

DELETE example

Deletes the specified clusters resource.

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