Microsoft Azure Kusto Management Client is a powerful tool that allows users to easily interact with Azure Data Explorer clusters, databases, data sources, and queries through a user-friendly interface. This client provides seamless integration with Azure services, enabling users to efficiently manage and monitor their data assets.
swagger: '2.0'
info:
title: Microsoft Azure KustoManagementClient
version: 2017-09-07-privatepreview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}:
get:
tags:
- Clusters
operationId: microsoftAzureClustersGet
x-ms-examples:
KustoClustersGet:
$ref: ./examples/KustoClustersGet.json
description: Gets a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: The Kusto cluster.
schema:
$ref: '#/definitions/Cluster'
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
put:
tags:
- Clusters
operationId: microsoftAzureClustersCreateorupdate
x-ms-examples:
KustoClustersCreateOrUpdate:
$ref: ./examples/KustoClustersCreateOrUpdate.json
x-ms-long-running-operation: true
description: Create or update a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/Cluster'
description: >-
The Kusto cluster parameters supplied to the CreateOrUpdate
operation.
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated the Cluster.
schema:
$ref: '#/definitions/Cluster'
'201':
description: Successfully created the cluster.
schema:
$ref: '#/definitions/Cluster'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername
patch:
tags:
- Clusters
operationId: microsoftAzureClustersUpdate
x-ms-examples:
KustoClustersUpdate:
$ref: ./examples/KustoClustersUpdate.json
x-ms-long-running-operation: true
description: Update a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ClusterUpdate'
description: The Kusto cluster parameters supplied to the Update operation.
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated the Cluster.
schema:
$ref: '#/definitions/Cluster'
'201':
description: Successfully updated the cluster.
schema:
$ref: '#/definitions/Cluster'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername
delete:
tags:
- Clusters
operationId: microsoftAzureClustersDelete
x-ms-examples:
KustoClustersDelete:
$ref: ./examples/KustoClustersDelete.json
x-ms-long-running-operation: true
description: Deletes a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK -- cluster deleted successfully.
'202':
description: Accepted the delete cluster request.
'204':
description: NoContent -- cluster does not exist in the subscription.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop:
post:
tags:
- Clusters
operationId: microsoftAzureClustersStop
x-ms-examples:
KustoClustersStop:
$ref: ./examples/KustoClustersStop.json
x-ms-long-running-operation: true
description: Stops a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK.
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Stop
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start:
post:
tags:
- Clusters
operationId: microsoftAzureClustersStart
x-ms-examples:
KustoClustersStart:
$ref: ./examples/KustoClustersStart.json
x-ms-long-running-operation: true
description: Starts a Kusto cluster.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK.
'202':
description: Accepted.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Start
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters:
get:
tags:
- Clusters
operationId: microsoftAzureClustersListbyresourcegroup
x-ms-examples:
KustoClustersListByResourceGroup:
$ref: ./examples/KustoClustersListByResourceGroup.json
description: Lists all Kusto clusters within a resource group.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/ClusterListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters
/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters:
get:
tags:
- Clusters
operationId: microsoftAzureClustersList
x-ms-examples:
KustoClustersList:
$ref: ./examples/KustoClustersList.json
description: Lists all Kusto clusters within a subscription.
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/ClusterListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kusto Clusters
/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus:
get:
description: Lists eligible SKUs for Kusto resource provider.
x-ms-examples:
KustoClustersListSkus:
$ref: ./examples/KustoClustersListSkus.json
operationId: microsoftAzureClustersListskus
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/ListSkusResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kusto Skus
tags:
- Subscriptions
/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability:
post:
tags:
- Clusters
operationId: microsoftAzureClustersChecknameavailability
x-ms-examples:
KustoClustersCheckNameAvailability:
$ref: ./examples/KustoClustersCheckNameAvailability.json
description: Checks that the cluster name is valid and is not already in use.
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- name: location
in: path
description: Azure location.
required: true
type: string
- name: clusterName
in: body
required: true
schema:
$ref: '#/definitions/ClusterCheckNameRequest'
description: The name of the cluster.
responses:
'200':
description: >-
OK -- Operation to check the kusto resource name availability was
successful.
schema:
$ref: '#/definitions/CheckNameResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Kusto Locations Location Checknameavailability
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability
: post:
tags:
- Databases
operationId: microsoftAzureDatabasesChecknameavailability
x-ms-examples:
KustoDatabaseCheckNameAvailability:
$ref: ./examples/KustoDatabasesCheckNameAvailability.json
description: Checks that the database name is valid and is not already in use.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- name: databaseName
in: body
required: true
schema:
$ref: '#/definitions/DatabaseCheckNameRequest'
description: The name of the database.
responses:
'200':
description: >-
OK -- Operation to check the kusto resource name availability was
successful.
schema:
$ref: '#/definitions/CheckNameResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Checknameavailability
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus:
get:
tags:
- Clusters
operationId: microsoftAzureClustersListskusbyresource
x-ms-examples:
KustoClustersListResourceSkus:
$ref: ./examples/KustoClustersListResourceSkus.json
description: Returns the SKUs available for the provided resource.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/ListResourceSkusResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Skus
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases
: get:
tags:
- Databases
description: Returns the list of databases of the given Kusto cluster.
operationId: microsoftAzureDatabasesListbycluster
x-ms-examples:
KustoDatabasesListByCluster:
$ref: ./examples/KustoDatabasesListByCluster.json
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved the list of databases.
schema:
$ref: '#/definitions/DatabaseListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
: get:
tags:
- Databases
description: Returns a database.
operationId: microsoftAzureDatabasesGet
x-ms-examples:
KustoDatabasesGet:
$ref: ./examples/KustoDatabasesGet.json
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved the specified database.
schema:
$ref: '#/definitions/Database'
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
put:
tags:
- Databases
description: Creates or updates a database.
operationId: microsoftAzureDatabasesCreateorupdate
x-ms-examples:
KustoDatabasesCreateOrUpdate:
$ref: ./examples/KustoDatabasesCreateOrUpdate.json
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/Database'
description: The database parameters supplied to the CreateOrUpdate operation.
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated the database.
schema:
$ref: '#/definitions/Database'
'201':
description: Successfully created the database.
schema:
$ref: '#/definitions/Database'
'202':
description: Accepted the create database 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
patch:
tags:
- Databases
description: Updates a database.
operationId: microsoftAzureDatabasesUpdate
x-ms-examples:
KustoDatabasesUpdate:
$ref: ./examples/KustoDatabasesUpdate.json
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/DatabaseUpdate'
description: The database parameters supplied to the Update operation.
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated the database.
schema:
$ref: '#/definitions/Database'
'201':
description: Successfully updated the database.
schema:
$ref: '#/definitions/Database'
'202':
description: Accepted the update database 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
delete:
tags:
- Databases
description: Deletes the database with the given name.
operationId: microsoftAzureDatabasesDelete
x-ms-examples:
KustoDatabasesDelete:
$ref: ./examples/KustoDatabasesDelete.json
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully deleted the database.
'202':
description: Accepted.
'204':
description: The specified database 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
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals
: post:
tags:
- Databases
description: >-
Returns a list of database principals of the given Kusto cluster and
database.
operationId: microsoftAzureDatabasesListprincipals
x-ms-examples:
KustoDatabaseListPrincipals:
$ref: ./examples/KustoDatabaseListPrincipals.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 database principals.
schema:
$ref: '#/definitions/DatabasePrincipalListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Listprincipals
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals
: post:
tags:
- Databases
operationId: microsoftAzureDatabasesAddprincipals
x-ms-examples:
KustoDatabaseAddPrincipals:
$ref: ./examples/KustoDatabaseAddPrincipals.json
description: Add Database principals permissions.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
- name: databasePrincipalsToAdd
in: body
required: true
schema:
$ref: '#/definitions/DatabasePrincipalListRequest'
description: List of database principals to add.
responses:
'200':
description: >-
OK -- Successfully added the list of database principals. Returns
the updated list of principals.
schema:
$ref: '#/definitions/DatabasePrincipalListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Addprincipals
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals
: post:
tags:
- Databases
operationId: microsoftAzureDatabasesRemoveprincipals
x-ms-examples:
KustoDatabaseRemovePrincipals:
$ref: ./examples/KustoDatabaseRemovePrincipals.json
description: Remove Database principals permissions.
parameters:
- $ref: '#/parameters/ResourceGroupParameter'
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
- name: databasePrincipalsToRemove
in: body
required: true
schema:
$ref: '#/definitions/DatabasePrincipalListRequest'
description: List of database principals to remove.
responses:
'200':
description: >-
OK -- Successfully removed the list of database principals. Returns
the updated list of principals.
schema:
$ref: '#/definitions/DatabasePrincipalListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Removeprincipals
? /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:
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: micros
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/kustomanagementclient-openapi-original.yml