swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector EventHubConnections API
schemes:
- https
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: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of Event Hub connections.
          schema:
            $ref: '#/definitions/EventHubConnectionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnections
  ? /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: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/EventHubConnectionValidation'
        description: The Event Hub connection parameters supplied to the CreateOrUpdate operation.
      responses:
        '200':
          description: OK -- Operation to check the kusto resource name availability was successful.
          schema:
            $ref: '#/definitions/EventHubConnectionValidationListResult'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnectionvalidation
  ? /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: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/EventHubConnectionNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the specified Event Hub connection.
          schema:
            $ref: '#/definitions/EventHubConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnections Eventhubconnectionname
    put:
      tags:
      - EventHubConnections
      description: Creates or updates a Event Hub connection.
      operationId: microsoftAzureEventhubconnectionsCreateorupdate
      x-ms-examples:
        KustoEventHubConnectionsCreateOrUpdate:
          $ref: ./examples/KustoEventHubConnectionsCreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/EventHubConnectionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/EventHubConnection'
        description: The Event Hub connection parameters supplied to the CreateOrUpdate operation.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the Event Hub connection.
          schema:
            $ref: '#/definitions/EventHubConnection'
        '201':
          description: Successfully created the Event Hub connection.
          schema:
            $ref: '#/definitions/EventHubConnection'
        '202':
          description: Accepted the create Event Hub connection request.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnections Eventhubconnectionname
    patch:
      tags:
      - EventHubConnections
      description: Updates a Event Hub connection.
      operationId: microsoftAzureEventhubconnectionsUpdate
      x-ms-examples:
        KustoEventHubConnectionsUpdate:
          $ref: ./examples/KustoEventHubConnectionsUpdate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/EventHubConnectionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/EventHubConnectionUpdate'
        description: The Event Hub connection parameters supplied to the Update operation.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the Event Hub connection.
          schema:
            $ref: '#/definitions/EventHubConnection'
        '201':
          description: Successfully updated the Event Hub connection.
          schema:
            $ref: '#/definitions/EventHubConnection'
        '202':
          description: Accepted the update Event Hub connection request.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnections Eventhubconnectionname
    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: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/EventHubConnectionNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Eventhubconnections Eventhubconnectionname
definitions:
  EventHubConnectionValidationListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/EventHubConnectionValidationResult'
        description: The list of Kusto event hub connection validation errors.
    description: The list Kusto event hub connection validation result.
  EventHubConnectionUpdate:
    properties:
      location:
        type: string
        description: Resource location.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/EventHubConnectionProperties'
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
    description: Class representing an update to event hub connection.
  EventHubConnection:
    properties:
      location:
        type: string
        description: Resource location.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/EventHubConnectionProperties'
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
    description: Class representing an event hub connection.
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
    description: An error response from Kusto.
  EventHubConnectionValidation:
    properties:
      eventhubConnectionName:
        type: string
        description: The name of the event hub connection.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/EventHubConnectionProperties'
    description: Class representing an event hub connection validation.
  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: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from Kusto.
  EventHubConnectionValidationResult:
    type: object
    properties:
      errorMessage:
        type: string
        description: A message which indicates a problem in event hub connection validation.
  EventHubConnectionListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/EventHubConnection'
        description: The list of Kusto event hub connections.
    description: The list Kusto event hub connections operation response.
  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.
parameters:
  EventHubConnectionNameParameter:
    name: eventHubConnectionName
    in: path
    description: The name of the event hub connection.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client API Version.
  DatabaseNameParameter:
    name: databaseName
    in: path
    description: The name of the database in the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    description: The name of the resource group containing the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  ClusterNameParameter:
    name: clusterName
    in: path
    description: The name of the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'