Skip to content

Attempt to fix readme #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmdenmsft merged 1 commit into from
Apr 11, 2019
Merged

Attempt to fix readme #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 42 additions & 21 deletions specification/timeseriesinsights/data-plane/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,43 @@

# Azure Time Series Insights Data Plane API
# TimeSeriesInsights

## Getting Started
> see https://aka.ms/autorest

To build the SDKs for Azure Time Series Insights Data Plane API, simply [Install AutoRest](#Installing-AutoRest) and run:
> `Autorest.exe readme.md`
This is the AutoRest configuration file for Azure Time Series Insights Data Plane API.

---

## Getting Started

To build the SDK for Azure Time Series Insights Data Plane API, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:

> `autorest`

To see additional help and options, run:
> `Autorest.exe help readme.md`

### Installing AutoRest
> `autorest --help`
---

AutoRest is most easily installed via the Node JS package `autorest`:
> npm install -g autorest
## Configuration

For other options on installation see [Installing AutoRest](https://aka.ms/installing-autorest.md) on the AutoRest github page.
### Basic Information

## AutoRest configuration
These are the global settings for Azure Time Series Insights Data Plane API.

``` yaml
input-file:
- Microsoft.TimeSeriesInsights\preview\2018-11-01-preview\timeseriesinsights.json

azure-validator: true
model-validator: true
semantic-validator: true
add-credentials: true
openapi-type: data-plane
add-credentials: true
license-header: MICROSOFT_MIT
sync-methods: none
tag: package-2018-11-01-preview
```

csharp:
namespace: Microsoft.Azure.TimeSeriesInsights
output-folder: Generated/CSharp
### Tag: package-2018-11-01-preview

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

``` yaml $(tag) == 'package-2018-11-01-preview'
input-file:
- Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json
```

## Suppression
Expand All @@ -49,3 +53,20 @@ directive:
- suppress: R3017
reason: GUIDs are required to enforce referential constraints and reduce number of updates.
```

---
# Code Generation

## 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>`.

``` yaml $(csharp)
csharp:
sync-methods: none
azure-arm: false
license-header: MICROSOFT_MIT_NO_VERSION
namespace: Microsoft.Azure.TimeSeriesInsights
output-folder: $(csharp-sdks-folder)/TimeSeriesInsights/DataPlane.TimeSeriesInsights/Generated
```