clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.stream_analytics.clusters

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified cluster.

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.

list_by_resource_group

Successfully listed the clusters under the specified resource group.

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.

list_by_subscription

Successfully listed the clusters under the specified subscription.

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName		Gets information about the specified cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		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	subscriptionId, resourceGroupName, clusterName	If-Match, If-None-Match	Creates a Stream Analytics Cluster or replaces an already existing cluster.
update	update	subscriptionId, resourceGroupName, clusterName	If-Match	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.
delete	delete	subscriptionId, resourceGroupName, clusterName		Deletes the specified 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
clusterName	string	The name of the cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
If-Match	string	The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets information about the specified cluster.

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

list_by_resource_group

Lists all of the clusters in the given resource group.

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

list_by_subscription

Lists all of the clusters in the given subscription.

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.stream_analytics.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a Stream Analytics Cluster or replaces an already existing cluster.

INSERT INTO azure.stream_analytics.clusters (
data__tags,
data__location,
data__sku,
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
If-Match,
If-None-Match
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
sku,
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: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: sku
      value: object
      description: |
        The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
    - name: properties
      value: object
      description: |
        The properties associated with a Stream Analytics cluster.
    - name: If-Match
      value: string
      description: The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

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.

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

DELETE examples

delete

Deletes the specified cluster.

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