virtualEvent resource type

Article
11/22/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents an abstract base type for a virtual event. Base type of virtualEventTownhall and virtualEventWebinar.

Inherits from entity.

Tip

This is an abstract type and can't be used directly. Use the derived types virtualEventTownhall or virtualEventWebinar instead.

Methods

Method	Return Type	Description
Set external event information	None	Link external event information to a virtualEventTownhall or virtualEventWebinar by setting an externalEventId. ]

Properties

Property	Type	Description
createdBy	communicationsIdentitySet	The identity information for the creator of the virtual event. Inherited from virtualEvent.
description	itemBody	A description of the virtual event.
displayName	String	The display name of the virtual event.
endDateTime	dateTimeTimeZone	The end time of the virtual event. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone.
externalEventInformation	virtualEventExternalInformation collection	The external information of a virtual event. Returned only for event organizers or coorganizers; otherwise, `null`.
id	String	The unique identifier of the virtual event. Inherited from entity.
settings	virtualEventSettings	The virtual event settings.
startDateTime	dateTimeTimeZone	Start time of the virtual event. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone.
status	virtualEventStatus	The status of the virtual event. The possible values are: `draft`, `published`, `canceled`, `unknownFutureValue`.

virtualEventStatus values

Value	Description
draft	The virtual event is in draft and only visible to the organizer.
published	The organizer published the virtual event and it's visible to the audience.
canceled	The organizer canceled the virtual event.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

Relationship	Type	Description
presenters	virtualEventPresenter collection	The virtual event presenters.
sessions	virtualEventSession collection	The sessions for the virtual event.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.virtualEvent",
  "createdBy": {"@odata.type": "microsoft.graph.communicationsIdentitySet"},
  "description": {"@odata.type": "microsoft.graph.itemBody"},
  "displayName": "String",
  "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "externalEventInformation" : [{"@odata.type": "microsoft.graph.virtualEventExternalInformation"}],
  "id": "String (identifier)",
  "settings": {"@odata.type": "microsoft.graph.virtualEventSettings"},
  "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "status": "String"
}

Share via