Skip to content

Latest commit

 

History

History
385 lines (305 loc) · 14 KB

readme.md

File metadata and controls

385 lines (305 loc) · 14 KB
Raw

Cosmos-DB

see https://aka.ms/autorest

This is the AutoRest configuration file for Cosmos-DB.

Getting Started

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

title: CosmosDBManagementClient
openapi-type: arm
tag: package-2021-03-preview

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

input-file:
- Microsoft.DocumentDB/preview/2021-03-01-preview/cosmos-db.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/notebook.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/rbac.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/restorable.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/managedCassandra.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2021-03-01-preview/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2021-01

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

input-file:
  - Microsoft.DocumentDB/stable/2021-01-15/cosmos-db.json
  - Microsoft.DocumentDB/stable/2021-01-15/notebook.json
  - Microsoft.DocumentDB/stable/2021-01-15/privateLinkResources.json
  - Microsoft.DocumentDB/stable/2021-01-15/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2020-09

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

input-file:
  - Microsoft.DocumentDB/stable/2020-09-01/cosmos-db.json
  - Microsoft.DocumentDB/stable/2020-09-01/notebook.json
  - Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
  - Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2020-06-preview

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

input-file:
- Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json
- Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json
- Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json
- Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2020-04

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

input-file:
- Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json
- Microsoft.DocumentDB/stable/2020-04-01/notebook.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2020-03

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

input-file:
- Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json
- Microsoft.DocumentDB/stable/2020-03-01/notebook.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
modelerfour:
  lenient-model-deduplication: true

Tag: package-2019-12

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

input-file:
- Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json
- Microsoft.DocumentDB/stable/2019-12-12/notebook.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json

Tag: package-2019-08

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

input-file:
- Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json
- Microsoft.DocumentDB/stable/2019-08-01/notebook.json

Tag: package-2019-08-preview

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

input-file:
- Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json
- Microsoft.DocumentDB/stable/2019-08-01/notebook.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json

Tag: package-2015-04

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

input-file:
- Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json

Tag: package-2014-04

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

input-file:
- Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json

Tag: package-2015-11

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

input-file:
- Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json

Tag: package-2016-03-19

These settings apply only when --tag=package-2016-03-19 is specified on the command line.

input-file:
- Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json

Tag: package-2016-03-31

These settings apply only when --tag=package-2016-03-31 is specified on the command line.

input-file:
- Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json

Suppression

directive:
  - suppress: TrackedResourceGetOperation
    from: cosmos-db.json
    where: $.definitions.DatabaseAccountCreateUpdateParameters
    reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation
  - suppress: TrackedResourcePatchOperation
    from: cosmos-db.json
    where: $.definitions.DatabaseAccountCreateUpdateParameters
    reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.MetricValue.properties._count
    reason: The Metrics API has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.ExtendedResourceProperties.properties._rid
    reason: The resource has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.ExtendedResourceProperties.properties._ts
    reason: The resource has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.ExtendedResourceProperties.properties._etag
    reason: The resource has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.SqlDatabaseGetProperties.properties._colls
    reason: The database has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.SqlDatabaseGetProperties.properties._users
    reason: The database has a property name with a leading underscore character
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P10
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P25
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P50
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P75
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P90
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P95
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: DefinitionsPropertiesNamesCamelCase
    from: cosmos-db.json
    where: $.definitions.PercentileMetricValue.properties.P99
    reason: The Metrics API has percentile metrics property names with leading capital letters
  - suppress: PathResourceProviderNamePascalCase
    from: cosmos-db.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: PathResourceProviderNamePascalCase
    from: notebook.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: PathResourceProviderNamePascalCase
    from: managedCassandra.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: PathResourceProviderNamePascalCase
    from: privateEndpointConnection.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: PathResourceProviderNamePascalCase
    from: privateLinkResources.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: PathResourceProviderNamePascalCase
    from: rbac.json
    reason: The name of the provider is Microsoft.DocumentDB
  - suppress: RequiredSystemDataInNewApiVersions
    reason: We do not yet support system data
  - suppress: ListInOperationName
    from: managedCassandra.json
    reason: False positive on GET instanceView.
  - suppress: RequiredDefaultResponse
    from: cosmos-db.json
    reason: Linter rules added without correcting existing issues.
  - suppress: DeleteOperationResponses
    from: managedCassandra.json
    reason: Linter is broken and throwing false positives.

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-python-track2
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-resource-manager-schemas
    after_scripts:
      - node sdkauto_afterscript.js cosmos-db/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.CosmosDB
  output-folder: $(csharp-sdks-folder)/cosmosdb/Microsoft.Azure.Management.CosmosDB/src/Generated
  clear-output-folder: true

Python

See configuration in readme.python.md

Go

See configuration in readme.go.md

Java

See configuration in readme.java.md

AzureResourceSchema

See configuration in readme.azureresourceschema.md

Multi-API/Profile support for AutoRest v3 generators

AutoRest V3 generators require the use of --tag=all-api-versions to select api files.

This block is updated by an automatic script. Edits may be lost!

# include the azure profile definitions from the standard location
require: $(this-folder)/../../../profiles/readme.md

# all the input files across all versions
input-file:
  - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json
  - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json
  - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
  - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/notebook.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/notebook.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/notebook.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/notebook.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json
  - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json

If there are files that should not be in the all-api-versions set, uncomment the exclude-file section below and add the file paths.

#exclude-file: 
#  - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json