Skip to content

Latest commit

 

History

History
240 lines (158 loc) · 5.49 KB

readme.md

File metadata and controls

240 lines (158 loc) · 5.49 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-2024-03-preview

Tag: package-2024-03-preview

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

input-file:
- Microsoft.DataBox/preview/2024-03-01-preview/databox.json

Tag: package-2024-02-preview

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

input-file:
- Microsoft.DataBox/preview/2024-02-01-preview/databox.json

Tag: package-2023-12

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

input-file:
- Microsoft.DataBox/stable/2023-12-01/databox.json

Tag: package-2023-03

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

input-file:
- Microsoft.DataBox/stable/2023-03-01/databox.json

Tag: package-2022-12

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

input-file:
- Microsoft.DataBox/stable/2022-12-01/databox.json

Tag: package-2022-10

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

input-file:
- Microsoft.DataBox/stable/2022-10-01/databox.json

Tag: package-2022-09

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

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

Tag: package-2022-02

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

input-file:
- Microsoft.DataBox/stable/2022-02-01/databox.json

Tag: package-2021-12

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

input-file:
- Microsoft.DataBox/stable/2021-12-01/databox.json

Tag: package-2021-08-preview

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

input-file:
- Microsoft.DataBox/preview/2021-08-01-preview/databox.json

Tag: package-2021-05

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

input-file:
- Microsoft.DataBox/stable/2021-05-01/databox.json

Tag: package-2021-03

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

input-file:
- Microsoft.DataBox/stable/2021-03-01/databox.json

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-track2
  - repo: azure-sdk-for-python
  - 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
  - repo: azure-powershell

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

See configuration in readme.java.md