synchronizationSchema-Ressourcentyp

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.

Definiert, welche Objekte synchronisiert werden und wie sie synchronisiert werden. Das Synchronisierungsschema enthält die meisten Setupinformationen für einen bestimmten Synchronisierungsauftrag. In der Regel passen Sie einige attributbasierte Zuordnungen an oder fügen einen Bereichsfilter hinzu, um nur Objekte zu synchronisieren, die eine bestimmte Bedingung erfüllen.

In den folgenden Abschnitten werden die allgemeinen Komponenten des Synchronisierungsschemas beschrieben.

Verzeichnisdefinitionen

Verzeichnisdefinitionen stellen informationen zur Synchronisierungs-Engine zu Verzeichnissen und deren Objekten bereit. Beispielsweise teilt die Verzeichnisdefinition der Synchronisierungs-Engine mit, dass ein Microsoft Entra-Verzeichnis über Objekte mit dem Namen user und group verfügt, welche Attribute für diese Objekte unterstützt werden, und die Typen für diese Attribute. Damit ein bestimmtes Objekt und Attribut in Synchronisierungsregeln/Objektzuordnungen verwendet werden kann, müssen sie als Teil der Verzeichnisdefinition definiert werden.

Synchronisierungsregeln

Synchronisierungsregeln sind der Kern der Synchronisierungseinrichtung. Sie definieren für die Synchronisierungs-Engine, wie die Synchronisierung durchgeführt werden soll, einschließlich der Objekte, die synchronisiert werden sollen, wie Objekte aus dem Quellverzeichnis mit Objekten im Zielverzeichnis abgeglichen werden sollen und wie Attribute transformiert werden sollen, wenn sie von der Quelle mit dem Zielverzeichnis synchronisiert werden.

Objektzuordnungen

Objektzuordnungen sind der Hauptteil der Synchronisierungsregel. Jede Objektzuordnung definiert, wie ein bestimmtes Objekt von der Quelle mit dem Zielverzeichnis synchronisiert werden soll. Die Zuordnung definiert insbesondere, wie ein Objekt im Quellverzeichnis mit einem Objekt im Zielverzeichnis abgeglichen werden soll, welche (falls vorhanden) Bereichsfilter verwendet werden sollen, um zu entscheiden, ob ein Objekt bereitgestellt werden soll und wie Objektattribute transformiert werden sollen, wenn sie von der Quelle mit dem Zielverzeichnis synchronisiert werden.

Methoden

Methode Rückgabetyp Beschreibung
Get synchronizationSchema Liest Eigenschaften und Beziehungen des synchronizationSchema-Objekts .
Update Keine Aktualisieren Sie das Synchronisierungsschema.
Reset Keine Löschen Sie das angepasste Schema, und setzen Sie das Schema auf die Standardkonfiguration zurück.
Schemafilteroperatoren abrufen filterOperatorSchema-Auflistung Listet alle Operatoren auf, die in den Bereichsfiltern unterstützt werden.
Schemafunktionen abrufen attributeMappingFunctionSchema-Auflistung Listet alle Funktionen auf, die in den Attributzuordnungsausdrücken unterstützt werden.
Analysieren eines Attributzuordnungsausdrucks parseExpressionResponse Analysieren sie einen Zeichenfolgenausdruck in ein attributeMappingSource-Objekt .

Eigenschaften

Eigenschaft Typ Beschreibung
id Zeichenfolge Eindeutiger Bezeichner für das Schema.
synchronizationRules synchronizationRule-Sammlung Eine Sammlung von Synchronisierungsregeln, die für synchronizationJob oder synchronizationTemplate konfiguriert sind.
Version Zeichenfolge Die Version des Schemas, die bei jeder Schemaänderung automatisch aktualisiert wird.

Beziehungen

Beziehung Typ Beschreibung
Verzeichnisse directoryDefinition-Auflistung Enthält die Auflistung von Verzeichnissen und alle zugehörigen Objekte.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.synchronizationSchema",
  "id": "String (identifier)",
  "synchronizationRules": [
    {
      "@odata.type": "microsoft.graph.synchronizationRule"
    }
  ],
  "version": "String"
}