Get-CPCRealTimeConnectionStatus

SYNOPSIS

Retrieves the real-time remote connection status for a specific Cloud PC

SYNTAX

Name (Default)

Get-CPCRealTimeConnectionStatus -Name <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Get-CPCRealTimeConnectionStatus -CloudPCId <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The function retrieves live connection status for a specific Cloud PC using the Microsoft Graph beta cloudPcReports getRealTimeRemoteConnectionStatus API.

Unlike Get-CPCConnectivityHistory (which shows historical events), this function returns the current state: whether a user is actively signed in, how long the session has been running, and days since last use. Useful for live helpdesk troubleshooting and monitoring dashboards.

You can identify the target Cloud PC by its managed device name (default) or by providing the Cloud PC object ID directly via -CloudPCId.

EXAMPLES

EXAMPLE 1

Get-CPCRealTimeConnectionStatus -Name "CPC-User-XXXX"

EXAMPLE 2

Get-CPCRealTimeConnectionStatus -CloudPCId "4b5ad5e0-6a0b-4ffc-818d-36bb23cf4dbd"

PARAMETERS

-Name

The managed device name of the Cloud PC. 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. 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

-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.Read.All or CloudPC.ReadWrite.All permission (delegated or application). This function uses the Microsoft Graph beta endpoint. API reference: https://learn.microsoft.com/en-us/graph/api/cloudpcreports-getrealtimeremoteconnectionstatus?view=graph-rest-beta

RELATED LINKS