Skip to content

Latest commit

 

History

History
338 lines (235 loc) · 11.8 KB

readme.md

File metadata and controls

338 lines (235 loc) · 11.8 KB
Raw

DesktopVirtualization

see https://aka.ms/autorest

This is the AutoRest configuration file for Desktop Virtualization.

Getting Started

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

openapi-type: arm
tag: package-preview-2024-04

Tag: package-preview-2024-04

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json
suppressions:
  - code: AvoidAdditionalProperties
    from: desktopvirtualization.json
    reason: False postive -> additionalProperties showing in the nested object properties, not at the top level. E.g. "object.vmTags.additionalProperties" and not "object.additionalProperties". We cannot manually exclude using where clauses because of an active bug on this rule. When this is fixed, we should be able to add a (single) where clause.
  - code: XmsPageableForListCalls
    from: desktopvirtualization.json
    reason: False postive -> we have a singleton element in the collection, per recommendation from ARM API review, meaning that we will never return a collection hence no need for such list annotations. Learn more about this (approved) scenario @  ARM RPC Guidance https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#singleton-resources
    where:
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default'].*
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default'].*
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default'].*
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default'].*
  - code: EvenSegmentedPathForPutOperation
    from: desktopvirtualization.json
    reason: False postive -> we have a singleton element in the collection, per recommendation from ARM API review, meaning that we won't have an "even" number of segments. Learn more about this (approved) scenario @  ARM RPC Guidance https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#singleton-resources
    where:
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default']
        - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default']

Tag: package-2024-04

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

input-file:
  - Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json

Tag: package-preview-2024-03

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json
suppressions:
  - code: ResourceNameRestriction
    from: desktopvirtualization.json
    reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278

Tag: package-preview-2024-01

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json
suppressions:
  - code: ResourceNameRestriction
    from: desktopvirtualization.json
    reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278

Tag: package-preview-2023-11

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json
suppressions:
  - code: ResourceNameRestriction
    from: desktopvirtualization.json
    reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278

Tag: package-preview-2023-10

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json
suppressions:
  - code: ResourceNameRestriction
    reason: HostPoolName, ApplicationGroupName, WorkspaceName, ScalingPlanName were already implemented in previous versions of the API and we cannot change naming pattern now.

Tag: package-2023-09

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

input-file:
  - Microsoft.DesktopVirtualization/stable/2023-09-05/desktopvirtualization.json

Tag: package-preview-2023-07

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2023-07-07-preview/desktopvirtualization.json

suppressions:
  - code: ResourceNameRestriction
    reason: ScalingPlan was already implemented in previous versions of the API and
      we cannot change naming pattern now.
  - code: PatchIdentityProperty
    reason: There is an error loop with the identity property. We received approval to suppress this error, but we still need to investigate error loop.

Tag: package-preview-2022-10

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2022-10-14-preview/desktopvirtualization.json

Tag: package-2022-09

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

input-file:
  - Microsoft.DesktopVirtualization/stable/2022-09-09/desktopvirtualization.json

Tag: package-preview-2022-04

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2022-04-01-preview/desktopvirtualization.json

Tag: package-preview-2022-02

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2022-02-10-preview/desktopvirtualization.json

Tag: package-preview-2021-09

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

input-file:
  - Microsoft.DesktopVirtualization/preview/2021-09-03-preview/desktopvirtualization.json

Tag: package-2021-07

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

input-file:
  - Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json

Tag: package-2019-01-23-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json

Tag: package-2019-09-24-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json

Tag: package-2019-12-10-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json

Tag: package-2020-09-21-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json

Tag: package-2020-10-19-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2020-10-19-preview/desktopvirtualization.json

Tag: package-2020-11-02-preview

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

input-file:
- Microsoft.DesktopVirtualization/preview/2020-11-02-preview/desktopvirtualization.json

Tag: package-2020-11-10-preview

input-file:
- Microsoft.DesktopVirtualization/preview/2020-11-10-preview/desktopvirtualization.json

Tag: package-2021-01-14-preview

input-file:
- Microsoft.DesktopVirtualization/preview/2021-01-14-preview/desktopvirtualization.json

Tag: package-2021-02-01-preview

input-file:
- Microsoft.DesktopVirtualization/preview/2021-02-01-preview/desktopvirtualization.json

Tag: package-2021-03-09-preview

input-file:
- Microsoft.DesktopVirtualization/preview/2021-03-09-preview/desktopvirtualization.json

Tag: package-2021-04-01-preview

input-file:
- Microsoft.DesktopVirtualization/preview/2021-04-01-preview/desktopvirtualization.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-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_desktop_virtualization']
  - repo: azure-cli-extensions
  - repo: azure-resource-manager-schemas
  - repo: azure-powershell

C#

See configuration in readme.csharp.md

Python

See configuration in readme.python.md

Java

See configuration in readme.java.md

Go

See configuration in readme.go.md

TypeScript

See configuration in readme.typescript.md

Node

See configuration in readme.node.md

Ruby

See configuration in readme.ruby.md