Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 3.13 KB

readme.md

File metadata and controls

121 lines (80 loc) · 3.13 KB
Raw

DeviceUpdate

see https://aka.ms/autorest

This is the AutoRest configuration file for Device Update for IoT Hub.

Getting Started

To build the SDKs for My API, simply install AutoRest via npm (npm install -g autorest) and then run:

autorest readme.md

To see additional help and options, run:

autorest --help

For other options on installation see Installing AutoRest on the AutoRest github page.

Configuration

Basic Information

These are the global settings for the deviceupdate.

openapi-type: data-plane
tag: package-2022-07-01-preview

Tag: package-2020-09-01

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

input-file:
  - Microsoft.DeviceUpdate/preview/2020-09-01/deviceupdate.json

Tag: package-2021-06-01-preview

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

input-file:
  - Microsoft.DeviceUpdate/preview/2021-06-01-preview/deviceupdate.json

Tag: package-2022-07-01-preview

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

input-file:
  - Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json

Suppressions

directive:
  - suppress: LongRunningResponseStatusCode
    reason: The validation tools do not properly recognize 202 as a supported response code.
  - supress: R2010
    reason: Approved by SDK team.
    from: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json
  - supress: R2010
    reason: Approved by SDK team.
    from: Microsoft.DeviceUpdate/preview/2021-06-01-preview/deviceupdate.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-python-track2
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-js
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['deviceupdate']

Python

See configuration in readme.python.md

TypeScript

See configuration in readme.typescript.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.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.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