virtualEvent 资源类型

命名空间:microsoft.graph

表示虚拟事件的抽象基类型。 virtualEventTownhall 和 virtualEventWebinar 的基本类型。

继承自 entity。

提示

这是一种抽象类型,不能直接使用。 请改用派生类型 virtualEventTownhall 或 virtualEventWebinar 。

方法

方法 返回类型 说明
设置外部事件信息 无 通过设置 externalEventId,将外部事件信息链接到 virtualEventTownhall 或 virtualEventWebinar。

属性

属性 类型 说明
createdBy communicationsIdentitySet 虚拟事件的创建者的标识信息。 继承自 virtualEvent。
description itemBody 虚拟事件的说明。
displayName String 虚拟事件的显示名称。
endDateTime dateTimeTimeZone 虚拟事件的结束时间。 timeZone 属性可以设置为 Windows 当前支持的任何时区。 有关如何使用 PowerShell 获取所有可用时区的详细信息,请参阅 Get-TimeZone。
externalEventInformation virtualEventExternalInformation 集合 虚拟事件的外部信息。 仅对活动组织者或协办者返回;否则为 null。
id String 虚拟事件的唯一标识符。 继承自 entity。
isRegistrationRequired 布尔值 指示是否为虚拟事件启用与会者注册。
settings virtualEventSettings 虚拟事件设置。
startDateTime dateTimeTimeZone 虚拟事件的开始时间。 timeZone 属性可以设置为 Windows 当前支持的任何时区。 有关如何使用 PowerShell 获取所有可用时区的详细信息,请参阅 Get-TimeZone。
status virtualEventStatus 虚拟事件的状态。 可能的值为: draft、 published、 canceled和 unknownFutureValue。

注意

isRegistrationRequired 属性控制虚拟事件是否使用注册工作流。 当 isRegistrationRequired 为 false时,仍可以调用与注册相关的 API。 但是,这些调用不会触发完整的注册体验。 相反,它们充当加载项到日历操作,允许与会者在不完成注册过程的情况下将事件添加到其日历。 对于网络研讨会,默认情况下启用注册, (isRegistrationRequired) true 。 对于市政厅,默认情况下不启用注册。 如果市政厅需要注册,则组织者在配置虚拟事件时必须将 isRegistrationRequiredtrue 显式设置为 。

关系

关系 类型 说明
主持人 virtualEventPresenter 集合 虚拟事件演示者。
sessions virtualEventSession 集合 虚拟事件的会话。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@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)",
  "isRegistrationRequired": "Boolean",
  "settings": {
    "@odata.type": "microsoft.graph.virtualEventSettings"
  },
  "startDateTime": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "status": "String"
}