Microsoft Azure EventHubConnections API

openapi: 3.2.0
info:
  title: Microsoft Azure KustoManagementClient Event Hub Connections…
  version: 2017-09-07-privatepreview
servers:
- url: https://management.azure.com
tags:
- name: EventHubConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections
  : get:
      tags:
      - EventHubConnections
      description: Returns the list of Event Hub connections of the given Kusto database.
      operationId: microsoftAzureEventhubconnectionsListbydatabase
      x-ms-examples:
        KustoDatabasesListByCluster:
          $ref: ./examples/KustoEventHubConnectionsListByDatabase.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of Event Hub connections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnectionListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubConnectionValidation
  : post:
      tags:
      - EventHubConnections
      operationId: microsoftAzureEventhubconnectionsEventhubconnectionvalidation
      x-ms-examples:
        KustoDataConnectionValidation:
          $ref: ./examples/KustoDataConnectionValidation.json
      description: Checks that the Event Hub data connection parameters are valid.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK -- Operation to check the kusto resource name availability was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnectionValidationListResult'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventHubConnectionValidation'
        description: The Event Hub connection parameters supplied to the CreateOrUpdate operation.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}
  : get:
      tags:
      - EventHubConnections
      description: Returns an Event Hub connection.
      operationId: microsoftAzureEventhubconnectionsGet
      x-ms-examples:
        KustoEventHubConnectionsGet:
          $ref: ./examples/KustoEventHubConnectionsGet.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/EventHubConnectionNameParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the specified Event Hub connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - EventHubConnections
      description: Creates or updates a Event Hub connection.
      operationId: microsoftAzureEventhubconnectionsCreateorupdate
      x-ms-examples:
        KustoEventHubConnectionsCreateOrUpdate:
          $ref: ./examples/KustoEventHubConnectionsCreateOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/EventHubConnectionNameParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the Event Hub connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnection'
        '201':
          description: Successfully created the Event Hub connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnection'
        '202':
          description: Accepted the create Event Hub connection request.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventHubConnection'
        description: The Event Hub connection parameters supplied to the CreateOrUpdate operation.
        required: true
    patch:
      tags:
      - EventHubConnections
      description: Updates a Event Hub connection.
      operationId: microsoftAzureEventhubconnectionsUpdate
      x-ms-examples:
        KustoEventHubConnectionsUpdate:
          $ref: ./examples/KustoEventHubConnectionsUpdate.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/EventHubConnectionNameParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the Event Hub connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnection'
        '201':
          description: Successfully updated the Event Hub connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConnection'
        '202':
          description: Accepted the update Event Hub connection request.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventHubConnectionUpdate'
        description: The Event Hub connection parameters supplied to the Update operation.
        required: true
    delete:
      tags:
      - EventHubConnections
      description: Deletes the Event Hub connection with the given name.
      operationId: microsoftAzureEventhubconnectionsDelete
      x-ms-examples:
        KustoEventHubConnectionsDelete:
          $ref: ./examples/KustoEventHubConnectionsDelete.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/EventHubConnectionNameParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the Event Hub connection.
        '202':
          description: Accepted.
        '204':
          description: The specified Event Hub connection does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    ResourceGroupParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group containing the Kusto cluster.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    ClusterNameParameter:
      name: clusterName
      in: path
      description: The name of the Kusto cluster.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API Version.
      schema:
        type: string
    EventHubConnectionNameParameter:
      name: eventHubConnectionName
      in: path
      description: The name of the event hub connection.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
    DatabaseNameParameter:
      name: databaseName
      in: path
      description: The name of the database in the Kusto cluster.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    CloudError:
      x-ms-external: true
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
      description: An error response from Kusto.
    CloudErrorBody:
      x-ms-external: true
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        message:
          type: string
          description: A message describing the error, intended to be suitable for displaying in a user interface.
        target:
          type: string
          description: The target of the particular error. For example, the name of the property in error.
        details:
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
          description: A list of additional details about the error.
      description: An error response from Kusto.
    EventHubConnectionListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/EventHubConnection'
          description: The list of Kusto event hub connections.
      description: The list Kusto event hub connections operation response.
    EventHubConnectionUpdate:
      properties:
        location:
          type: string
          description: Resource location.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/EventHubConnectionProperties'
      allOf:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
      description: Class representing an update to event hub connection.
    EventHubConnectionValidation:
      properties:
        eventhubConnectionName:
          type: string
          description: The name of the event hub connection.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/EventHubConnectionProperties'
      description: Class representing an event hub connection validation.
    EventHubConnectionValidationListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/EventHubConnectionValidationResult'
          description: The list of Kusto event hub connection validation errors.
      description: The list Kusto event hub connection validation result.
    EventHubConnectionValidationResult:
      type: object
      properties:
        errorMessage:
          type: string
          description: A message which indicates a problem in event hub connection validation.
    EventHubConnection:
      properties:
        location:
          type: string
          description: Resource location.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/EventHubConnectionProperties'
      allOf:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
      description: Class representing an event hub connection.
    EventHubConnectionProperties:
      properties:
        eventHubResourceId:
          type: string
          description: The resource ID of the event hub to be used to create a data connection.
        consumerGroup:
          type: string
          description: The event hub consumer group.
        tableName:
          type: string
          description: The table where the data should be ingested. Optionally the table information can be added to each message.
        mappingRuleName:
          type: string
          description: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
        dataFormat:
          description: The data format of the message. Optionally the data format can be added to each message.
          type: string
          enum:
          - MULTIJSON
          - JSON
          - CSV
          x-ms-enum:
            name: dataFormat
            modelAsString: true
      required:
      - eventHubResourceId
      - consumerGroup
      description: Class representing the Kusto event hub connection properties.
  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.