命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示有关虚拟事件市政厅的信息。
继承自 virtualEvent。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | virtualEventTownhall 集合 | 获取在租户中创建的所有 virtualEventTownhall 对象的列表。 |
| 创建 | virtualEventTownhall | 创建新的 virtualEventTownhall 对象。 |
| Get | virtualEventTownhall | 读取 virtualEventTownhall 对象的属性和关系。 |
| 更新 | virtualEventTownhall | 更新 virtualEventTownhall 对象的属性。 |
| 发布 | 无 | 发布 virtualEventTownhall。 |
| Cancel | 无 | 取消 virtualEventTownhall。 |
| 按用户角色列出 | virtualEventTownhall 集合 | 获取 virtualEventTownhall 对象的列表,其中已登录用户是组织者或协同组织者。 |
| 按用户 ID 和角色列出 | virtualEventTownhall 集合 | 获取 虚拟EventTownhall 对象的列表,其中指定的用户是组织者或协同组织者。 |
| 设置外部事件信息 | 无 | 通过设置 externalEventId,将外部事件信息链接到 virtualEventTownhall 或 virtualEventWebinar。 ] |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| 观众 | meetingAudience | 市政厅可见的观众。 可能的值包括 everyone、organization、unknownFutureValue。 |
| coOrganizers | communicationsUserIdentity 集合 | 市政厅的协组织者的身份信息。 |
| createdBy | communicationsIdentitySet | 市政厅的创建者的标识信息。 继承自 virtualEvent。 只读。 |
| description | itemBody | 市政厅的说明。 继承自 virtualEvent。 |
| displayName | String | 市政厅的显示名称。 继承自 virtualEvent。 |
| endDateTime | dateTimeTimeZone | 市政厅结束的日期和时间。 timeZone 属性可以设置为 Windows 当前支持的任何时区。 有关如何使用 PowerShell 获取所有可用时区的详细信息,请参阅 Get-TimeZone。 继承自 virtualEvent。 |
| externalEventInformation | virtualEventExternalInformation 集合 | 市政厅的外部信息。 仅对活动组织者或协办者返回;否则为 null。 |
| id | String | 市政厅的唯一标识符。 继承自 virtualEvent。 只读。 |
| invitedAttendees | identity 集合 | 应邀到市政厅的与会者。 支持的标识包括: communicationsUserIdentity 和 communicationsGuestIdentity。 |
| isInviteOnly | 布尔值 | 指示市政厅是否仅对组织内的受邀人员和组开放。
isInviteOnly 属性仅当true访问群体属性的值设置为 时,才能使用 organization。 |
| settings | virtualEventSettings | 市政厅设置。 继承自 virtualEvent。 |
| startDateTime | dateTimeTimeZone | 市政厅开始的日期和时间。 timeZone 属性可以设置为 Windows 当前支持的任何时区。 有关如何使用 PowerShell 获取所有可用时区的详细信息,请参阅 Get-TimeZone。 继承自 virtualEvent。 |
| status | virtualEventStatus | 市政厅的状态。 可能的值包括 draft、published、canceled、unknownFutureValue。 继承自 virtualEvent。 |
meetingAudience 值
| 值 | 说明 |
|---|---|
| 每个人 都 | 市政厅对任何人开放。 选择此选项可包括组织外部的与会者。 |
| 组织 | 市政厅对组织中的人员和组织的来宾开放。 |
| unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
virtualEventStatus 值
| 值 | 说明 |
|---|---|
| 草案 | 虚拟事件处于草稿状态,仅对组织者可见。 |
| 发表 | 组织者发布了虚拟活动,该活动对观众可见。 |
| 取消 | 组织者取消了虚拟活动。 |
| unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| 主持人 | virtualEventPresenter 集合 | 演示者对市政厅的信息。 继承自 virtualEvent。 |
| sessions | virtualEventSession 集合 | 市政厅的会议。 继承自 virtualEvent。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@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"},
"externalEventInformation" : [{"@odata.type": "microsoft.graph.virtualEventExternalInformation"}],
"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"
}