Skip to content

Latest commit

 

History

History
216 lines (147 loc) · 5.87 KB

readme.md

File metadata and controls

216 lines (147 loc) · 5.87 KB
Raw

EventGrid

see https://aka.ms/autorest

This is the AutoRest configuration file for Azure EventGrid.

Getting Started

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

openapi-type: arm
tag: package-2020-10-preview

Tag: package-2020-10-preview

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

input-file:
- Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json

Tag: package-2020-06

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

input-file:
- Microsoft.EventGrid/stable/2020-06-01/EventGrid.json

Tag: package-2020-04-preview

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

input-file:
- Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json

Tag: package-2020-01-preview

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

input-file:
- Microsoft.EventGrid/preview/2020-01-01-preview/EventGrid.json

Tag: package-2019-06

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

input-file:
- Microsoft.EventGrid/stable/2019-06-01/EventGrid.json

Tag: package-2019-02-preview

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

input-file:
- Microsoft.EventGrid/preview/2019-02-01-preview/EventGrid.json

Tag: package-2019-01

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

input-file:
- Microsoft.EventGrid/stable/2019-01-01/EventGrid.json

Suppression

directive:
  - suppress: TrackedResourcePatchOperation
    from: EventGrid.json
    reason: PATCH operation already exists in the json file but this is known issue in the ARM validation.

Tag: package-2018-09-preview

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

input-file:
- Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json

Suppression

directive:
  - suppress: TrackedResourcePatchOperation
    from: EventGrid.json
    reason: PATCH operation already exists in the json file but this is known issue in the ARM validation.
  - suppress: ONE_OF_MULTIPLE
    from: EventGrid.json
    where: $.definitions.EventSubscriptionProperties.properties.destination
    reason: |-
      This is a false positive. We have multiple EventSubscriptionDestination types (EventHubEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination etc.) and each of them has corresponding property classes e.g. EventHubEventSubscriptionDestinationProperties and HybridConnectionEventSubscriptionDestinationProperties have both a property called resourceId which is why the validation appears to be flagging this.

      However, the discriminator value (endpointType) is separate for each of these destinations, hence based on the discriminator it will get deserialized into the appropriate type.

Tag: package-2018-05-preview

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

input-file:
- Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json

Tag: package-2018-01

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

input-file:
- Microsoft.EventGrid/stable/2018-01-01/EventGrid.json

Tag: package-2017-09-preview

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

input-file:
- Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json

Tag: package-2017-06-preview

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

input-file:
- Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.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-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-ruby
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_grid']
  - repo: azure-resource-manager-schemas
    after_scripts:
      - node sdkauto_afterscript.js eventgrid/resource-manager

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.EventGrid
  payload-flattening-threshold: 1
  output-folder: $(csharp-sdks-folder)/eventgrid/Microsoft.Azure.Management.EventGrid/src/Generated
  clear-output-folder: true

Go

See configuration in readme.go.md

Java

See configuration in readme.java.md

AzureResourceSchema

See configuration in readme.azureresourceschema.md