Invoke-CPCPowerOff
SYNOPSIS
Powers off a Windows 365 Frontline Cloud PC
SYNTAX
Name (Default)
Invoke-CPCPowerOff -Name <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Id
Invoke-CPCPowerOff -CloudPCId <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
The function powers off a specific Windows 365 Frontline Cloud PC via the Microsoft Graph beta API. After the Cloud PC is powered off, it is deallocated and licenses are revoked immediately.
You can identify the target Cloud PC by its managed device name (default) or by providing the Cloud PC object ID directly via -CloudPCId.
Note: This action applies to Windows 365 Frontline Cloud PCs only. Only IT admin users can perform this action. Returns 204 No Content on success.
EXAMPLES
EXAMPLE 1
Invoke-CPCPowerOff -Name "CPC-User-XXXX"
EXAMPLE 2
Invoke-CPCPowerOff -CloudPCId "4b5ad5e0-6a0b-4ffc-818d-36bb23cf4dbd"
EXAMPLE 3
Invoke-CPCPowerOff -Name "CPC-User-XXXX" -WhatIf
PARAMETERS
-Name
The managed device name of the Cloud PC to power off. Use Get-CloudPC to find Cloud PC names. Mutually exclusive with -CloudPCId.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CloudPCId
The object ID (GUID) of the Cloud PC to power off. Use Get-CloudPC to find Cloud PC IDs. Mutually exclusive with -Name.
Type: String
Parameter Sets: Id
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
Requires CloudPC.ReadWrite.All permission (delegated or application). This action uses the Microsoft Graph beta endpoint. API reference: https://learn.microsoft.com/en-us/graph/api/cloudpc-poweroff