Azure Stream Analytics Outputs API

openapi: 3.2.0
info:
  title: Microsoft Azure Stream Analytics Outputs API
  version: '2020-03-01'
  x-refined-note:
  - x-generated-by differs across the merged source definitions and was not carried
  - x-generated-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Outputs across 2 of this provider''s published API definitions: outputs.json, microsoft-azure-stream-analytics-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
tags:
- name: Outputs
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}
  : put:
      tags:
      - Outputs
      operationId: Outputs_CreateOrReplace
      description: Creates an output or replaces an already existing output under an existing streaming job.
      x-ms-examples:
        Create an Azure SQL database output:
          $ref: ./examples/Output_Create_AzureSQL.json
        Create an Azure Table output:
          $ref: ./examples/Output_Create_AzureTable.json
        Create a blob output with CSV serialization:
          $ref: ./examples/Output_Create_Blob_CSV.json
        Create a DocumentDB output:
          $ref: ./examples/Output_Create_DocumentDB.json
        Create an Azure Data Warehouse output:
          $ref: ./examples/Output_Create_DataWarehouse.json
        Create an Azure Function output:
          $ref: ./examples/Output_Create_AzureFunction.json
        Create an Event Hub output with JSON serialization:
          $ref: ./examples/Output_Create_EventHub_JSON.json
        Create a Service Bus Queue output with Avro serialization:
          $ref: ./examples/Output_Create_ServiceBusQueue_Avro.json
        Create a Service Bus Topic output with CSV serialization:
          $ref: ./examples/Output_Create_ServiceBusTopic_CSV.json
        Create a Power BI output:
          $ref: ./examples/Output_Create_PowerBI.json
        Create an Azure Data Lake Store output with JSON serialization:
          $ref: ./examples/Output_Create_AzureDataLakeStore_JSON.json
        Create a Gateway Message Bus output:
          $ref: ./examples/Output_Create_GatewayMessageBus.json
      parameters:
      - name: If-Match
        in: header
        required: false
        x-ms-client-name: IfMatch
        description: The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        schema:
          type: string
      - name: If-None-Match
        in: header
        required: false
        x-ms-client-name: IfNoneMatch
        description: Set to '*' to allow a new output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response.
        schema:
          type: string
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      - $ref: '#/components/parameters/OutputNameParameter'
      responses:
        '200':
          description: The output was successfully created or replaced.
          headers:
            ETag:
              description: The current entity tag for the output. 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.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output'
        '201':
          description: The output was successfully created or replaced.
          headers:
            ETag:
              description: The current entity tag for the output. 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.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Output'
        description: The definition of the output that will be used to create a new output or replace the existing one under the streaming job.
        required: true
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs create or replace
      x-summary-source: derived
    patch:
      tags:
      - Outputs
      operationId: Outputs_Update
      description: Updates an existing output under an existing streaming job. This can be used to partially update (ie. update one or two properties) an output without affecting the rest the job or output definition.
      x-ms-examples:
        Update an Azure SQL database output:
          $ref: ./examples/Output_Update_AzureSQL.json
        Update an Azure Table output:
          $ref: ./examples/Output_Update_AzureTable.json
        Update a blob output with CSV serialization:
          $ref: ./examples/Output_Update_Blob.json
        Update a DocumentDB output:
          $ref: ./examples/Output_Update_DocumentDB.json
        Update an Azure Data Warehouse output:
          $ref: ./examples/Output_Update_DataWarehouse.json
        Update an Azure Function output:
          $ref: ./examples/Output_Update_AzureFunction.json
        Update an Event Hub output with JSON serialization:
          $ref: ./examples/Output_Update_EventHub.json
        Update a Service Bus Queue output with Avro serialization:
          $ref: ./examples/Output_Update_ServiceBusQueue.json
        Update a Service Bus Topic output with CSV serialization:
          $ref: ./examples/Output_Update_ServiceBusTopic.json
        Update a Power BI output:
          $ref: ./examples/Output_Update_PowerBI.json
        Update an Azure Data Lake Store output with JSON serialization:
          $ref: ./examples/Output_Update_AzureDataLakeStore.json
      parameters:
      - name: If-Match
        in: header
        required: false
        x-ms-client-name: IfMatch
        description: The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        schema:
          type: string
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      - $ref: '#/components/parameters/OutputNameParameter'
      responses:
        '200':
          description: The output was successfully updated.
          headers:
            ETag:
              description: The current entity tag for the output. 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.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Output'
        description: An Output object. The properties specified here will overwrite the corresponding properties in the existing output (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing output will remain the same and not change as a result of this PATCH operation.
        required: true
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs update
      x-summary-source: derived
    delete:
      tags:
      - Outputs
      operationId: Outputs_Delete
      description: Deletes an output from the streaming job.
      x-ms-examples:
        Delete an output:
          $ref: ./examples/Output_Delete.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      - $ref: '#/components/parameters/OutputNameParameter'
      responses:
        '200':
          description: The output was successfully deleted.
        '204':
          description: The output does not exist.
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs delete
      x-summary-source: derived
    get:
      tags:
      - Outputs
      operationId: Outputs_Get
      description: Gets details about the specified output.
      x-ms-examples:
        Get an Azure SQL database output:
          $ref: ./examples/Output_Get_AzureSQL.json
        Get an Azure Table output:
          $ref: ./examples/Output_Get_AzureTable.json
        Get a blob output with CSV serialization:
          $ref: ./examples/Output_Get_Blob_CSV.json
        Get a DocumentDB output:
          $ref: ./examples/Output_Get_DocumentDB.json
        Get an Azure Data Warehouse output:
          $ref: ./examples/Output_Get_DataWarehouse.json
        Get an Azure Function output:
          $ref: ./examples/Output_Get_AzureFunction.json
        Get an Event Hub output with JSON serialization:
          $ref: ./examples/Output_Get_EventHub_JSON.json
        Get a Service Bus Queue output with Avro serialization:
          $ref: ./examples/Output_Get_ServiceBusQueue_Avro.json
        Get a Service Bus Topic output with CSV serialization:
          $ref: ./examples/Output_Get_ServiceBusTopic_CSV.json
        Get a Power BI output:
          $ref: ./examples/Output_Get_PowerBI.json
        Get an Azure Data Lake Store output with JSON serialization:
          $ref: ./examples/Output_Get_AzureDataLakeStore_JSON.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      - $ref: '#/components/parameters/OutputNameParameter'
      responses:
        '200':
          description: Successfully retrieved the specified output.
          headers:
            ETag:
              description: The current entity tag for the output. 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.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs
  : get:
      tags:
      - Outputs
      operationId: Outputs_ListByStreamingJob
      description: Lists all of the outputs under the specified streaming job.
      x-ms-examples:
        List all outputs in a streaming job:
          $ref: ./examples/Output_ListByStreamingJob.json
      parameters:
      - name: $select
        in: query
        required: false
        description: The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or "*" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value.
        schema:
          type: string
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      responses:
        '200':
          description: Successfully listed the outputs under the specified streaming job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutputListResult'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      x-ms-pageable:
        nextLinkName: nextLink
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs list by streaming job
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}/test
  : post:
      tags:
      - Outputs
      operationId: Outputs_Test
      description: Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
      x-ms-examples:
        Test the connection for an output:
          $ref: ./examples/Output_Test.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/StreamingJobNameParameter
      - $ref: '#/components/parameters/OutputNameParameter'
      responses:
        '200':
          description: The test operation completed successfully.
          content:
            application/json:
              schema:
                $ref: ./inputs.json#/definitions/ResourceTestStatus
        '202':
          description: The test request was successfully initiated.
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Output'
        description: If the output specified does not already exist, this parameter must contain the full output definition intended to be tested. If the output specified already exists, this parameter can be left null to test the existing output as is or if specified, the properties specified will overwrite the corresponding properties in the existing output (exactly like a PATCH operation) and the resulting output will be tested.
      security:
      - azure_auth:
        - user_impersonation
      summary: Outputs test
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs
  : parameters:
    - $ref: '#/components/parameters/SubscriptionId'
    - $ref: '#/components/parameters/ResourceGroupName'
    - $ref: '#/components/parameters/JobName'
    - $ref: '#/components/parameters/ApiVersion'
    get:
      tags:
      - Outputs
      summary: List outputs by streaming job
      operationId: listOutputsByStreamingJob
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericList'
      security:
      - bearerAuth: []
    servers:
    - url: https://management.azure.com
      description: Azure Resource Manager
