Cluster

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-stream-analytics/json-schema/microsoft-azure-stream-analytics-cluster-schema.json",
  "title": "Cluster",
  "description": "A Stream Analytics Cluster object",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-stream-analytics-clusters-api-openapi.yml#/components/schemas/Cluster",
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "description": "The resource model definition for a ARM tracked top level resource",
      "properties": {
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "x-ms-mutability": [
            "read",
            "create",
            "update"
          ],
          "description": "Resource tags."
        },
        "location": {
          "type": "string",
          "x-ms-mutability": [
            "read",
            "create"
          ],
          "description": "The geo-location where the resource lives"
        }
      },
      "allOf": [
        {
          "type": "object",
          "description": "The base resource definition",
          "properties": {
            "id": {
              "readOnly": true,
              "type": "string",
              "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
            },
            "name": {
              "readOnly": true,
              "type": "string",
              "description": "The name of the resource"
            },
            "type": {
              "readOnly": true,
              "type": "string",
              "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts."
            }
          },
          "x-ms-azure-resource": true
        }
      ]
    }
  ],
  "properties": {
    "sku": {
      "$ref": "#/$defs/ClusterSku"
    },
    "etag": {
      "description": "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.",
      "type": "string",
      "readOnly": true
    },
    "properties": {
      "$ref": "#/$defs/ClusterProperties"
    }
  },
  "$defs": {
    "ClusterProperties": {
      "type": "object",
      "description": "The properties associated with a Stream Analytics cluster.",
      "properties": {
        "createdDate": {
          "description": "The date this cluster was created.",
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "clusterId": {
          "description": "Unique identifier for the cluster.",
          "type": "string",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/$defs/ClusterProvisioningState"
        },
        "capacityAllocated": {
          "description": "Represents the number of streaming units currently being used on the cluster.",
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "capacityAssigned": {
          "description": "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.",
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      }
    },
    "ClusterProvisioningState": {
      "description": "The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled",
      "readOnly": true,
      "type": "string",
      "enum": [
        "Succeeded",
        "Failed",
        "Canceled",
        "InProgress"
      ],
      "x-ms-enum": {
        "name": "ClusterProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "value": "Succeeded",
            "description": "The cluster provisioning succeeded."
          },
          {
            "value": "Failed",
            "description": "The cluster provisioning failed."
          },
          {
            "value": "Canceled",
            "description": "The cluster provisioning was canceled."
          },
          {
            "value": "InProgress",
            "description": "The cluster provisioning was inprogress."
          }
        ]
      }
    },
    "ClusterSku": {
      "type": "object",
      "description": "The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.",
      "properties": {
        "name": {
          "description": "Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.",
          "type": "string",
          "enum": [
            "Default"
          ],
          "x-ms-enum": {
            "name": "ClusterSkuName",
            "modelAsString": true,
            "values": [
              {
                "value": "Default",
                "description": "The default SKU."
              }
            ]
          }
        },
        "capacity": {
          "description": "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.",
          "type": "integer",
          "format": "int32",
          "minimum": 36,
          "maximum": 396
        }
      }
    }
  }
}