Skip to content

Latest commit

 

History

History
139 lines (100 loc) · 3.46 KB

readme.md

File metadata and controls

139 lines (100 loc) · 3.46 KB

Purview

see https://aka.ms/autorest

This is the AutoRest configuration file for Purview.

Getting Started

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

openapi-type: arm
tag: package-2020-12-01-preview

Tag: package-2020-12-01-preview

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

input-file:
- Microsoft.Purview/preview/2020-12-01-preview/purview.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
  - repo: azure-sdk-for-go

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

Go

These settings apply only when --go is specified on the command line.

go:
  license-header: MICROSOFT_APACHE_NO_VERSION
  namespace: purview
  clear-output-folder: true

Suppression

directive:
  - suppress: R3018  # EnumInsteadOfBoolean
    where:
      - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable
      - $.definitions.DimensionProperties.properties.toBeExportedForCustomer
    reason:
      - Check name model is set by ARM team https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#check-name-availability-requests  
  - suppress: R4009  # RequiredSystemDataInNewApiVersions
    reason:
      - We do not yet support systemdata

Go multi-api

batch:
  - tag: package-2020-12-01-preview

Tag: package-2020-12-01-preview and go

These settings apply only when --tag=package-2020-12-01-preview --go is specified on the command line. Please also specify --go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>.

output-folder: $(go-sdk-folder)/services/preview/purview/mgmt/2020-12-01-preview/$(namespace)