components:
  schemas:
    Output:
      type: object
      description: An output object, containing all information associated with the named output. All outputs are contained under a streaming job.
      allOf:
      - $ref: '#/components/schemas/SubResource'
      properties:
        properties:
          $ref: '#/components/schemas/OutputProperties'
          description: The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.
          x-ms-client-flatten: true
    OutputProperties:
      type: object
      description: The properties that are associated with an output.
      properties:
        datasource:
          $ref: '#/components/schemas/OutputDataSource'
          description: Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests.
        timeWindow:
          type: string
          description: The time frame for filtering Stream Analytics job outputs.
        sizeWindow:
          type: integer
          format: int32
          description: The size window to constrain a Stream Analytics output to.
        serialization:
          $ref: ./inputs.json#/definitions/Serialization
          description: Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
        diagnostics:
          readOnly: true
          $ref: ./inputs.json#/definitions/Diagnostics
          description: Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
        etag:
          readOnly: true
          type: string
          description: The current entity tag for the output. 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.
    OutputDataSource:
      type: object
      description: Describes the data source that output will be written to.
      discriminator:
        propertyName: type
      properties:
        type:
          type: string
          description: Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.
      required:
      - type
    OutputListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Output'
          readOnly: true
          description: A list of outputs under a streaming job. Populated by a 'List' operation.
        nextLink:
          type: string
          readOnly: true
          description: The link (url) to the next page of results.
      description: Object containing a list of outputs under a streaming job.
    SubResource:
      type: object
      description: The base sub-resource model definition.
      properties:
        id:
          readOnly: true
          type: string
          description: Resource Id
        name:
          type: string
          description: Resource name
        type:
          readOnly: true
          type: string
          description: Resource type
      x-ms-azure-resource: true
    GenericObject:
      type: object
      additionalProperties: true
    GenericList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GenericObject'
      additionalProperties: true
  parameters:
    OutputNameParameter:
      name: outputName
      in: path
      required: true
      description: The name of the output.
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupName:
      in: path
      name: resourceGroupName
      required: true
      schema:
        type: string
    ApiVersion:
      in: query
      name: api-version
      required: true
      schema:
        type: string
        default: '2020-03-01'
    SubscriptionId:
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
    JobName:
      in: path
      name: jobName
      required: true
      schema:
        type: string
  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
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- outputs.json
- microsoft-azure-stream-analytics-openapi.yml