Set-MgBetaUserPresenceStatusMessage

Module:

Microsoft.Graph.Beta.CloudCommunications

Set a presence status message for a user. An optional expiration date and time can be supplied.

Note

To view the v1.0 release of this cmdlet, view Set-MgUserPresenceStatusMessage

Syntax

Set-MgBetaUserPresenceStatusMessage
   -UserId <String>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserPresenceStatusMessage
   -UserId <String>
   -BodyParameter <IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserPresenceStatusMessage
   -InputObject <ICloudCommunicationsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserPresenceStatusMessage
   -InputObject <ICloudCommunicationsIdentity>
   -BodyParameter <IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set a presence status message for a user. An optional expiration date and time can be supplied.

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: Set status message with expiry date

Import-Module Microsoft.Graph.Beta.CloudCommunications

$params = @{
	statusMessage = @{
		message = @{
			content = "Hey I'm currently in a meeting."
			contentType = "text"
		}
		expiryDateTime = @{
			dateTime = "2022-10-18T17:05:33.2079781"
			timeZone = "Pacific Standard Time"
		}
	}
}

Set-MgBetaUserPresenceStatusMessage -UserId $userId -BodyParameter $params

This example will set status message with expiry date

Example 2: Set status message of another user

Import-Module Microsoft.Graph.Beta.CloudCommunications

$params = @{
	statusMessage = @{
		message = @{
			content = "Hey I am available now"
			contentType = "text"
		}
	}
}

Set-MgBetaUserPresenceStatusMessage -UserId $userId -BodyParameter $params

This example will set status message of another user

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:	IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema
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

-StatusMessage

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

Type:	IMicrosoftGraphPresenceStatusMessage
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.IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema

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 <IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [StatusMessage <IMicrosoftGraphPresenceStatusMessage>]: presenceStatusMessage
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ExpiryDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.
    • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
  • [Message <IMicrosoftGraphItemBody>]: itemBody
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Content <String>]: The content of the item.
    • [ContentType <String>]: bodyType
  • [PublishedDateTime <DateTime?>]: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.

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

STATUSMESSAGE <IMicrosoftGraphPresenceStatusMessage>: presenceStatusMessage

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ExpiryDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.
  • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
• [Message <IMicrosoftGraphItemBody>]: itemBody
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Content <String>]: The content of the item.
  • [ContentType <String>]: bodyType
• [PublishedDateTime <DateTime?>]: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.cloudcommunications/set-mgbetauserpresencestatusmessage
• https://learn.microsoft.com/graph/api/presence-setstatusmessage?view=graph-rest-beta