Skip to content

Latest commit

 

History

History
756 lines (541 loc) · 24 KB

readme.md

File metadata and controls

756 lines (541 loc) · 24 KB
Raw

ContainerServices

see https://aka.ms/autorest

This is the AutoRest configuration file for ContainerServices (ACS/AKS/OpenShift).

The ContainerServices RPv2 consists of two similar services: ContainerServices and ManagedClusters. Each service has its own swagger spec.

The two specs are united by running autorest in this directory, which will use this readme.md file for configuration options. It will generate a single azure-mgmt-containerservice client library.

Getting Started

To build the SDK for ContainerServices, install Autorest. Then in this folder, run this command:

autorest

To see additional help and options, run:

autorest --help

Configuration

Basic Information

These are the global settings for the ContainerServices API.

openapi-type: arm
tag: package-2021-08

Tag: package-2021-08

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

input-file:
  - Microsoft.ContainerService/stable/2021-08-01/managedClusters.json

Tag: package-2021-07

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

input-file:
  - Microsoft.ContainerService/stable/2021-07-01/managedClusters.json

Tag: package-2021-05

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

input-file:
  - Microsoft.ContainerService/stable/2021-05-01/managedClusters.json

Tag: package-2021-03

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

input-file:
  - Microsoft.ContainerService/stable/2021-03-01/managedClusters.json

Tag: package-2021-02

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

input-file:
  - Microsoft.ContainerService/stable/2021-02-01/managedClusters.json

Tag: package-2020-12

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

input-file:
  - Microsoft.ContainerService/stable/2020-12-01/managedClusters.json

Tag: package-2020-11

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

input-file:
  - Microsoft.ContainerService/stable/2020-11-01/managedClusters.json

Tag: package-2020-09

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-09-01/managedClusters.json

Tag: package-2020-07

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-07-01/managedClusters.json

Tag: package-2020-06

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-06-01/managedClusters.json

Tag: package-2020-04

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-04-01/managedClusters.json

Tag: package-2020-03

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-03-01/managedClusters.json

Tag: package-2020-02

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-02-01/managedClusters.json

Tag: package-2020-01

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-01-01/managedClusters.json

Tag: package-2019-11

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2019-11-01/managedClusters.json

Tag: package-2019-10-27-preview

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

input-file:
  - Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2020-01-01/managedClusters.json

Tag: package-2019-09-30-preview

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

input-file:
  - Microsoft.ContainerService/preview/2019-09-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/managedClusters.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json

Tag: package-2019-10

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2019-10-01/managedClusters.json

Tag: package-2019-08

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-08-01/location.json
  - Microsoft.ContainerService/stable/2019-08-01/managedClusters.json

Tag: package-2019-06

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

input-file:
  - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
  - Microsoft.ContainerService/stable/2017-07-01/containerService.json
  - Microsoft.ContainerService/stable/2019-06-01/location.json
  - Microsoft.ContainerService/stable/2019-06-01/managedClusters.json

Tag: package-2019-04

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

input-file:
- Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2019-04-01/managedClusters.json
- Microsoft.ContainerService/stable/2019-04-01/location.json

Tag: package-2019-02

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

input-file:
- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2019-02-01/managedClusters.json
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2018-08-preview

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

input-file:
- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2018-09-30-preview

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

input-file:
- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2018-03-31/managedClusters.json
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2018-03

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

input-file:
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2018-03-31/managedClusters.json
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2017-09

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

input-file:
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2017-08-31/managedClusters.json
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2017-08

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

input-file:
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2017-08-31/managedClusters.json

Tag: package-2017-07

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

input-file:
- Microsoft.ContainerService/stable/2017-07-01/containerService.json

Tag: package-2021-08-01-only

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

input-file:
- Microsoft.ContainerService/stable/2021-08-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2021-07-01-only

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

input-file:
- Microsoft.ContainerService/stable/2021-07-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2021-05-01-only

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

input-file:
- Microsoft.ContainerService/stable/2021-05-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2021-03-01-only

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

input-file:
- Microsoft.ContainerService/stable/2021-03-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2021-02-01-only

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

input-file:
- Microsoft.ContainerService/stable/2021-02-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-12-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-12-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-11-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-11-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-09-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-09-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-07-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-07-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-06-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-06-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-04-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-04-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-03-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-03-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-02-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-02-01/managedClusters.json
directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile
    reason: Cluster-autoscaler settings are not camel-cased

Tag: package-2020-01-01-only

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

input-file:
- Microsoft.ContainerService/stable/2020-01-01/managedClusters.json

Tag: package-2019-11-01-only

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

input-file:
- Microsoft.ContainerService/stable/2019-11-01/managedClusters.json

Tag: package-2019-10-27-preview-only

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

input-file:
- Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json

Tag: package-2019-10-01-only

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

input-file:
- Microsoft.ContainerService/stable/2019-10-01/managedClusters.json

Tag: package-2019-08-01-only

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

input-file:
- Microsoft.ContainerService/stable/2019-08-01/managedClusters.json

Tag: package-2019-06-01-only

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

input-file:
- Microsoft.ContainerService/stable/2019-06-01/managedClusters.json

Tag: package-2019-04-30-only

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

input-file:
- Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json

Tag: package-2019-04-01-only

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

input-file:
- Microsoft.ContainerService/stable/2019-04-01/managedClusters.json

Tag: package-2019-02-only

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

input-file:
- Microsoft.ContainerService/stable/2019-02-01/managedClusters.json

Tag: package-2018-08-preview-only

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

input-file:
- Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json

Tag: package-2018-09-preview-only

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

input-file:
- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json

Tag: package-2019-09-preview-only

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

input-file:
- Microsoft.ContainerService/preview/2019-09-30/openShiftManagedClusters.json

Tag: package-2018-03-only

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

input-file:
- Microsoft.ContainerService/stable/2018-03-31/managedClusters.json

Tag: package-2017-07-only-extended

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

This tag is special, since it brings together two API version that belongs to the same operation group, since Python does not know how to handle multi-api operation group for now.

input-file:
- Microsoft.ContainerService/stable/2017-07-01/containerService.json
- Microsoft.ContainerService/stable/2019-04-01/location.json

Tag: package-2017-08-only

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

input-file:
- Microsoft.ContainerService/stable/2017-08-31/managedClusters.json

Tag: package-2017-09-only

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

input-file:
- Microsoft.ContainerService/stable/2017-09-30/location.json

Tag: package-2017-01-only

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

input-file:
- Microsoft.ContainerService/stable/2017-01-31/containerService.json

Tag: package-2016-09-only

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

input-file:
- Microsoft.ContainerService/stable/2016-09-30/containerService.json

Tag: package-2016-03-only

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

input-file:
- Microsoft.ContainerService/stable/2016-03-30/containerService.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-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-net
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-ruby
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_service']
  - repo: azure-resource-manager-schemas

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.ContainerService
  payload-flattening-threshold: 1
  output-folder: $(csharp-sdks-folder)/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated
  clear-output-folder: true

Go

See configuration in readme.go.md

Python

See configuration in readme.python.md

Java

See configuration in readme.java.md

Suppression

directive:
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: managedClusters.json
    reason: Name change of "enableRBAC" property would break compatibility
  - suppress: TrackedResourcePatchOperation
    from: containerService.json
    reason: ACS service is deprecated so a PATCH endpoint won't be implemented