Set-DSUserLicense

    2025-01-30

    Set-DSUserLicense

    SYNOPSIS

    Set the license assignments

    SYNTAX

    __AllParameterSets

    Set-DSUserLicense -InputObject <PSLicenseAssignmentInfo[]> [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Set the license assignments. To assign or unassign a user to a license, modify the IsMember field of the desired user.

    EXAMPLES

    EXAMPLE

    PS C:> $AsLegacyResponse = $true $licResponse = Get-DSLicence; $license = $licRespones.Data | Where -Property License -like XXXXX* | Select -First 1 $assignResponse = Get-DSUserLicense -InputObject $license $assignments = $assignResponse.Data $aUserAssignment = $asssignments | Where Name -eq 'Name of the user to assign' $aUserAssignment.IsMember = $true Set-DSUserLicense -InputObject $aUserAssignment

    Assign the license starting with XXXXX to the user 'Name of the user to assign'

    PARAMETERS

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -InputObject

    User assignements to a license obtained from Get-DSUserLicense

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseAssignmentInfo[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseAssignmentInfo

    Modified assignments obtained from Get-DSUserLicense

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.Private.ServerResponse

    NOTES

    For more information, type "Get-Help Set-DSUserLicense -detailed". For technical information, type "Get-Help Set-DSUserLicense -full".