Edit

Share via

virtualEventWebinar resource type

  • Article

Namespace: microsoft.graph

Contains information about a virtual event webinar.

Inherits from virtualEvent.

Methods

Method Return Type Description
List virtualEventWebinar collection Get the list of all virtualEventWebinar objects created in a tenant.
Create virtualEventWebinar Create a virtualEventWebinar object.
Get virtualEventWebinar Read the properties and relationships of a virtualEventWebinar object.
Update virtualEventWebinar Update the properties of a virtualEventWebinar object.
Publish None Publish a virtualEventWebinar.
Cancel None Cancel a virtualEventWebinar.
List by user role virtualEventWebinar collection Get a virtualEventWebinar collection where the signed-in user is either the organizer or a coorganizer.
List by user ID and role virtualEventWebinar collection Get a virtualEventWebinar collection where the specified user is either the organizer or a coorganizer.

Roles required to act on virtualEventWebinar objects

The following table shows the roles that can perform various actions on webinars.

Role Create Get Update Publish Cancel List in org List by user role List by user ID & role
Organizer ✅ ✅ ✅ ✅ ✅ ❌ ✅ ❌
Co-organizer ❌ ✅ ✅ ❌ ❌ ❌ ✅ ❌
Presenter ❌ ✅ ❌ ❌ ❌ ❌ ✅ ❌
Attendee ❌ ✅ ❌ ❌ ❌ ❌ ✅ ❌
Custom application ❌ ✅ ❌ ❌ ❌ ✅ ❌ ✅

Properties

Property Type Description
audience meetingAudience To whom the webinar is visible. Possible values are: everyone, organization, and unknownFutureValue.
coOrganizers communicationsUserIdentity collection Identity information of coorganizers of the webinar.
createdBy communicationsIdentitySet Identity information for the creator of the webinar. Inherited from virtualEvent.
description itemBody Description of the webinar. Inherited from virtualEvent.
displayName String Display name of the webinar. Inherited from virtualEvent.
endDateTime dateTimeTimeZone End time of the webinar. 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.
startDateTime dateTimeTimeZone Start time of the webinar. 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.
id String Unique identifier of the webinar. Inherited from entity.
settings virtualEventSettings The webinar settings. Inherited from virtualEvent.
status virtualEventStatus Status of the webinar. Possible values are: draft, published, canceled, and unknownFutureValue. Inherited from virtualEvent.

Relationships

Relationship Type Description
registrationConfiguration virtualEventWebinarRegistrationConfiguration Registration configuration of the webinar.
registrations virtualEventRegistration collection Registration records of the webinar.
sessions virtualEventSession collection Sessions of the webinar. Inherited from virtualEvent.

JSON representation

The following JSON representation shows the resource type.

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

Related content

List meetingAttendanceReports