Invoke-RASAVDHost

NAME

Invoke-RASAVDHost

SYNOPSIS

The cmdlet invoke a command on an object of type Azure Virtual Desktop Host.

SYNTAX

Invoke-RASAVDHost [-InputObject] <AVDHost> [[-SiteId] <uint>] -Command {CancelSchedule} [<CommonParameters>]

Invoke-RASAVDHost [[-SiteId] <uint>] -Command {CancelSchedule} [-ProviderId <uint>] [<CommonParameters>]

Invoke-RASAVDHost [-VMId] <string> [[-SiteId] <uint>] -Command {CancelSchedule} -ProviderId <uint> [<CommonParameters>]

DESCRIPTION

The cmdlet invoke a command on an object of type Azure Virtual Desktop Host.

PARAMETERS

-VMId <string> The ID of the VM for which to retrieve the information.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProviderId <uint> Provider Id from which to retrieve the AVD Host.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the AVD Host.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHost> The AVD Host info object.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Command <AVDCommand> Command.

Accepted values: CancelSchedule.

Possible values: CancelSchedule

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

AVDHost

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Invoke-RASAVDHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 -Command CancelSchedule

Invokes CancelSchedule command on the AVD Host properties specified by the VMId and ProviderId. ---------- EXAMPLE 2 ----------

Invoke-RASAVDHost -ProviderID 1 -Command CancelSchedule

Invokes CancelSchedule command on all the AVD Hosts found within the Provider with Id 1.

Last updated

© 2024 Parallels International GmbH. All rights reserved.