Skip to content

Latest commit

 

History

History

resource-manager

Data Catalog

see https://aka.ms/autorest

This is the AutoRest configuration file for Data Catalog.


Getting Started

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

title: DataCatalogRestClient
description: The Azure Data Catalog management API provides a RESTful set of web services that interact with Azure Data Catalog services.
openapi-type: arm
tag: package-2016-03-30

Tag: package-2016-03-30

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

input-file:
- Microsoft.DataCatalog/stable/2016-03-30/datacatalog.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-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node

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.DataCatalog
  output-folder: $(csharp-sdks-folder)/datacatalog/Microsoft.Azure.Management.DataCatalog/src/Generated
  clear-output-folder: true

Validation

Suppression

directive:
  - suppress: R3018  # EnumInsteadOfBoolean
    where:
      - $.definitions.ADCCatalogProperties.properties.successfullyProvisioned
      - $.definitions.ADCCatalogProperties.properties.enableAutomaticUnitAdjustment
    from: datacatalog.json
    reason: Booleans are used to indicate binary states of the property, enum is not appropriate.
  - suppress: R3027  # TrackedResourceListByResourceGroup
    where:
      - $.definitions.ADCCatalog
    from: datacatalog.json
    reason: Catalog is per tenant level resources.
  - suppress: R3028  # TrackedResourceListBySubscription
    where:
      - $.definitions.ADCCatalog
    from: datacatalog.json
    reason: Catalog can only be listed by resource group.

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.datacatalog
license-header: MICROSOFT_MIT_NO_CODEGEN
payload-flattening-threshold: 1
output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datacatalog

Java multi-api

batch:
  - tag: package-2016-03-30

Tag: package-2016-03-30 and java

These settings apply only when --tag=package-2016-03-30 --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.datacatalog.v2016_03_30
  output-folder: $(azure-libraries-for-java-folder)/sdk/datacatalog/mgmt-v2016_03_30
regenerate-manager: true
generate-interface: true

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.DataCatalog/stable/2016-03-30/datacatalog.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