{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-azure-kusto","description":"KustoManagementClient","version":"2019-09-07","base_url":"https://management.azure.com","endpoints":34,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api KustoManagementClient\n@base https://management.azure.com\n@version 2019-09-07\n@auth OAuth2\n@common_fields {subscriptionId: any # Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., api-version: any # Client API Version.}\n@endpoints 34\n@hint download_for_search\n@toc subscriptions(33), providers(1)\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}\n@desc Gets a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) The Kusto cluster.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}\n@desc Create or update a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., parameters: any # The Kusto cluster parameters supplied to the CreateOrUpdate operation.}\n@returns(200) Successfully updated the Cluster.\n@returns(201) Successfully created the cluster.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}\n@desc Update a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., parameters: any # The Kusto cluster parameters supplied to the Update operation.}\n@returns(200) Successfully updated the Cluster.\n@returns(201) Successfully updated the cluster.\n@returns(202) Successfully updated the cluster.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}\n@desc Deletes a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) OK -- cluster deleted successfully.\n@returns(202) Accepted the delete cluster request.\n@returns(204) NoContent -- cluster does not exist in the subscription.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop\n@desc Stops a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) OK.\n@returns(202) Accepted\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start\n@desc Starts a Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) OK.\n@returns(202) Accepted.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases\n@desc Returns a list of databases that are owned by this cluster and were followed by another cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) Successfully retrieved the list of followed databases.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases\n@desc Detaches all followers of a database owned by this cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., followerDatabaseToRemove: map # The follower databases properties to remove.}\n@returns(200) OK.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters\n@desc Lists all Kusto clusters within a resource group.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster.}\n@returns(200) OK.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters\n@desc Lists all Kusto clusters within a subscription.\n@returns(200) OK.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus\n@desc Lists eligible SKUs for Kusto resource provider.\n@returns(200) OK.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability\n@desc Checks that the cluster name is valid and is not already in use.\n@required {location: any # Azure location., clusterName: map # The name of the cluster.}\n@returns(200) OK -- Operation to check the kusto resource name availability was successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability\n@desc Checks that the database name is valid and is not already in use.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., resourceName: map # The name of the resource.}\n@returns(200) OK -- Operation to check the kusto resource name availability was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus\n@desc Returns the SKUs available for the provided resource.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) OK.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases\n@desc Returns the list of databases of the given Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) Successfully retrieved the list of databases.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}\n@desc Returns a database.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster.}\n@returns(200) Successfully retrieved the specified database.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}\n@desc Creates or updates a database.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., parameters: any # The database parameters supplied to the CreateOrUpdate operation.}\n@returns(200) Successfully updated the database.\n@returns(201) Successfully created the database.\n@returns(202) Accepted the create database request.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}\n@desc Updates a database.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., parameters: any # The database parameters supplied to the Update operation.}\n@returns(200) Successfully updated the database.\n@returns(201) Successfully updated the database.\n@returns(202) Accepted the update database request.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}\n@desc Deletes the database with the given name.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster.}\n@returns(200) Successfully deleted the database.\n@returns(202) Accepted.\n@returns(204) The specified database does not exist.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals\n@desc Returns a list of database principals of the given Kusto cluster and database.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster.}\n@returns(200) Successfully retrieved the list of database principals.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals\n@desc Add Database principals permissions.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., databasePrincipalsToAdd: any # List of database principals to add.}\n@returns(200) OK -- Successfully added the list of database principals. Returns the updated list of principals.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations\n@desc Returns the list of attached database configurations of the given Kusto cluster.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster.}\n@returns(200) Successfully retrieved the list of attached database configurations.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}\n@desc Returns an attached database configuration.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., attachedDatabaseConfigurationName: any # The name of the attached database configuration.}\n@returns(200) Successfully retrieved the specified attached database configuration.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}\n@desc Creates or updates an attached database configuration.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., attachedDatabaseConfigurationName: any # The name of the attached database configuration., parameters: any # The database parameters supplied to the CreateOrUpdate operation.}\n@returns(200) Successfully updated the database.\n@returns(201) Successfully created the database.\n@returns(202) Accepted the create database request.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}\n@desc Deletes the attached database configuration with the given name.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., attachedDatabaseConfigurationName: any # The name of the attached database configuration.}\n@returns(200) Successfully deleted the database.\n@returns(202) Accepted.\n@returns(204) The specified database does not exist.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals\n@desc Remove Database principals permissions.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., databasePrincipalsToRemove: any # List of database principals to remove.}\n@returns(200) OK -- Successfully removed the list of database principals. Returns the updated list of principals.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections\n@desc Returns the list of data connections of the given Kusto database.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster.}\n@returns(200) Successfully retrieved the list of data connections.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation\n@desc Checks that the data connection parameters are valid.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., parameters: any # The data connection parameters supplied to the CreateOrUpdate operation.}\n@returns(200) OK -- Operation to check the kusto resource name availability was successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkNameAvailability\n@desc Checks that the data connection name is valid and is not already in use.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., dataConnectionName: map # The name of the data connection.}\n@returns(200) OK -- Operation to check the Kusto resource name availability was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}\n@desc Returns a data connection.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., dataConnectionName: any # The name of the data connection.}\n@returns(200) Successfully retrieved the specified data connection.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}\n@desc Creates or updates a data connection.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., dataConnectionName: any # The name of the data connection., parameters: any # The data connection parameters supplied to the CreateOrUpdate operation.}\n@returns(200) Successfully updated the data connection.\n@returns(201) Successfully created the data connection.\n@returns(202) Accepted the create data connection request.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}\n@desc Updates a data connection.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., dataConnectionName: any # The name of the data connection., parameters: any # The data connection parameters supplied to the Update operation.}\n@returns(200) Successfully updated the data connection.\n@returns(201) Successfully updated the data connection.\n@returns(202) Accepted the update data connection request.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}\n@desc Deletes the data connection with the given name.\n@required {resourceGroupName: any # The name of the resource group containing the Kusto cluster., clusterName: any # The name of the Kusto cluster., databaseName: any # The name of the database in the Kusto cluster., dataConnectionName: any # The name of the data connection.}\n@returns(200) Successfully deleted the data connection.\n@returns(202) Accepted.\n@returns(204) The specified data connection does not exist.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.Kusto/operations\n@desc Lists available operations for the Microsoft.Kusto provider.\n@returns(200) The operation was successful. The response contains the list of available operations.\n\n@endgroup\n\n@end\n"}