Skip to content

Latest commit

 

History

History
118 lines (76 loc) · 2.97 KB

readme.md

File metadata and controls

118 lines (76 loc) · 2.97 KB
Raw

help

see https://aka.ms/autorest

This is the AutoRest configuration file for help.

Getting Started

To build the SDKs for My API, simply install AutoRest via npm (npm install -g autorest) and then run:

autorest readme.md

To see additional help and options, run:

autorest --help

For other options on installation see Installing AutoRest on the AutoRest github page.

Configuration

Basic Information

These are the global settings for the help.

openapi-type: arm
tag: package-2024-03-01-preview

ed

Tag: package-2024-03-01-preview

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

input-file:
  - Microsoft.Help/preview/2024-03-01-preview/help.json

Tag: package-2023-09-01-preview

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

input-file:
  - Microsoft.Help/preview/2023-09-01-preview/help.json

Tag: package-2023-06-01

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

input-file:
  - Microsoft.Help/stable/2023-06-01/help.json

Tag: package-2023-01-01-preview

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

input-file:
  - Microsoft.Help/preview/2023-01-01-preview/help.json

Suppression

directive:
  - suppress: AllResourcesMustHaveDelete
    reason: As a proxy only resource provider, we are creating virtual diagnostic solutions on existing resources instead of actually creating an resource. Thus, we do not support delete operation for our resource type.
    from: help.json
  - suppress: TopLevelResourcesListBySubscription
    reason: We do not support top level resource; all resource types are virtual proxy only resource types. For instance, an example request path for diagnostics could be subscriptions/mySubscription/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/diagnostics/VMNotWorkingInsight.
    from: help.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-java
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-resource-manager-schemas
  - repo: azure-cli-extensions
  - repo: azure-powershell

Go

See configuration in readme.go.md

Python

See configuration in readme.python.md

TypeScript

See configuration in readme.typescript.md

CSharp

See configuration in readme.csharp.md