Stop-RDVirtualDesktopCollectionJob
Stops a job on a virtual desktop collection.
Syntax
Stop-RDVirtualDesktopCollectionJob
[-CollectionName] <String>
[-ConnectionBroker <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Stop-RDVirtualDesktopCollectionJob cmdlet forcibly ends a job that the server is currently running, or that is scheduled to run, on a virtual desktop collection. You can use the Get-RDVirtualDesktopCollectionJobStatus to get status information for the most recent job on a virtual desktop collection.
Examples
Example 1: Stop a virtual desktop collection job
PS C:\> Stop-RDVirtualDesktopCollectionJob -CollectionName "Virtual Desktop Pool" -ConnectionBroker "rdcb.contoso.com"
This command stops a job on the virtual desktop collection named "Virtual Desktop Pool" that is associated with the RD Connection Broker server named "rdcb.contoso.com".
Parameters
-CollectionName
Specifies the name of a virtual desktop collection.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionBroker
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Performs the action without a confirmation message.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for