Ressourcentyp "virtualEvent"

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Stellt einen abstrakten Basistyp für ein virtuelles Ereignis dar. Basistyp von virtualEventTownhall und virtualEventWebinar.

Erbt von entity.

Tipp

Dies ist ein abstrakter Typ und kann nicht direkt verwendet werden. Verwenden Sie stattdessen die abgeleiteten Typen virtualEventTownhall oder virtualEventWebinar .

Methoden

Methode Rückgabetyp Beschreibung
Festlegen externer Ereignisinformationen Keine Verknüpfen Sie externe Ereignisinformationen mit einer virtualEventTownhall oder einem virtualEventWebinar , indem Sie eine externalEventId festlegen. ]

Eigenschaften

Eigenschaft Typ Beschreibung
Kapazität Integer Stellt die erwartete Anzahl von Teilnehmern für Versammlungen dar.
createdBy communicationsIdentitySet Die Identitätsinformationen des Erstellers des virtuellen Ereignisses. Geerbt von virtualEvent.
description itemBody Eine Beschreibung des virtuellen Ereignisses.
displayName Zeichenfolge Der Anzeigename des virtuellen Ereignisses.
endDateTime dateTimeTimeZone Die Endzeit des virtuellen Ereignisses. Die timeZone-Eigenschaftkann auf eine der Zeitzonen festgelegt werden, die derzeit von Windows unterstützt werden. Weitere Informationen zum Abrufen aller verfügbaren Zeitzonen mithilfe von PowerShell finden Sie unter Get-TimeZone.
externalEventInformation virtualEventExternalInformation-Sammlung Die externen Informationen eines virtuellen Ereignisses. Wird nur für Ereignisorganisatoren oder Mitorganisatoren zurückgegeben; nullandernfalls .
id Zeichenfolge Der eindeutige Bezeichner des virtuellen Ereignisses. Geerbt von entity.
isRegistrationRequired Boolean Gibt an, ob die Teilnehmerregistrierung für das virtuelle Ereignis aktiviert ist.
settings virtualEventSettings Die Einstellungen für das virtuelle Ereignis.
startDateTime dateTimeTimeZone Startzeit des virtuellen Ereignisses. Die timeZone-Eigenschaftkann auf eine der Zeitzonen festgelegt werden, die derzeit von Windows unterstützt werden. Weitere Informationen zum Abrufen aller verfügbaren Zeitzonen mithilfe von PowerShell finden Sie unter Get-TimeZone.
status virtualEventStatus Der Status des virtuellen Ereignisses. Mögliche Werte sind: draft, published, canceled, unknownFutureValue.

Hinweis

Hinweis: Die isRegistrationRequired Eigenschaft steuert, ob das virtuelle Ereignis den Registrierungsworkflow verwendet. Wenn isRegistrationRequired der Wert auf "false" festgelegt ist, können registrierungsbezogene APIs weiterhin aufgerufen werden. Diese Aufrufe lösen jedoch nicht die vollständige Registrierung aus. Stattdessen verhalten sie sich wie eine Aktion zum Hinzufügen zum Kalender, sodass Teilnehmer das Ereignis zu ihrem Kalender hinzufügen können, ohne einen Registrierungsprozess abzuschließen. Bei Webinaren ist die Registrierung standardmäßig aktiviert (isRegistrationRequired = true). Für Versammlungen ist die Registrierung standardmäßig nicht aktiviert. Wenn für eine Versammlung eine Registrierung erforderlich ist, muss der Organisator beim Konfigurieren der virtuellen Veranstaltung explizit auf "true" setzen isRegistrationRequired .

Dadurch wird sichergestellt, dass registrierungsbezogene APIs den vollständigen Registrierungsworkflow und die Teilnehmerregistrierung aufrufen.

virtualEventStatus-Werte

Wert Beschreibung
Entwurf Das virtuelle Ereignis befindet sich im Entwurf und ist nur für den Organisator sichtbar.
veröffentlicht Der Organisator hat die virtuelle Veranstaltung veröffentlicht und sie ist für das Publikum sichtbar.
abgebrochen Der Organisator hat das virtuelle Ereignis abgesagt.
unknownFutureValue Evolvable Enumeration Sentinel-Wert. Nicht verwenden.

Beziehungen

Beziehung Typ Beschreibung
Referenten virtualEventPresenter-Sammlung Die Moderatoren des virtuellen Ereignisses.
sessions virtualEventSession-Sammlung Die Sitzungen für das virtuelle Ereignis.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.virtualEvent",
  "capacity": "Integer",
  "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"
}