From 58db2cd8519af2e0e6f428c7ab82da2891b440f5 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Thu, 28 Jun 2018 09:43:42 -0700 Subject: [PATCH] add README file for cost management --- .../resource-manager/readme.md | 155 ++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 specification/cost-management/resource-manager/readme.md diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md new file mode 100644 index 000000000000..8ffdd887eb7f --- /dev/null +++ b/specification/cost-management/resource-manager/readme.md @@ -0,0 +1,155 @@ +# CostManagement + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Cost Management. + +--- +## Getting Started +To build the SDK for Cost Management, simply [Install AutoRest](https://aka.ms/autorest/install) 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 Cost Management API. + +``` yaml +openapi-type: arm +tag: package-2018-05 +``` + +--- +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05' +input-file: +- Microsoft.CostManagement/stable/2018-05-31/costmanagement.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. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_costmanagement'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.CostManagement + output-folder: $(csharp-sdks-folder)/CostManagement/Management.CostManagement/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.costmanagement + package-name: azure-mgmt-costmanagement + package-version: 1.2.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-costmanagement/azure/mgmt/costmanagement +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-costmanagement +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: costmanagement + clear-output-folder: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-05 +``` + +### Tag: package-2018-05 and go +These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-05-31/$(namespace) +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.costmanagement +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-costmanagement +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-05 +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.costmanagement.v2018_05_31 + output-folder: $(azure-libraries-for-java-folder)/costmanagement/resource-manager/v2018_05_31 +regenerate-manager: true +generate-interface: true +```