virtualEventWebinar resource type
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.
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. |
| Set external event information | None | Link external event information to a virtualEventTownhall or virtualEventWebinar by setting an externalEventId. ] |
Properties
| Property | Type | Description |
|---|---|---|
| audience | meetingAudience | To whom the webinar is visible. |
| 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. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a webinar. Returned only for event organizers or coorganizers; otherwise, null. |
| id | String | Unique identifier of the webinar. Inherited from virtualEvent. |
| settings | virtualEventSettings | The webinar settings. Inherited from virtualEvent. |
| 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. |
| status | virtualEventStatus | Status of the webinar. |
meetingAudience values
| Value | Description |
|---|---|
| everyone | The webinar is a public webinar. A public webinar is visible to everyone. |
| organization | The webinar is a private webinar. A private webinar is visible only within the same organization as the organizer. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
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 |
|---|---|---|
| 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"},
"externalEventInformation" : [{"@odata.type": "microsoft.graph.virtualEventExternalInformation"}],
"id": "String (identifier)",
"settings": {"@odata.type": "microsoft.graph.virtualEventSettings"},
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"status": "String"
}