Get-MgUserPresence

Get a user's presence information.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserPresence

Syntax

Get-MgUserPresence
   -UserId <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgUserPresence
   -InputObject <ICloudCommunicationsIdentity>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get a user's presence information.

Examples

Example 1: Get your own presence information

Import-Module Microsoft.Graph.CloudCommunications

# A UPN can also be used as -UserId.
Get-MgUserPresence -UserId $userId

This example will get your own presence information

Example 2: Get the presence information of another user

Import-Module Microsoft.Graph.CloudCommunications

Get-MgUserPresence -UserId $userId

This example will get the presence information of another user

Parameters

-ExpandProperty

Expand related entities

Type:String[]
Aliases:Expand
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:ICloudCommunicationsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

Select properties to be returned

Type:String[]
Aliases:Select
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserId

The unique identifier of user

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.PowerShell.Models.ICloudCommunicationsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPresence

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ICloudCommunicationsIdentity>: Identity Parameter

  • [AttendanceRecordId <String>]: The unique identifier of attendanceRecord
  • [AudioRoutingGroupId <String>]: The unique identifier of audioRoutingGroup
  • [CallId <String>]: The unique identifier of call
  • [CallRecordId <String>]: The unique identifier of callRecord
  • [CallRecordingId <String>]: The unique identifier of callRecording
  • [CallTranscriptId <String>]: The unique identifier of callTranscript
  • [CommsOperationId <String>]: The unique identifier of commsOperation
  • [ContentSharingSessionId <String>]: The unique identifier of contentSharingSession
  • [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [ParticipantId <String>]: The unique identifier of participant
  • [PresenceId <String>]: The unique identifier of presence
  • [SessionId <String>]: The unique identifier of session
  • [UserId <String>]: The unique identifier of user