Update-MgBetaCommunicationPresence

Update the navigation property presences in communications

Note

To view the v1.0 release of this cmdlet, view Update-MgCommunicationPresence

Syntax

Update-MgBetaCommunicationPresence
      -PresenceId <String>
      [-ResponseHeadersVariable <String>]
      [-Activity <String>]
      [-AdditionalProperties <Hashtable>]
      [-Availability <String>]
      [-Id <String>]
      [-OutOfOfficeSettings <IMicrosoftGraphOutOfOfficeSettings>]
      [-StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaCommunicationPresence
      -PresenceId <String>
      -BodyParameter <IMicrosoftGraphPresence>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaCommunicationPresence
      -InputObject <ICloudCommunicationsIdentity>
      [-ResponseHeadersVariable <String>]
      [-Activity <String>]
      [-AdditionalProperties <Hashtable>]
      [-Availability <String>]
      [-Id <String>]
      [-OutOfOfficeSettings <IMicrosoftGraphOutOfOfficeSettings>]
      [-StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaCommunicationPresence
      -InputObject <ICloudCommunicationsIdentity>
      -BodyParameter <IMicrosoftGraphPresence>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the navigation property presences in communications

Parameters

-Activity

The supplemental information to a user's availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.

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

The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.

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

-BodyParameter

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

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

-Id

The unique identifier for an entity. Read-only.

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

-OutOfOfficeSettings

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

Type:IMicrosoftGraphOutOfOfficeSettings
Position:Named
Default value:None
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

-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

-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.IMicrosoftGraphPresence

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.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.

BODYPARAMETER <IMicrosoftGraphPresence>: presence

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Activity <String>]: The supplemental information to a user's availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.
  • [Availability <String>]: The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.
  • [OutOfOfficeSettings <IMicrosoftGraphOutOfOfficeSettings>]: outOfOfficeSettings
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [IsOutOfOffice <Boolean?>]: True if either:It is currently in the out of office time window configured on the Outlook or Teams client.There is currently an event on the user's calendar that's marked as Show as Out of OfficeOtherwise, false.
    • [Message <String>]: The out of office message that the user configured on Outlook client (Automatic Replies (Out of Office)) or the Teams client (Schedule out of office).
  • [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
  • [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

OUTOFOFFICESETTINGS <IMicrosoftGraphOutOfOfficeSettings>: outOfOfficeSettings

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [IsOutOfOffice <Boolean?>]: True if either:It is currently in the out of office time window configured on the Outlook or Teams client.There is currently an event on the user's calendar that's marked as Show as Out of OfficeOtherwise, false.
  • [Message <String>]: The out of office message that the user configured on Outlook client (Automatic Replies (Out of Office)) or the Teams client (Schedule out of office).

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.