Skip to content

Latest commit

 

History

History
209 lines (149 loc) · 5.61 KB

readme.md

File metadata and controls

209 lines (149 loc) · 5.61 KB
Raw

DataBox

see https://aka.ms/autorest

This is the AutoRest configuration file for DataBox.

Getting Started

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

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

Tag: package-2020-11

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

input-file:
- Microsoft.DataBox/stable/2020-11-01/databox.json

Tag: package-2020-04

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

input-file:
- Microsoft.DataBox/stable/2020-04-01/databox.json

Tag: package-2019-09

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

input-file:
- Microsoft.DataBox/stable/2019-09-01/databox.json

Tag: package-2018-01

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

input-file:
- Microsoft.DataBox/stable/2018-01-01/databox.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
    after_scripts:
      - python ./scripts/multiapi_init_gen.py azure-mgmt-databox
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-ruby
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_databox']
  - repo: azure-cli-extensions
  - repo: azure-resource-manager-schemas
    after_scripts:
      - node sdkauto_afterscript.js databox/resource-manager

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.DataBox
  payload-flattening-threshold: 2
  output-folder: $(csharp-sdks-folder)/databox/Microsoft.Azure.Management.DataBox/src/Generated
  clear-output-folder: true
  
directive:
- from: swagger-document
  where: $.definitions.ShippingAddress
  transform: >
    $.required = [ "streetAddress1", "country", "postalCode" ];

Python

See configuration in readme.python.md

Ruby

See configuration in readme.ruby.md

Go

See configuration in readme.go.md

Java

These settings apply only when --java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>.

java:
  azure-arm: true
  fluent: true
  namespace: com.microsoft.azure.management.databox
  license-header: MICROSOFT_MIT_NO_CODEGEN
  payload-flattening-threshold: 1
  output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-databox

Java multi-api

batch:
  - tag: package-2018-01
  - tag: package-2019-09
  - tag: package-2020-04
  - tag: package-2020-11

Tag: package-2018-01 and java

These settings apply only when --tag=package-2018-01 --java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.databox.v2018_01_01
  output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2018_01_01
regenerate-manager: true
generate-interface: true

Tag: package-2019-09 and java

These settings apply only when --tag=package-2019-09-java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.databox.v2019_09-01
  output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2019_09_01
regenerate-manager: true
generate-interface: true

Tag: package-2020-04 and java

These settings apply only when --tag=package-2020-04-java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.databox.v2020_04-01
  output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2020_04_01
regenerate-manager: true
generate-interface: true

Tag: package-2020-11 and java

These settings apply only when --tag=package-2020-11-java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.databox.v2020_11-01
  output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2020_11_01
regenerate-manager: true
generate-interface: true

AzureResourceSchema

See configuration in readme.azureresourceschema.md