Skip to content

Latest commit

 

History

History
220 lines (157 loc) · 6.18 KB

readme.md

File metadata and controls

220 lines (157 loc) · 6.18 KB
Raw

Device Provisioning Services

see https://aka.ms/autorest

This is the AutoRest configuration file for Device Provisioning Services.

Getting Started

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

openapi-type: arm
tag: package-preview-2020-09

Tag: package-preview-2020-09

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

input-file:
  - Microsoft.Devices/preview/2020-09-01-preview/iotdps.json

Tag: package-2020-03

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

input-file:
  - Microsoft.Devices/stable/2020-03-01/iotdps.json

Tag: package-2017-08

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

input-file:
- Microsoft.Devices/preview/2017-08-21-preview/iotdps.json

Tag: package-2017-11

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

input-file:
- Microsoft.Devices/stable/2017-11-15/iotdps.json

Tag: package-2018-01

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

input-file:
- Microsoft.Devices/stable/2018-01-22/iotdps.json

Tag: package-2020-01

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

input-file:
- Microsoft.Devices/stable/2020-01-01/iotdps.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
  - repo: azure-resource-manager-schemas
    after_scripts:
      - node sdkauto_afterscript.js deviceprovisioningservices/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.DeviceProvisioningServices
  output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/Microsoft.Azure.Management.DeviceProvisioningServices/src/Generated
  clear-output-folder: true

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.iothubprovisioningservices
  package-name: azure-mgmt-iothubprovisioningservices
  clear-output-folder: true
python:
  no-namespace-folders: true
  output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices
python:
  basic-setup-py: true
  output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices

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>.

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

Java multi-api

batch:
  - tag: package-2017-08
  - tag: package-2017-11
  - tag: package-2018-01

Tag: package-2017-08 and java

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

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

Tag: package-2017-11 and java

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

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

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=<path to the root directory of your azure-sdk-for-java clone>.

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

AzureResourceSchema

See configuration in readme.azureresourceschema.md