Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl

Module:

Microsoft.Graph.CloudCommunications Module

Get a join web URL for a Microsoft 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 beta release of this cmdlet, view Get-MgBetaUserOnlineMeetingVirtualAppointmentJoinWebUrl

Syntax

Get (Default)

Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl
    -OnlineMeetingId <string>
    -UserId <string>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity

Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl
    -InputObject <ICloudCommunicationsIdentity>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Description

Get a join web URL for a Microsoft 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	Permissions (from least to most privileged)
Delegated (work or school account)	VirtualAppointment.Read, OnlineMeetings.Read, OnlineMeetings.ReadWrite, VirtualAppointment.ReadWrite,
Delegated (personal Microsoft account)	Not supported
Application	VirtualAppointment.Read.All, VirtualAppointment.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.CloudCommunications

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

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

Parameters

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.ICloudCommunicationsIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OnlineMeetingId

The unique identifier of onlineMeeting

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UserId

The unique identifier of user

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.ICloudCommunicationsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

System.String

{{ Fill in the Description }}

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 <ICloudCommunicationsIdentity>: Identity Parameter [AdhocCallId <String>]: The unique identifier of adhocCall [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 [EngagementConversationMessageId <String>]: The unique identifier of engagementConversationMessage [EngagementConversationMessageId1 <String>]: The unique identifier of engagementConversationMessage [EngagementConversationMessageReactionId <String>]: The unique identifier of engagementConversationMessageReaction [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport [OnlineMeetingEngagementConversationId <String>]: The unique identifier of onlineMeetingEngagementConversation [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

Related Links

• Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl
• Graph API Reference