Skip to content

Latest commit

 

History

History
146 lines (103 loc) · 3.85 KB

readme.md

File metadata and controls

146 lines (103 loc) · 3.85 KB
Raw

SignalR

see https://aka.ms/autorest

This is the AutoRest configuration file for SignalR.

Getting Started

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

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

Suppression

directive:
  - suppress: EnumInsteadOfBoolean
    from: signalr.json
    where: $.definitions.NameAvailability.properties.nameAvailable
    reason:  The boolean properties 'nameAvailable' is actually boolean value defined by Azure API spec
  - suppress: EnumInsteadOfBoolean
    from: signalr.json
    where: $.definitions.Dimension.properties.toBeExportedForShoebox
    reason:  The boolean properties 'toBeExportedForShoebox' is defined by Geneva metrics.
  - suppress: EnumInsteadOfBoolean
    from: signalr.json
    where: $.definitions.Operation.properties.isDataAction
    reason:  The boolean properties 'isDataAction' is a standard property for Azuer Operatoins.
  - suppress: TrackedResourceListByImmediateParent
    reason: Another list APIs naming approach is used over the specs
  - suppress: AvoidNestedProperties
    from: signalr.json
    where:
    - $.definitions.SignalRFeature.properties.properties
    - $.definitions.PrivateEndpointConnection.properties.properties
    reason:  The 'properties' is a user-defined dictionary, cannot be flattened.

Tag: package-2020-07-01-preview

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

input-file:
- Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json

Tag: package-2020-05-01

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

input-file:
- Microsoft.SignalRService/stable/2020-05-01/signalr.json

Tag: package-2018-10-01

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

input-file:
- Microsoft.SignalRService/stable/2018-10-01/signalr.json

Tag: package-2018-03-01-preview

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

input-file:
- Microsoft.SignalRService/preview/2018-03-01-preview/signalr.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-python
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-ruby
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_signalr']
  - repo: azure-resource-manager-schemas
    after_scripts:
      - node sdkauto_afterscript.js signalr/resource-manager

Go

See configuration in readme.go.md

Java

See configuration in readme.java.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:
  # last generated with AutoRest.0.17.3
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.SignalR
  output-folder: $(csharp-sdks-folder)/signalr/Microsoft.Azure.Management.SignalR/src/Generated
  clear-output-folder: true

AzureResourceSchema

See configuration in readme.azureresourceschema.md