Set-MgUserPresenceStatusMessage

Reference

Module:: Microsoft.Graph.Users.Actions

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

Note

To view the beta release of this cmdlet, view Set-MgBetaUserPresenceStatusMessage

Syntax

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

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

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

Set-MgUserPresenceStatusMessage
   -InputObject <IUsersActionsIdentity>
   -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	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Presence.ReadWrite	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Presence.ReadWrite.All	Not available.

Examples

Example 1: Set status message with expiry date

Import-Module Microsoft.Graph.Users.Actions

$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-MgUserPresenceStatusMessage -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.Users.Actions

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

Set-MgUserPresenceStatusMessage -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:	IUsersActionsIdentity
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

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.PowerShell.Models.IPathsDovi6RUsersUserIdPresenceMicrosoftGraphSetstatusmessagePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

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, 2017-08-29T04:00:00.0000000).
  - [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more 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 <IUsersActionsIdentity>: Identity Parameter

[AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
[CalendarId <String>]: The unique identifier of calendar
[ChatId <String>]: The unique identifier of chat
[ChatMessageId <String>]: The unique identifier of chatMessage
[ChatMessageId1 <String>]: The unique identifier of chatMessage
[ContentTypeId <String>]: The unique identifier of contentType
[DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
[DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
[DriveId <String>]: The unique identifier of drive
[DriveItemId <String>]: The unique identifier of driveItem
[DriveItemVersionId <String>]: The unique identifier of driveItemVersion
[EventId <String>]: The unique identifier of event
[EventId1 <String>]: The unique identifier of event
[ListItemId <String>]: The unique identifier of listItem
[ListItemVersionId <String>]: The unique identifier of listItemVersion
[MailFolderId <String>]: The unique identifier of mailFolder
[MailFolderId1 <String>]: The unique identifier of mailFolder
[ManagedDeviceId <String>]: The unique identifier of managedDevice
[MessageId <String>]: The unique identifier of message
[NotebookId <String>]: The unique identifier of notebook
[OnenotePageId <String>]: The unique identifier of onenotePage
[OnenoteSectionId <String>]: The unique identifier of onenoteSection
[OnlineMeetingId <String>]: The unique identifier of onlineMeeting
[PermissionId <String>]: The unique identifier of permission
[PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod
[SubscriptionId <String>]: The unique identifier of subscription
[TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
[TodoTaskId <String>]: The unique identifier of todoTask
[TodoTaskListId <String>]: The unique identifier of todoTaskList
[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, 2017-08-29T04:00:00.0000000).
- [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more 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.

Share via

Set-MgUserPresenceStatusMessage

Syntax

Description

Examples

Example 1: Set status message with expiry date

Example 2: Set status message of another user

Parameters

-AdditionalProperties

-BodyParameter

-Confirm

-Headers

-InputObject

-PassThru

-ProgressAction

-ResponseHeadersVariable

-StatusMessage

-UserId

-WhatIf

Inputs

Outputs

Notes

Additional resources

Share via

Set-MgUserPresenceStatusMessage

Syntax

Description

Examples

Example 1: Set status message with expiry date

Example 2: Set status message of another user

Parameters

-AdditionalProperties

-BodyParameter

-Confirm

-Headers

-InputObject

-PassThru

-ProgressAction

-ResponseHeadersVariable

-StatusMessage

-UserId

-WhatIf

Inputs

Outputs

Notes

Related Links

Additional resources