directoryDefinition リソースの種類directoryDefinition resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

ディレクトリとそのオブジェクトに関する同期エンジン情報を提供します。Provides the synchronization engine information about a directory and its objects. このリソースは、同期エンジンに対して、たとえば、ディレクトリには、ユーザーグループという名前のオブジェクト、これらのオブジェクトに対してサポートされている属性、およびそれらの属性の種類を示します。This resource tells the synchronization engine, for example, that the directory has objects named user and group, which attributes are supported for those objects, and the types for those attributes. オブジェクトと属性を同期ルールおよびオブジェクトマッピングに参加させるには、それらをディレクトリ定義の一部として定義する必要があります。In order for the object and attribute to participate in synchronization rules and object mappings, they must be defined as part of the directory definition.

通常、同期テンプレートの一部として提供される既定の同期スキーマは、そのディレクトリに最もよく使用されるオブジェクトと属性を定義します。In general, the default synchronization schema provided as part of the synchronization template will define most commonly used objects and attributes for that directory. ただし、ディレクトリでカスタム属性の追加がサポートされている場合は、独自のカスタムオブジェクトまたは属性を使用して、既定の定義を拡張することもできます。However, if the directory supports the addition of custom attributes, you might want to expand the default definition with your own custom objects or attributes. 詳細については、「カスタム属性を使用して同期を構成する」および「 configure synchronization with directory extension attributes」を参照してください。For more information, see Configure synchronization with custom attributes and Configure synchronization with directory extension attributes.

ディレクトリ定義は、同期スキーマの一部として更新されます。Directory definitions are updated as part of the synchronization schema.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
Discover directoryDefinitionDiscover directoryDefinition directoryDefinitiondirectoryDefinition ディレクトリのスキーマとサポートされているプロパティを検出します。Discover the schema and supported properties of the directory.

プロパティProperties

プロパティProperty Type 説明Description
idid 文字列String ディレクトリ識別子。Directory identifier. null 許容ではありません。Not nullable.
metadatametadata metadataEntry コレクションmetadataEntry collection 追加の拡張機能のプロパティ。Additional extension properties. 明示的に記述されていない限り、メタデータ値は変更しないでください。Unless mentioned explicitly, metadata values should not be changed.
namename StringString ディレクトリの名前。Name of the directory. 同期スキーマ内で一意である必要があります。Must be unique within the synchronization schema. null 許容ではありません。Not nullable.
対象objects ObjectdefinitionコレクションobjectDefinition collection ディレクトリでサポートされているオブジェクトのコレクションです。Collection of objects supported by the directory.
versionversion StringString 検出されたバージョンを示す値を取得します。Read only value that indicates version discovered. 検出がまだ行われていない場合は、Null。Null if discovery has not yet occurred.
discoveryDateTimediscoveryDateTime DateTimeOffsetDateTimeOffset は、ISO 8601 形式を使用した検出日時を表し、常に UTC 時間です。Represents the discovery date and time using ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
discoverabilitiesdiscoverabilities stringstring アプリでサポートされている検出の種類を示す値の読み取り専用です。Read only value indicating what type of discovery the app supports. 使用可能な値: AttributeDataTypesAttributeNamesAttributeReadOnlyNoneReferenceAttributesUnknownFutureValuePossible values are: AttributeDataTypes, AttributeNames, AttributeReadOnly, None, ReferenceAttributes, UnknownFutureValue.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

{
  "discoverabilities": "String",
  "discoveryDateTime": "DateTimeOffset",
  "id": "String",
  "metadata": [{"@odata.type": "microsoft.graph.stringKeyStringValuePair"}],
  "name": "String",
  "objects": [{"@odata.type": "microsoft.graph.objectDefinition"}],
  "version": "String"
}