Clear-MgBetaUserPresence

Module:

Microsoft.Graph.Beta.CloudCommunications

Clear a presence session of an application for a user. If it is the user's only presence session, a successful clearPresence changes the user's presence to Offline/Offline. Read more about presence sessions and their time-out and expiration.

Note

To view the v1.0 release of this cmdlet, view Clear-MgUserPresence

Syntax

Clear-MgBetaUserPresence
     -UserId <String>
     [-ResponseHeadersVariable <String>]
     [-AdditionalProperties <Hashtable>]
     [-SessionId <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Clear-MgBetaUserPresence
     -UserId <String>
     -BodyParameter <IPathsTdagveUsersUserIdPresenceMicrosoftGraphClearpresencePostRequestbodyContentApplicationJsonSchema>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Clear-MgBetaUserPresence
     -InputObject <ICloudCommunicationsIdentity>
     [-ResponseHeadersVariable <String>]
     [-AdditionalProperties <Hashtable>]
     [-SessionId <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Clear-MgBetaUserPresence
     -InputObject <ICloudCommunicationsIdentity>
     -BodyParameter <IPathsTdagveUsersUserIdPresenceMicrosoftGraphClearpresencePostRequestbodyContentApplicationJsonSchema>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Clear a presence session of an application for a user. If it is the user's only presence session, a successful clearPresence changes the user's presence to Offline/Offline. Read more about presence sessions and their time-out and expiration.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Presence.ReadWrite,
Delegated (personal Microsoft account)	Not supported
Application	Presence.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.CloudCommunications

$params = @{
	sessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87"
}

Clear-MgBetaUserPresence -UserId $userId -BodyParameter $params

This example shows how to use the Clear-MgBetaUserPresence Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-BodyParameter

To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPathsTdagveUsersUserIdPresenceMicrosoftGraphClearpresencePostRequestbodyContentApplicationJsonSchema
Position:	Named
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:	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

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
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

-ResponseHeadersVariable

Optional Response Headers Variable.

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

-SessionId

Type:	String
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.ICloudCommunicationsIdentity

Microsoft.Graph.Beta.PowerShell.Models.IPathsTdagveUsersUserIdPresenceMicrosoftGraphClearpresencePostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

System.Boolean

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.

BODYPARAMETER <IPathsTdagveUsersUserIdPresenceMicrosoftGraphClearpresencePostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [SessionId <String>]:

INPUTOBJECT <ICloudCommunicationsIdentity>: Identity Parameter

• [AttendanceRecordId <String>]: The unique identifier of attendanceRecord
• [AudioRoutingGroupId <String>]: The unique identifier of audioRoutingGroup
• [CallAiInsightId <String>]: The unique identifier of callAiInsight
• [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
• [FromDateTime <DateTime?>]: Usage: fromDateTime={fromDateTime}
• [JoinWebUrl <String>]: Alternate key of onlineMeeting
• [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
• [MeetingRegistrantBaseId <String>]: The unique identifier of meetingRegistrantBase
• [MeetingRegistrationQuestionId <String>]: The unique identifier of meetingRegistrationQuestion
• [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
• [ToDateTime <DateTime?>]: Usage: toDateTime={toDateTime}
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.cloudcommunications/clear-mgbetauserpresence
• https://learn.microsoft.com/graph/api/presence-clearpresence?view=graph-rest-beta