Share via

Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl

  • Reference
Module:
Microsoft.Graph.Beta.Users.Functions

Get a join web URL for a Teams Virtual Appointment. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics.

Note

To view the v1.0 release of this cmdlet, view Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl

Syntax

Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl
   -OnlineMeetingId <String>
   -UserId <String>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl
   -InputObject <IUsersFunctionsIdentity>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get a join web URL for a Teams Virtual Appointment. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) VirtualAppointment.Read OnlineMeetings.Read, OnlineMeetings.ReadWrite, VirtualAppointment.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Users.Functions

# A UPN can also be used as -UserId.
Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl -UserId $userId -OnlineMeetingId $onlineMeetingId

This example shows how to use the Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl Cmdlet.

Parameters

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

-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

-UserId

The unique identifier of user

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

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IUsersFunctionsIdentity

System.Collections.IDictionary

Outputs

System.String

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.

INPUTOBJECT <IUsersFunctionsIdentity>: Identity Parameter

  • [AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance
  • [AppConsentRequestId <String>]: The unique identifier of appConsentRequest
  • [CalendarId <String>]: The unique identifier of calendar
  • [ChatId <String>]: The unique identifier of chat
  • [ChatMessageId <String>]: The unique identifier of chatMessage
  • [CloudPcId <String>]: The unique identifier of cloudPC
  • [ContactFolderId <String>]: The unique identifier of contactFolder
  • [ContactFolderId1 <String>]: The unique identifier of contactFolder
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
  • [EventId <String>]: The unique identifier of event
  • [GroupId <String>]: Usage: groupId='{groupId}'
  • [IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks}
  • [Interval <String>]: Usage: interval='{interval}'
  • [JoinWebUrl <String>]: Alternate key of onlineMeeting
  • [ListItemId <String>]: The unique identifier of listItem
  • [MailFolderId <String>]: The unique identifier of mailFolder
  • [MailFolderId1 <String>]: The unique identifier of mailFolder
  • [ManagedDeviceId <String>]: The unique identifier of managedDevice
  • [On <String>]: Usage: on='{on}'
  • [OnenotePageId <String>]: The unique identifier of onenotePage
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [PlannerBucketId <String>]: The unique identifier of plannerBucket
  • [PlannerPlanId <String>]: The unique identifier of plannerPlan
  • [Q <String>]: Usage: q='{q}'
  • [RoomList <String>]: Usage: RoomList='{RoomList}'
  • [ServicePlanId <String>]: Usage: servicePlanId='{servicePlanId}'
  • [Skip <Int32?>]: Usage: skip={skip}
  • [StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
  • [TimeZoneStandard <String>]: Usage: TimeZoneStandard='{TimeZoneStandard}'
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [Token <String>]: Usage: token='{token}'
  • [Top <Int32?>]: Usage: top={top}
  • [Upn <String>]: Usage: upn='{upn}'
  • [User <String>]: Usage: User='{User}'
  • [UserId <String>]: The unique identifier of user