Skip to content

README.md

Latest commit

 

History

History
164 lines (152 loc) · 5.37 KB

README.md

File metadata and controls

164 lines (152 loc) · 5.37 KB
Raw

Az.DesktopVirtualization

This directory contains the PowerShell module for the DesktopVirtualization service.

Info

  • Modifiable: yes
  • Generated: all
  • Committed: yes
  • Packaged: yes

Detail

This module was primarily generated via AutoRest using the PowerShell extension.

Module Requirements

Authentication

AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.

Development

For information on how to develop for Az.DesktopVirtualization, see how-to.md.

Generation Requirements

Use of the beta version of autorest.powershell generator requires the following:

  • NodeJS LTS (10.15.x LTS preferred)
    • Note: It will not work with Node < 10.x. Using 11.x builds may cause issues as they may introduce instability or breaking changes.

If you want an easy way to install and update Node, NVS - Node Version Switcher or NVM - Node Version Manager is recommended.

  • AutoRest v3 beta
    npm install -g autorest@beta
     
  • PowerShell 6.0 or greater
    • If you don't have it installed, you can use the cross-platform npm package
      npm install -g pwsh
       
  • .NET Core SDK 2.0 or greater
    • If you don't have it installed, you can use the cross-platform npm package
      npm install -g dotnet-sdk-2.2
       

Run Generation

In this directory, run AutoRest:

autorest

AutoRest Configuration

see https://aka.ms/autorest

commit: 68175b2c1a4eb91e3ca626a44e1608586fffbf4d
require:
  - $(this-folder)/../../readme.azure.noprofile.md
sanitize-names: true
subject-prefix: 'Wvd'
input-file:
- $(repo)/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2026-04-01-preview/desktopvirtualization.json

module-version: 2.1.0
title: DesktopVirtualizationClient

#v4 migration settings
keep-pec-and-plr: true
disable-transform-identity-type: true
flatten-userassignedidentity: false

directive:
  - where:
      verb: Update
      subject: Application
      parameter-name: Tag
    set:
      breaking-change:
        change-description: The parameter 'Tag' will be removed from the Update cmdlet of Application.
        deprecated-by-version: 6.0.0
        deprecated-by-azversion: 16.0.0
        change-effective-date: 2026/06/02
  - where:
      verb: Update
      subject: Desktop
      parameter-name: Tag
    set:
      breaking-change:
        change-description: The parameter 'Tag' will be removed from the Update cmdlet of Desktop.
        deprecated-by-version: 6.0.0
        deprecated-by-azversion: 16.0.0
        change-effective-date: 2026/06/02
  - where:
      variant: ^CreateViaIdentity.*$
    remove: true
  - where:
      verb: New
      subject: HostPool
      parameter-name: RegistrationInfoRegistrationTokenOperation
    set:
      parameter-name: RegistrationTokenOperation
  - where:
      verb: New
      subject: HostPool
      parameter-name: RegistrationInfoExpirationTime
    set:
      parameter-name: ExpirationTime
  - where:
      parameter-name: SubscriptionId
    set:
      default:
        script: '(Get-AzContext).Subscription.Id'
  - where:
      variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$|^Send$|^SendViaIdentity$
    remove: true
  - where:
      verb: Set
    remove: true
  - where:
      verb: Get
      subject: Operation
    remove: true
  - where:
      verb: Invoke
      subject: LevelApplicationGroupAssignment
    remove: true
  - where:
      verb: Get
      subject: ActiveApplication
    remove: true
  - where:
      verb: Remove
      subject: UserSession
      parameter-name: Force
    set:
      parameter-description: 'Specify to force userSession deletion.'
  - where:
      parameter-name: ProgressSessionHostsInProgress
    set:
      parameter-name: SessionHostsInProgress
  - where:
      verb: New
      subject: HostPool
    set:
      preview-announcement:
        preview-message: The IdentityType property is not currently supported and will be enabled in a future update.
  - where:
      verb: Update
      subject: HostPool
    set:
      preview-announcement:
        preview-message: The IdentityType property is not currently supported and will be enabled in a future update.
  - where:
      verb: Get
      subject: SessionHostProvisioningStatuses
    set:
      subject: SessionHostProvisioningStatus
  - where:
      verb: Invoke
      subject: ControlSessionHostProvisioning
    set:
      subject: CancelSessionHostProvisioning
  - where:
      verb: Invoke
      subject: CancelSessionHostProvisioning
      variant: ^Post$|^PostViaIdentity$
    remove: true
# remove Update-AzWvdPrivateEndpointConnection, Finally, we need to remove all private endpoint connection related cmdlets and implement them in Az.Network. Please see https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/examples/private-link-resource-example.md for details.  
  - where:
      verb: Update
      subject: PrivateEndpointConnection
    remove: true