Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 4.99 KB

readme.md

File metadata and controls

179 lines (125 loc) · 4.99 KB
Raw

Guest Configuration

see https://aka.ms/autorest

This is the AutoRest configuration file for Guest Configuration.

Getting Started

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

title: GuestConfigurationClient
description: Guest Configuration Client
openapi-type: arm
tag: package-2024-04-05
modelerfour:
  flatten-models: false

Tag: package-2024-04-05

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

input-file:
  - Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json

Tag: package-2022-01-25

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

input-file:
  - Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json

Tag: package-2021-01-25

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

input-file:
  - Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json

Tag: package-2020-06-25

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

input-file:
  - Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json

Tag: package-2018-11-20

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

input-file:
  - Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json

Tag: package-2018-06-30-preview

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

input-file:
- Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

Tag: package-2018-01-20-preview

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

input-file:
- Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json

Suppression

directive:
  - suppress: UniqueResourcePaths
    from: guestconfiguration.json
    where: $.paths
    reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540'
  - suppress: OperationsAPIImplementation
    from: guestconfiguration.json
    where: $.paths
    reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implemented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540'
  - suppress: OperationsAPIImplementation
    from: guestconfiguration_NotImplemented.json
    where: $.paths
    reason: |-
      - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 
      - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559 
  - suppress: UniqueResourcePaths
    from: guestconfiguration_NotImplemented.json
    where: $.paths
    reason: |-
      - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 
      - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559 
  - suppress: TrackedResourceListByImmediateParent
    from: guestconfiguration_NotImplemented.json
    where: $.definitions
    reason: |-
      - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 
      - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559

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
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-cli-extensions
  - repo: azure-resource-manager-schemas
  - repo: azure-powershell

Python

See configuration in readme.python.md

TypeScript

See configuration in readme.typescript.md

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