Skip to content

Latest commit

 

History

History
311 lines (240 loc) · 9.96 KB

readme.md

File metadata and controls

311 lines (240 loc) · 9.96 KB
Raw

Maps

see https://aka.ms/autorest

This is the AutoRest configuration file for Maps.

Getting Started

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

title: AzureMapsManagementClient
description: Azure Maps
openapi-type: arm
tag: package-preview-2024-07

Tag: package-preview-2024-07

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

input-file:
  - Microsoft.Maps/preview/2024-07-01-preview/maps-management.json

Tag: package-preview-2024-01

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

input-file:
  - Microsoft.Maps/preview/2024-01-01-preview/maps-management.json

Tag: package-preview-2023-12

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

input-file:
  - Microsoft.Maps/preview/2023-12-01-preview/maps-management.json

Tag: package-preview-2023-08

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

input-file:
  - Microsoft.Maps/preview/2023-08-01-preview/maps-management.json

Tag: package-2023-06

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

input-file:
  - Microsoft.Maps/stable/2023-06-01/maps-management.json

Tag: package-preview-2021-12

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

input-file:
  - Microsoft.Maps/preview/2021-12-01-preview/maps-management.json

Tag: package-preview-2021-07

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

input-file:
  - Microsoft.Maps/preview/2021-07-01-preview/maps-management.json

Tag: package-2021-02

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

input-file:
  - Microsoft.Maps/stable/2021-02-01/maps-management.json

Tag: package-preview-2020-02

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

input-file:
  - Microsoft.Maps/preview/2020-02-01-preview/maps-management.json

Tag: package-2017-01

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

input-file:
- Microsoft.Maps/stable/2017-01-01-preview/maps-management.json

Tag: package-2018-05

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

input-file:
- Microsoft.Maps/stable/2018-05-01/maps-management.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-track2
  - repo: azure-sdk-for-python
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-resource-manager-schemas
  - repo: azure-powershell

Python

See configuration in readme.python.md

Go

See configuration in readme.go.md

Java

These settings apply only when --java is specified on the command line. Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>.

azure-arm: true
fluent: true
namespace: com.microsoft.azure.management.maps
license-header: MICROSOFT_MIT_NO_CODEGEN
payload-flattening-threshold: 1
output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-maps

Java multi-api

batch:
  - tag: package-2017-01
  - tag: package-2018-05
  - tag: package-2020-02

Tag: package-2020-02 and java

These settings apply only when --tag=package-2020-02 --java is specified on the command line. Please also specify --azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.maps.v2020_02_01_preview
  output-folder: $(azure-libraries-for-java-folder)/sdk/maps/mgmt-v2020_02_01_preview
regenerate-manager: true
generate-interface: true

Tag: package-2017-01 and java

These settings apply only when --tag=package-2017-01 --java is specified on the command line. Please also specify --azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.maps.v2017_01_01_preview
  output-folder: $(azure-libraries-for-java-folder)/sdk/maps/mgmt-v2017_01_01_preview
regenerate-manager: true
generate-interface: true

Tag: package-2018-05 and java

These settings apply only when --tag=package-2018-05 --java is specified on the command line. Please also specify --azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.maps.v2018_05_01
  output-folder: $(azure-libraries-for-java-folder)/sdk/maps/mgmt-v2018_05_01
regenerate-manager: true
generate-interface: true

Suppression

directive:
  - suppress: R2017
    where:
      - '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateAtlases/{privateAtlasName}"].put'
      - '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}"].put'
    from: maps-management.json
    reason:
      - Common type models are inherited.
      - ClientId property will be ignored by requests
  - suppress: R2001
    where:
      - $.definitions.PrivateAtlas.properties.properties
      - $.definitions.MapsAccount.properties.properties
    from: maps-management.json
    reason:
      - Flattening does not work well with polymorphic models.
      - PrivateAtlas.properties is an arbitrary dictionary and cannot be flattened.
      - MapsAccount.properties is an arbitrary dictionary and cannot be flattened.
  - suppress: R2026
    from: maps-management.json
    reason: Managed identity is standard property being applied to all azure resources.
  - suppress: R3006
    where:
      - $.definitions.MapsAccount.properties
      - $.definitions.Creator.properties
    reason:
      - Currently systemData is not allowed.
  - suppress: R3010
    where:
      - $.definitions
    reason:
      - Pipeline runs are not listable. The operation PrivateAtlases_ListByAccount serves this purpose.
  - suppress: R3027
    where:
      - $.definitions.PrivateAtlas
    reason:
      - This is a nested tracked resource.
  - suppress: R3028
    where:
      - $.definitions.PrivateAtlas
    reason:
      - This is a nested tracked resource.
  - suppress: R4000
    where:
      - $.definitions.Resource
    from: types.json
    reason:
      - Common type models are inherited.
  - suppress: AvoidNestedProperties
    where: $.definitions.Creator.properties.properties
    from: maps-management.json
    reason: False positive.
  - suppress: TrackedResourceListByResourceGroup
    where: $.definitions.Creator
    from: maps-management.json
    reason: Don't need to list by resourceGroup because this is a nested resource.
  - suppress: TrackedResourceListBySubscription
    where: $.definitions.Creator
    from: maps-management.json
    reason: Doesn't apply because this is a nested resource.
  - suppress: PutRequestResponseScheme
    where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}"].put'
    from: maps-management.json
    reason: False positive. Structure is the same with addition of provisioningStatus property.
  - suppress: DeleteOperationResponses
    where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}"].delete.responses'
    from: maps-management.json
    reason: Per ARM Specs addendum, async APIs must return 202 when a response is accepted.
  - suppress: RequiredReadOnlySystemData
    where: 
      - '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}"].put'
      - '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}"].patch'
      - '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}"].get'
    from: maps-management.json
    reason: Per ARM Specs, only top level tracked resources return systemMetadata.
  - suppress: EnumInsteadOfBoolean
    where: 
      - $.definitions.MapsAccountProperties.properties.disableLocalAuth
      - $.definitions.OperationDetail.properties.isDataAction
      - $.definitions.MetricSpecification.properties.fillGapWithZero
      - $.definitions.Dimension.properties.toBeExportedToShoebox
    from: maps-management.json
    reason: standard property being applied to all azure resources.
  - suppress: MISSING_APIS_IN_DEFAULT_TAG
    reason: ARM provides the specification for resource move operation. Hence, the operation has been removed from versions after 2018-05-01.