virtualEventTownhall resource type
Namespace: microsoft.graph
Represents information about a virtual event town hall.
Inherits from virtualEvent.
Methods
| Method | Return type | Description |
|---|---|---|
| Create | virtualEventTownhall | Create a new virtualEventTownhall object. |
| Get | virtualEventTownhall | Read the properties and relationships of a virtualEventTownhall object. |
| Update | virtualEventTownhall | Update the properties of a virtualEventTownhall object. |
| Publish | None | Publish a virtualEventTownhall. |
| Cancel | None | Cancel a virtualEventTownhall. |
Roles required to act on virtualEventTownhall objects
The following table shows the roles that can perform various actions on virtual event town halls.
| Role | Create | Get | Update | Publish | Cancel |
|---|---|---|---|---|---|
| Organizer | ✅ | ✅ | ✅ | ✅ | ✅ |
| Co-organizer | ❌ | ✅ | ✅ | ❌ | ❌ |
| Presenter | ❌ | ✅ | ❌ | ❌ | ❌ |
| Attendee | ❌ | ✅ | ❌ | ❌ | ❌ |
| Custom application | ❌ | ✅ | ❌ | ❌ | ❌ |
Properties
| Property | Type | Description |
|---|---|---|
| audience | meetingAudience | The audience to whom the town hall is visible. Possible values are: everyone, organization, and unknownFutureValue. |
| coOrganizers | communicationsUserIdentity collection | Identity information of the coorganizers of the town hall. |
| createdBy | communicationsIdentitySet | Identity information of the creator of the town hall. Inherited from virtualEvent. Read-only. |
| description | itemBody | Description of the town hall. Inherited from virtualEvent. |
| displayName | String | Display name of the town hall. Inherited from virtualEvent. |
| endDateTime | dateTimeTimeZone | Date and time when the town hall ends. 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. Inherited from virtualEvent. |
| id | String | Unique identifier of the town hall. Inherited from entity. Read-only. |
| invitedAttendees | identity collection | The attendees invited to the town hall. The supported identities are: communicationsUserIdentity and communicationsGuestIdentity. |
| isInviteOnly | Boolean | Indicates whether the town hall is only open to invited people and groups within your organization. The isInviteOnly property can only be true if the value of the audience property is set to organization. |
| settings | virtualEventSettings | The virtual event settings. |
| startDateTime | dateTimeTimeZone | Date and time when the town hall starts. 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. Inherited from virtualEvent. |
| status | virtualEventStatus | Status of the town hall. Possible values are: draft, published, canceled, and unknownFutureValue. Inherited from virtualEvent. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| presenters | virtualEventPresenter collection | Presenters' information of the town hall. Inherited from virtualEvent. |
| sessions | virtualEventSession collection | Sessions of the town hall. Inherited from virtualEvent. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.virtualEventTownhall",
"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)",
"invitedAttendees": [{"@odata.type": "microsoft.graph.identity"}],
"isInviteOnly": "Boolean",
"settings": {"@odata.type": "microsoft.graph.virtualEventSettings"},
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"status": "String"
}