Azure Stream Analytics Clusters API

openapi: 3.2.0
info:
  title: StreamAnalyticsManagementClient Clusters API
  version: '2020-03-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Clusters
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}
  : put:
      tags:
      - Clusters
      description: Creates a Stream Analytics Cluster or replaces an already existing cluster.
      operationId: Clusters_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      responses:
        '200':
          description: The cluster was successfully created or replaced.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '201':
          description: The cluster was successfully created or replaced.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
        description: The definition of the cluster that will be used to create a new cluster or replace the existing one.
        required: true
      summary: Clusters create or update
      x-summary-source: derived
    patch:
      tags:
      - Clusters
      description: 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.
      operationId: Clusters_Update
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        '200':
          description: The cluster was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '202':
          description: The update request was successfully initiated.
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
        description: The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).
        required: true
      summary: Clusters update
      x-summary-source: derived
    get:
      tags:
      - Clusters
      description: Gets information about the specified cluster.
      operationId: Clusters_Get
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the specified cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Clusters get
      x-summary-source: derived
    delete:
      tags:
      - Clusters
      description: Deletes the specified cluster.
      operationId: Clusters_Delete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The cluster was successfully deleted.
        '202':
          description: The delete request was successfully initiated.
        '204':
          description: The cluster does not exist.
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-long-running-operation: true
      summary: Clusters delete
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/clusters:
    get:
      tags:
      - Clusters
      description: Lists all of the clusters in the given subscription.
      operationId: Clusters_ListBySubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully listed the clusters under the specified subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterListResult'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Clusters list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters:
    get:
      tags:
      - Clusters
      description: Lists all of the clusters in the given resource group.
      operationId: Clusters_ListByResourceGroup
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully listed the clusters under the specified resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterListResult'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Clusters list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/listStreamingJobs
  : post:
      tags:
      - Clusters
      description: Lists all of the streaming jobs in the given cluster.
      operationId: Clusters_ListStreamingJobs
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully listed the streaming jobs in the specified cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterJobListResult'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Clusters list streaming jobs
      x-summary-source: derived
components:
  schemas:
    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
    ClusterJobListResult:
      type: object
      description: A list of streaming jobs. Populated by a List operation.
      properties:
        value:
          description: A list of streaming jobs.
          type: array
          items:
            $ref: '#/components/schemas/ClusterJob'
          readOnly: true
        nextLink:
          type: string
          description: The URL to fetch the next set of streaming jobs.
          readOnly: true
    Cluster:
      type: object
      description: A Stream Analytics Cluster object
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      properties:
        sku:
          $ref: '#/components/schemas/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:
          x-ms-client-flatten: true
          description: The properties associated with a Stream Analytics cluster.
          $ref: '#/components/schemas/ClusterProperties'
    JobState:
      description: The current execution state of the streaming job.
      type: string
      readOnly: true
      enum:
      - Created
      - Starting
      - Running
      - Stopping
      - Stopped
      - Deleting
      - Failed
      - Degraded
      - Restarting
      - Scaling
      x-ms-enum:
        name: JobState
        modelAsString: true
        values:
        - value: Created
          description: The job is currently in the Created state.
        - value: Starting
          description: The job is currently in the Starting state.
        - value: Running
          description: The job is currently in the Running state.
        - value: Stopping
          description: The job is currently in the Stopping state.
        - value: Stopped
          description: The job is currently in the Stopped state.
        - value: Deleting
          description: The job is currently in the Deleting state.
        - value: Failed
          description: The job is currently in the Failed state.
        - value: Degraded
          description: The job is currently in the Degraded state.
        - value: Restarting
          description: The job is currently in the Restarting state.
        - value: Scaling
          description: The job is currently in the Scaling state.
    ClusterListResult:
      type: object
      description: A list of clusters populated by a 'list' operation.
      properties:
        value:
          description: A list of clusters.
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
          readOnly: true
        nextLink:
          description: The URL to fetch the next set of clusters.
          type: string
          readOnly: true
    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: '#/components/schemas/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.
    ClusterJob:
      type: object
      description: A streaming job.
      properties:
        id:
          description: Resource ID of the streaming job.
          type: string
          readOnly: true
        streamingUnits:
          description: The number of streaming units that are used by the streaming job.
          type: integer
          format: int32
          readOnly: true
        jobState:
          $ref: '#/components/schemas/JobState'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code.
            message:
              type: string
              description: Error message.
            target:
              type: string
              description: Error target.
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetails'
              x-ms-identifiers: []
              description: Error details.
          description: Error definition properties.
      description: Common error representation.
    TrackedResource:
      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:
      - $ref: '#/components/schemas/Resource'
  parameters:
    ClusterNameParameter:
      name: clusterName
      in: path
      required: true
      description: The name of the cluster.
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+$
    IfNoneMatchHeader:
      name: If-None-Match
      in: header
      required: false
      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.
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        minLength: 1
    IfMatchHeader:
      name: If-Match
      in: header
      required: false
      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.
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow