Microsoft.StreamAnalytics clusters

Bicep resource definition

The clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

A basic example of deploying Stream Analytics Cluster.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource cluster 'Microsoft.StreamAnalytics/clusters@2020-03-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 36
    name: 'Default'
  }
}

Resource format

To create a Microsoft.StreamAnalytics/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StreamAnalytics/clusters@2020-03-01' = {
  location: 'string'
  name: 'string'
  properties: {}
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.StreamAnalytics/clusters

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
properties The properties associated with a Stream Analytics cluster. ClusterProperties
sku The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests. ClusterSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

ClusterProperties

Name Description Value

ClusterSku

Name Description Value
capacity Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. int

Constraints:
Min value = 36
Max value = 396
name Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. 'Default'

TrackedResourceTags

Name Description Value

ARM template resource definition

The clusters resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.StreamAnalytics/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.StreamAnalytics/clusters",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "properties": {
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.StreamAnalytics/clusters

Name Description Value
apiVersion The api version '2020-03-01'
location The geo-location where the resource lives string
name The resource name string (required)
properties The properties associated with a Stream Analytics cluster. ClusterProperties
sku The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests. ClusterSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.StreamAnalytics/clusters'

ClusterProperties

Name Description Value

ClusterSku

Name Description Value
capacity Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. int

Constraints:
Min value = 36
Max value = 396
name Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. 'Default'

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The clusters resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Usage Examples

Terraform Samples

A basic example of deploying Stream Analytics Cluster.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "cluster" {
  type      = "Microsoft.StreamAnalytics/clusters@2020-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    sku = {
      capacity = 36
      name     = "Default"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  timeouts {
    create = "180m"
    update = "180m"
    delete = "60m"
  }
}

Resource format

To create a Microsoft.StreamAnalytics/clusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StreamAnalytics/clusters@2020-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

Property Values

Microsoft.StreamAnalytics/clusters

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
properties The properties associated with a Stream Analytics cluster. ClusterProperties
sku The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests. ClusterSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.StreamAnalytics/clusters@2020-03-01"

ClusterProperties

Name Description Value

ClusterSku

Name Description Value
capacity Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. int

Constraints:
Min value = 36
Max value = 396
name Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. 'Default'

TrackedResourceTags

Name Description Value
  • Last updated on