Skip to content

Latest commit

 

History

History
182 lines (142 loc) · 5.96 KB

readme.md

File metadata and controls

182 lines (142 loc) · 5.96 KB

Azure Deployment Manager

see https://aka.ms/autorest

This is the AutoRest configuration file for Deployment Manager.

Getting Started

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

openapi-type: arm
tag: package-2019-11-01-preview

Tag: package-2019-11-01-preview

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

input-file:
- Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json
directive:
  - suppress: EnumInsteadOfBoolean
    reason:  The boolean properties in the specification are actually boolean values in the Deployment Manager application model.
    from: deploymentmanager.json
  - suppress: TrackedResourceListByImmediateParent
    reason: Not available during preview.
  - suppress: TrackedResourcePatchOperation
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: TrackedResourceListBySubscription
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: TrackedResourceListByResourceGroup
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: PageableOperation
    reason: List operations returns a static list of supported operations for each API version and does not need paging.
    from: deploymentmanager.json
  - suppress: TrackedResourceGetOperation
    reason: The rollout resource has a get operation. The request and response types are separated for clarity.
    where: $.definitions.RolloutRequest
  - suppress: DescriptionAndTitleMissing
    reason: Common types warning.
    where: $.definitions.Resource
  - suppress: AvoidNestedProperties
    reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource.
    where: $.definitions.StepResource.properties.properties

Tag: package-2018-09-01-preview

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

input-file:
- Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json
directive:
  - suppress: EnumInsteadOfBoolean
    reason:  The boolean properties in the specification are actually boolean values in the Deployment Manager application model.
    from: deploymentmanager.json
  - suppress: TrackedResourceListByImmediateParent
    reason: Not available during preview.
  - suppress: TrackedResourcePatchOperation
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: TrackedResourceListBySubscription
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: TrackedResourceListByResourceGroup
    reason: Not available at this time.
    from: deploymentmanager.json
  - suppress: TrackedResourceGetOperation
    reason: The rollout resource has a get operation. The request and response types are separated for clarity.
    where: $.definitions.RolloutRequest
  - suppress: DescriptionAndTitleMissing
    reason: Common types warning.
    where: $.definitions.Resource
  - suppress: AvoidNestedProperties
    reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource.
    where: $.definitions.StepResource.properties.properties

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-track2
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-ruby
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_deploymentmanager']
  - 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.DeploymentManager
  payload-flattening-threshold: 2
  output-folder: $(csharp-sdks-folder)/deploymentmanager/Microsoft.Azure.Management.DeploymentManager/src/Generated
  clear-output-folder: true

Python

See configuration in readme.python.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>.

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

service-name: Deployment

Java multi-api

batch:
  - tag: package-2019-11-01-preview

Tag: package-2019-11-01-preview and java

These settings apply only when --tag=package-2019-11-01-preview --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.deploymentmanager.v2019_11_01_preview
  output-folder: $(azure-libraries-for-java-folder)/sdk/deploymentmanager/mgmt-v2019_11_01_preview
regenerate-manager: true
generate-interface: true