Skip to content

Latest commit

 

History

History
174 lines (122 loc) · 4.48 KB

readme.md

File metadata and controls

174 lines (122 loc) · 4.48 KB

Advisor

see https://aka.ms/autorest

This is the AutoRest configuration file for Advisor.

Getting Started

To build the SDK for Advisor, 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 Advisor API.

openapi-type: arm
tag: package-2020-01

Tag: package-2020-07-preview

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

input-file:
  - Microsoft.Advisor/preview/2020-07-01-preview/advisor.json

Tag: package-2020-01

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

input-file:
  - Microsoft.Advisor/stable/2020-01-01/advisor.json

Tag: package-2017-04

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

input-file:
- Microsoft.Advisor/stable/2017-04-19/advisor.json

Tag: package-2017-03

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

input-file:
- Microsoft.Advisor/stable/2017-03-31/advisor.json

Tag: package-2016-07-preview

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

input-file:
- Microsoft.Advisor/preview/2016-07-12-preview/advisor.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-java
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node

Python

These settings apply only when --python is specified on the command line. Please also specify --python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>. Use --python-mode=update if you already have a setup.py and just want to update the code itself.

python-mode: create
python:
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  payload-flattening-threshold: 2
  namespace: azure.mgmt.advisor
  package-name: azure-mgmt-advisor
  package-version: 1.0.1
  clear-output-folder: true
python:
  no-namespace-folders: true
  output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor/azure/mgmt/advisor
python:
  basic-setup-py: true
  output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor

Go

See configuration in readme.go.md

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
  payload-flattening-threshold: 1
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.Advisor
  output-folder: $(csharp-sdks-folder)/advisor/Microsoft.Azure.Management.Advisor/src/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.Advisor/preview/2020-07-01-preview/advisor.json
  - $(this-folder)/Microsoft.Advisor/stable/2020-01-01/advisor.json
  - $(this-folder)/Microsoft.Advisor/stable/2017-04-19/advisor.json
  - $(this-folder)/Microsoft.Advisor/stable/2017-03-31/advisor.json
  - $(this-folder)/Microsoft.Advisor/preview/2016-07-12-preview/advisor.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