Set-MgBetaCommunicationPresenceUserPreferredPresence
Set the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence is the preferred presence. Preferred presence takes effect only when there is at least one presence session of the user. Otherwise, the user's presence stays as Offline. A presence session can be created as a result of a successful setPresence operation, or if the user is signed in on a Teams client. Read more about presence sessions and their time-out and expiration.
Note
To view the v1.0 release of this cmdlet, view Set-MgCommunicationPresenceUserPreferredPresence
Syntax
Set-MgBetaCommunicationPresenceUserPreferredPresence
-PresenceId <String>
[-ResponseHeadersVariable <String>]
[-Activity <String>]
[-AdditionalProperties <Hashtable>]
[-Availability <String>]
[-ExpirationDuration <TimeSpan>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-MgBetaCommunicationPresenceUserPreferredPresence
-PresenceId <String>
-BodyParameter <IPaths16OmbuoCommunicationsPresencesPresenceIdMicrosoftGraphSetuserpreferredpresencePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-MgBetaCommunicationPresenceUserPreferredPresence
-InputObject <ICloudCommunicationsIdentity>
[-ResponseHeadersVariable <String>]
[-Activity <String>]
[-AdditionalProperties <Hashtable>]
[-Availability <String>]
[-ExpirationDuration <TimeSpan>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-MgBetaCommunicationPresenceUserPreferredPresence
-InputObject <ICloudCommunicationsIdentity>
-BodyParameter <IPaths16OmbuoCommunicationsPresencesPresenceIdMicrosoftGraphSetuserpreferredpresencePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Set the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence is the preferred presence. Preferred presence takes effect only when there is at least one presence session of the user. Otherwise, the user's presence stays as Offline. A presence session can be created as a result of a successful setPresence operation, or if the user is signed in on a Teams client. Read more about presence sessions and their time-out and expiration.
Parameters
-Activity
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Availability
.
| Type: | String |
| 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: | IPaths16OmbuoCommunicationsPresencesPresenceIdMicrosoftGraphSetuserpreferredpresencePostRequestbodyContentApplicationJsonSchema |
| 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 |
-ExpirationDuration
.
| Type: | TimeSpan |
| 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 |
-PresenceId
The unique identifier of presence
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-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.IPaths16OmbuoCommunicationsPresencesPresenceIdMicrosoftGraphSetuserpreferredpresencePostRequestbodyContentApplicationJsonSchema
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 <IPaths16OmbuoCommunicationsPresencesPresenceIdMicrosoftGraphSetuserpreferredpresencePostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.[Activity <String>]:[Availability <String>]:[ExpirationDuration <TimeSpan?>]:
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[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