Skip to content

Latest commit

 

History

History

resource-manager

readme.md

Kusto

see https://aka.ms/autorest

This is the AutoRest configuration file for Kusto.

Getting Started

To build the SDK for Kusto, simply Install AutoRest and in this folder, run:

autorest

To see additional help and options, run:

autorest --help

Configuration

Basic Information

These are the global settings for the Kusto API.

title: KustoManagementClient
description: 'The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.'
openapi-type: arm
tag: package-2020-06-14

Tag: package-2020-06-14

These settings apply only when --tag=package-2020-06-14 is specified on the command line.

input-file:
  - Microsoft.Kusto/stable/2020-06-14/kusto.json

Tag: package-2020-02-15

These settings apply only when --tag=package-2020-02-15 is specified on the command line.

input-file:
  - Microsoft.Kusto/stable/2020-02-15/kusto.json

Tag: package-2019-11-09

These settings apply only when --tag=package-2019-11-09 is specified on the command line.

input-file:
  - Microsoft.Kusto/stable/2019-11-09/kusto.json

Tag: package-2019-09-07

These settings apply only when --tag=package-2019-09-07 is specified on the command line.

input-file:
  - Microsoft.Kusto/stable/2019-09-07/kusto.json

Tag: package-2019-05-15

These settings apply only when --tag=package-2019-05-15 is specified on the command line.

input-file:
 - Microsoft.Kusto/stable/2019-05-15/kusto.json

Tag: package-2019-01-21

These settings apply only when --tag=package-2019-01-21 is specified on the command line.

input-file:
 - Microsoft.Kusto/stable/2019-01-21/kusto.json

Tag: package-2018-09-07-preview

These settings apply only when --tag=package-2018-09-07-preview is specified on the command line.

input-file:
 - Microsoft.Kusto/preview/2018-09-07-preview/kusto.json

Tag: package-2017-09-07-privatepreview

These settings apply only when --tag=package-2017-09-07-privatepreview is specified on the command line.

input-file:
 - Microsoft.Kusto/preview/2017-09-07-privatepreview/kusto.json

Tag: schema-2019-09-07

These settings apply only when --tag=schema-2019-09-07 is specified on the command line.

These can be regenerated by running the following PowerShell script from this readme file's folder: dir .\Microsoft.Kusto\stable\2019-09-07\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }

input-file:
 - Microsoft.Kusto/stable/2019-09-07/kusto.json

Tag: schema-2019-05-15

These settings apply only when --tag=schema-2019-05-15 is specified on the command line.

These can be regenerated by running the following PowerShell script from this readme file's folder: dir .\Microsoft.Kusto\preview\2018-09-07-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }

input-file:
 - Microsoft.Kusto/stable/2019-05-15/kusto.json

Tag: schema-2019-01-21

These settings apply only when --tag=schema-2019-01-21 is specified on the command line.

These can be regenerated by running the following PowerShell script from this readme file's folder: dir .\Microsoft.Kusto\preview\2018-09-07-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }

input-file:
 - Microsoft.Kusto/stable/2019-01-21/kusto.json

Tag: schema-2018-09-07-preview

These settings apply only when --tag=schema-2018-09-07-preview is specified on the command line.

These can be regenerated by running the following PowerShell script from this readme file's folder: dir .\Microsoft.Kusto\preview\2018-09-07-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }

input-file:
 - Microsoft.Kusto/preview/2018-09-07-preview/kusto.json

Tag: schema-2017-09-07-privatepreview

These settings apply only when --tag=schema-2017-09-07-privatepreview is specified on the command line.

These can be regenerated by running the following PowerShell script from this readme file's folder: dir .\Microsoft.Kusto\preview\2017-09-07-privatepreview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }

input-file:
 - Microsoft.Kusto/preview/2017-09-07-privatepreview/kusto.json

Code Generation

Swagger to SDK

This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself.

swagger-to-sdk:
  - repo: azure-sdk-for-net
  - repo: azure-sdk-for-python
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-java
  - repo: azure-cli-extensions

C#

These settings apply only when --csharp is specified on the command line. Please also specify --csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>.

csharp:
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.Kusto
  output-folder: $(csharp-sdks-folder)/Kusto/Management.Kusto/Generated
  clear-output-folder: true

Java

See configuration in readme.java.md

Multi-API/Profile support for AutoRest v3 generators

AutoRest V3 generators require the use of --tag=all-api-versions to select api files.

This block is updated by an automatic script. Edits may be lost!

# include the azure profile definitions from the standard location
require: $(this-folder)/../../../profiles/readme.md

# all the input files across all versions
input-file:
  - $(this-folder)/Microsoft.Kusto/stable/2020-06-14/kusto.json
  - $(this-folder)/Microsoft.Kusto/stable/2020-02-15/kusto.json
  - $(this-folder)/Microsoft.Kusto/stable/2019-11-09/kusto.json
  - $(this-folder)/Microsoft.Kusto/stable/2019-09-07/kusto.json
  - $(this-folder)/Microsoft.Kusto/stable/2019-05-15/kusto.json
  - $(this-folder)/Microsoft.Kusto/stable/2019-01-21/kusto.json
  - $(this-folder)/Microsoft.Kusto/preview/2018-09-07-preview/kusto.json
  - $(this-folder)/Microsoft.Kusto/preview/2017-09-07-privatepreview/kusto.json

If there are files that should not be in the all-api-versions set, uncomment the exclude-file section below and add the file paths.

#exclude-file: 
#  - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json

Suppression

directive:
  - suppress: R2016
    from: kusto.json
    where: $.definitions.DataConnection.required
    reason: Discriminator kind is required also in patch
  - suppress: R2016
    from: kusto.json
    where: $.definitions.Database.required
    reason: Discriminator kind is required also in patch
  - suppress: ListInOperationName
    from: kusto.json
    where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals"].post.operationId'
    reason: 'Already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.'
  - suppress: ListInOperationName
    from: kusto.json
    where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals"].post.operationId'
    reason: 'Already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.'
  - suppress: OBJECT_ADDITIONAL_PROPERTIES
    from: kusto.json
    where: $.definitions.Database
    reason: 'Action is expected to receive a subclass of Database'
  - suppress: OBJECT_ADDITIONAL_PROPERTIES
    from: kusto.json
    where: $.definitions.EventHubDataConnection
    reason: |-
      Action is expected to receive a subclass of DataConnection.
      This API was already released in previous versions, and should not be changed.