Get-MgUserOnlineMeeting
Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
Note
To view the beta release of this cmdlet, view Get-MgBetaUserOnlineMeeting
Syntax
Get-MgUserOnlineMeeting
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ChatInfo <IMicrosoftGraphChatInfo>]
[-EndDateTime <DateTime>]
[-ExternalId <String>]
[-Participants <IMicrosoftGraphMeetingParticipants>]
[-StartDateTime <DateTime>]
[-Subject <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-OnlineMeetingId <String>
-UserId <String>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-UserId <String>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-Filter <String>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-UserId <String>
[-ResponseHeadersVariable <String>]
-BodyParameter <IPaths1H47062UsersUserIdOnlinemeetingsMicrosoftGraphCreateorgetPostRequestbodyContentApplicationJsonSchema>
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-InputObject <ICloudCommunicationsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ChatInfo <IMicrosoftGraphChatInfo>]
[-EndDateTime <DateTime>]
[-ExternalId <String>]
[-Participants <IMicrosoftGraphMeetingParticipants>]
[-StartDateTime <DateTime>]
[-Subject <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-InputObject <ICloudCommunicationsIdentity>
[-ResponseHeadersVariable <String>]
-BodyParameter <IPaths1H47062UsersUserIdOnlinemeetingsMicrosoftGraphCreateorgetPostRequestbodyContentApplicationJsonSchema>
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-MgUserOnlineMeeting
-InputObject <ICloudCommunicationsIdentity>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | OnlineMeetings.Read, OnlineMeetings.ReadWrite, |
| Delegated (personal Microsoft account) | Not supported |
| Application | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All, |
Examples
Example 1: Retrieve an online meeting by meeting ID
Import-Module Microsoft.Graph.CloudCommunications
# A UPN can also be used as -UserId.
Get-MgUserOnlineMeeting -UserId $userId -OnlineMeetingId $onlineMeetingIdThis example will retrieve an online meeting by meeting id
Example 2: Retrieve an online meeting by joinWebUrl
Import-Module Microsoft.Graph.CloudCommunications
# A UPN can also be used as -UserId.
Get-MgUserOnlineMeeting -UserId $userId -Filter "JoinWebUrl eq 'https://teams.microsoft.com/l/meetup-join/19:meeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkM2EtZWVkODYxODYzMmY2@thread.v2/0?context"This example will retrieve an online meeting by joinweburl
Example 3: Retrieve an online meeting by joinMeetingId
Import-Module Microsoft.Graph.CloudCommunications
# A UPN can also be used as -UserId.
Get-MgUserOnlineMeeting -UserId $userId -Filter "joinMeetingIdSettings/joinMeetingId eq '1234567890'"This example will retrieve an online meeting by joinmeetingid
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-All
List all pages.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| 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: | IPaths1H47062UsersUserIdOnlinemeetingsMicrosoftGraphCreateorgetPostRequestbodyContentApplicationJsonSchema |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ChatInfo
chatInfo To construct, see NOTES section for CHATINFO properties and create a hash table.
| Type: | IMicrosoftGraphChatInfo |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
| Type: | String |
| Aliases: | CV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndDateTime
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
| Type: | String[] |
| Aliases: | Expand |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExternalId
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Filter items by property values
| Type: | String |
| 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 |
-OnlineMeetingId
The unique identifier of onlineMeeting
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PageSize
Sets the page size of results.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Participants
meetingParticipants To construct, see NOTES section for PARTICIPANTS properties and create a hash table.
| Type: | IMicrosoftGraphMeetingParticipants |
| Position: | Named |
| Default value: | None |
| 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 |
-Property
Select properties to be returned
| Type: | String[] |
| Aliases: | Select |
| 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 |
-Search
Search items by search phrases
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skip the first n items
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sort
Order items by property values
| Type: | String[] |
| Aliases: | OrderBy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartDateTime
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Subject
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
Show only the first n items
| Type: | Int32 |
| Aliases: | Limit |
| Position: | Named |
| Default value: | 0 |
| 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.ICloudCommunicationsIdentity
Microsoft.Graph.PowerShell.Models.IPaths1H47062UsersUserIdOnlinemeetingsMicrosoftGraphCreateorgetPostRequestbodyContentApplicationJsonSchema
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOnlineMeeting
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 <IPaths1H47062UsersUserIdOnlinemeetingsMicrosoftGraphCreateorgetPostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.[ChatInfo <IMicrosoftGraphChatInfo>]: chatInfo[(Any) <Object>]: This indicates any property can be added to this object.[MessageId <String>]: The unique identifier of a message in a Microsoft Teams channel.[ReplyChainMessageId <String>]: The ID of the reply message.[ThreadId <String>]: The unique identifier for a thread in Microsoft Teams.
[EndDateTime <DateTime?>]:[ExternalId <String>]:[Participants <IMicrosoftGraphMeetingParticipants>]: meetingParticipants[(Any) <Object>]: This indicates any property can be added to this object.[Attendees <IMicrosoftGraphMeetingParticipantInfo-[]>]: Information about the meeting attendees.[Identity <IMicrosoftGraphIdentitySet>]: identitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[Role <String>]: onlineMeetingRole[Upn <String>]: User principal name of the participant.
[Organizer <IMicrosoftGraphMeetingParticipantInfo>]: meetingParticipantInfo
[StartDateTime <DateTime?>]:[Subject <String>]:
CHATINFO <IMicrosoftGraphChatInfo>: chatInfo
[(Any) <Object>]: This indicates any property can be added to this object.[MessageId <String>]: The unique identifier of a message in a Microsoft Teams channel.[ReplyChainMessageId <String>]: The ID of the reply message.[ThreadId <String>]: The unique identifier for a thread in Microsoft Teams.
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[MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport[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[UserId <String>]: The unique identifier of user
PARTICIPANTS <IMicrosoftGraphMeetingParticipants>: meetingParticipants
[(Any) <Object>]: This indicates any property can be added to this object.[Attendees <IMicrosoftGraphMeetingParticipantInfo-[]>]: Information about the meeting attendees.[Identity <IMicrosoftGraphIdentitySet>]: identitySet[(Any) <Object>]: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]: identity[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]: identity[User <IMicrosoftGraphIdentity>]: identity
[Role <String>]: onlineMeetingRole[Upn <String>]: User principal name of the participant.
[Organizer <IMicrosoftGraphMeetingParticipantInfo>]: meetingParticipantInfo