Skip to content

readme.md

Latest commit

 

History

History
597 lines (402 loc) · 16.3 KB

readme.md

File metadata and controls

597 lines (402 loc) · 16.3 KB

Azure NetApp Files

see https://aka.ms/autorest

This is the AutoRest configuration file for Azure NetApp Files.

Getting Started

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

title: NetAppManagementClient
description: Microsoft NetApp Files Azure Resource Provider specification
openapi-type: arm
tag: package-2025-09-01

Tag: package-preview-2025-09-01-preview

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

input-file:
  - preview/2025-09-01-preview/netapp.json

Tag: package-2025-09-01

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

input-file:
  - stable/2025-09-01/netapp.json

Tag: package-preview-2025-08-01-preview

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

input-file:
  - preview/2025-08-01-preview/netapp.json

Tag: package-2025-08-01

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

input-file:
  - stable/2025-08-01/netapp.json

Tag: package-preview-2025-07-01-preview

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

input-file:
  - preview/2025-07-01-preview/netapp.json

Tag: package-2025-06-01

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

input-file:
  - stable/2025-06-01/netapp.json

Tag: package-preview-2025-03-01-preview

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

input-file:
  - preview/2025-03-01-preview/netapp.json

Tag: package-2025-03-01

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

input-file:
  - stable/2025-03-01/netapp.json

Tag: package-2025-01-01-preview

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

input-file:
  - preview/2025-01-01-preview/netapp.json

Tag: package-2025-01-01

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

input-file:
  - stable/2025-01-01/netapp.json

Tag: package-2024-09-01

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

input-file:
  - stable/2024-09-01/netapp.json

Tag: package-preview-2024-09-01-preview

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

input-file:
  - preview/2024-09-01-preview/netapp.json

Tag: package-preview-2024-07-01-preview

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

input-file:
  - preview/2024-07-01-preview/netapp.json

Tag: package-2024-07

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

input-file:
  - stable/2024-07-01/netapp.json

Tag: package-preview-2024-05

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

input-file:
  - preview/2024-05-01-preview/netapp.json

Tag: package-2024-05

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

input-file:
  - stable/2024-05-01/netapp.json

Tag: package-2024-03

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

input-file:
  - stable/2024-03-01/netapp.json

Tag: package-2024-01

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

input-file:
  - stable/2024-01-01/netapp.json

Tag: package-preview-2024-03

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

input-file:
  - preview/2024-03-01-preview/netapp.json

Tag: package-preview-2023-11

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

input-file:
  - preview/2023-11-01-preview/netapp.json

Tag: package-netapp-2023-11-01

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

input-file:
  - stable/2023-11-01/netapp.json

Tag: package-preview-2023-07

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

input-file:
  - preview/2023-07-01-preview/netapp.json

Tag: package-netapp-2023-07-01

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

input-file:
  - stable/2023-07-01/netapp.json

Tag: package-preview-2023-05

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

input-file:
  - preview/2023-05-01-preview/netapp.json

Tag: package-netapp-2023-05-01

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

input-file:
  - stable/2023-05-01/netapp.json

Tag: package-netapp-2022-11-01

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

input-file:
- stable/2022-11-01/netapp.json

Tag: package-netapp-2022-11-01-preview

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

input-file:
- preview/2022-11-01-preview/netapp.json

Tag: package-netapp-2022-09-01

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

input-file:
- stable/2022-09-01/netapp.json

Tag: package-netapp-2022-05-01

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

input-file:
- stable/2022-05-01/netapp.json

Tag: package-netapp-2022-03-01

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

input-file:
- stable/2022-03-01/netapp.json

Tag: package-netapp-2022-01-01

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

input-file:
- stable/2022-01-01/netapp.json

Tag: package-netapp-2021-10-01

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

input-file:
- stable/2021-10-01/netapp.json

Tag: package-netapp-2021-08-01

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

input-file:
- stable/2021-08-01/netapp.json

Tag: package-netapp-2021-06-01

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

input-file:
- stable/2021-06-01/netapp.json

Tag: package-netapp-2021-04-01

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

input-file:
- stable/2021-04-01/netapp.json

Tag: package-netapp-2021-04-01-preview

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

input-file:
- preview/2021-04-01-preview/netapp.json

Tag: package-netapp-2021-02-01

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

input-file:
- stable/2021-02-01/netapp.json

Tag: package-netapp-2020-12-01

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

input-file:
- stable/2020-12-01/netapp.json

Tag: package-netapp-2020-11-01

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

input-file:
- stable/2020-11-01/netapp.json

Tag: package-netapp-2020-09-01

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

input-file:
- stable/2020-09-01/netapp.json

Tag: package-netapp-2020-08-01

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

input-file:
- stable/2020-08-01/netapp.json

Tag: package-netapp-2020-07-01

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

input-file:
- stable/2020-07-01/netapp.json

Tag: package-netapp-2020-06-01

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

input-file:
- stable/2020-06-01/netapp.json

Tag: package-netapp-2020-05-01

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

input-file:
- stable/2020-05-01/netapp.json

Tag: package-netapp-2020-03-01

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

input-file:
- stable/2020-03-01/netapp.json

Tag: package-netapp-2020-02-01

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

input-file:
- stable/2020-02-01/netapp.json

Tag: package-netapp-2019-11-01

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

input-file:
- stable/2019-11-01/netapp.json

Tag: package-netapp-2019-10-01

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

input-file:
- stable/2019-10-01/netapp.json

Tag: package-netapp-2019-08-01

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

input-file:
- stable/2019-08-01/netapp.json

Tag: package-netapp-2019-07-01

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

input-file:
- stable/2019-07-01/netapp.json

Tag: package-netapp-2019-06-01

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

input-file:
- stable/2019-06-01/netapp.json

Tag: package-netapp-2019-05-01

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

input-file:
- stable/2019-05-01/netapp.json

Tag: package-2017-08-15

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

input-file:
- preview/2017-08-15/netapp.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-trenton
  - repo: azure-resource-manager-schemas
  - repo: azure-powershell

C#

See configuration in readme.csharp.md

Python

See configuration in readme.python.md

JavaScript/TypeScript

See configuration in readme.typescript.md

Go

See configuration in readme.go.md

Java

See configuration in readme.java.md

Terraform

These settings apply only when --terraform is specified on the command line.

terraform:
    cli-name: netapp
    azure_arm: true
    license_header: MICROSOFT_MIT_NO_VERSION
    payload_flattening_threshold: 2
    namespace: netapp
    package-name: netapp
    clear-output-folder: false

Suppressions

suppressions:
  - code: LroPostReturn
    reason: The linter incorrectly flags LRO POST operations with no payload response, should allow to be a 202/204 NoContent for the LRO empty response case
    from: netapp.json
    where:
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles"].post
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups"].post
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups"].post

  - code: XmsPageableForListCalls
    reasons: These are GET on a singleton resource. These are false positives.
    from: netapp.json
    where:
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current"].get
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current"].get
      - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default"].get

  - code: RequiredPropertiesMissingInResourceModel
    reason: https://eng.ms/docs/products/arm/api_contracts/usagesapicontract
    where:
     - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/usages"].get
     - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/usages/{usageType}"].get
     - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/usages"].get.responses.200.schema
     - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/usages/{usageType}"].get.responses.200.schema
     - $.definitions.UsagesListResult
     - $.definitions.UsageResult

  - code: PostResponseCodes
    reason: The linter incorrectly flags LRO POST operations with no payload response, should allow to be a 202/204 NoContent for the LRO empty response case
    from: netapp.json
    where:
      - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent"].post