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

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.
capacityAllocated	integer	Represents the number of streaming units currently being used on the cluster.
capacityAssigned	integer	Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.
clusterId	string	Unique identifier for the cluster.
createdDate	string (date-time)	The date this cluster was created.
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.
provisioningState	string	The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled. Known values are: "Succeeded", "Failed", "Canceled", and "InProgress".
sku	object	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

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.
capacityAllocated	integer	Represents the number of streaming units currently being used on the cluster.
capacityAssigned	integer	Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.
clusterId	string	Unique identifier for the cluster.
createdDate	string (date-time)	The date this cluster was created.
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.
provisioningState	string	The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled. Known values are: "Succeeded", "Failed", "Canceled", and "InProgress".
sku	object	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

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.
capacityAllocated	integer	Represents the number of streaming units currently being used on the cluster.
capacityAssigned	integer	Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.
clusterId	string	Unique identifier for the cluster.
createdDate	string (date-time)	The date this cluster was created.
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.
provisioningState	string	The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled. Known values are: "Succeeded", "Failed", "Canceled", and "InProgress".
sku	object	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

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 information about the specified cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all of the clusters in the given resource group.
list_by_subscription	select	subscription_id		Lists all of the clusters in the given subscription.
create_or_update	insert	resource_group_name, cluster_name, subscription_id	If-Match, If-None-Match	Creates a Stream Analytics Cluster or replaces an already existing cluster.
update	update	resource_group_name, cluster_name, subscription_id	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.
create_or_update	replace	resource_group_name, cluster_name, subscription_id	If-Match, If-None-Match	Creates a Stream Analytics Cluster or replaces an already existing cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes the specified cluster.
list_streaming_jobs	exec	resource_group_name, cluster_name, subscription_id		Lists all of the streaming jobs in the given 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 cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
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. Default value is None.
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. Default value is None.

SELECT examples

get

Gets information about the specified cluster.

SELECT
id,
name,
capacityAllocated,
capacityAssigned,
clusterId,
createdDate,
etag,
location,
provisioningState,
sku,
tags,
type
FROM azure.stream_analytics.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 all of the clusters in the given resource group.

SELECT
id,
name,
capacityAllocated,
capacityAssigned,
clusterId,
createdDate,
etag,
location,
provisioningState,
sku,
tags,
type
FROM azure.stream_analytics.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all of the clusters in the given subscription.

SELECT
id,
name,
capacityAllocated,
capacityAssigned,
clusterId,
createdDate,
etag,
location,
provisioningState,
sku,
tags,
type
FROM azure.stream_analytics.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.stream_analytics.clusters (
tags,
location,
sku,
properties,
resource_group_name,
cluster_name,
subscription_id,
If-Match,
If-None-Match
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: sku
    description: |
      The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: properties
    description: |
      The properties associated with a Stream Analytics cluster.
    value:
      createdDate: "{{ createdDate }}"
      clusterId: "{{ clusterId }}"
      provisioningState: "{{ provisioningState }}"
      capacityAllocated: {{ capacityAllocated }}
      capacityAssigned: {{ capacityAssigned }}
  - name: If-Match
    value: "{{ If-Match }}"
    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. Default value is None.
    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. Default value is None.
  - name: If-None-Match
    value: "{{ If-None-Match }}"
    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. Default value is None.
    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. Default value is None.

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 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.stream_analytics.clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
AND If-None-Match = '{{ If-None-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes the specified cluster.

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

Lifecycle Methods

list_streaming_jobs

Lists all of the streaming jobs in the given cluster.

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