schemaExtension リソースの種類 (スキーマ拡張機能)schemaExtension resource type (schema extensions)

スキーマの拡張機能を使用すると、拡張するスキーマを定義し、厳密に型指定されたカスタム データをリソースの種類に追加できます。カスタム データは拡張したリソースの複合型として表示されます。Schema extensions allow you to define a schema to extend and add strongly-typed custom data to a resource type. The custom data appears as a complex type on the extended resource.

スキーマ拡張機能は次のリソースの種類でサポートされています。Schema extensions are supported by the following resource types:

カスタム データのグループへの追加方法については、スキーマ拡張機能の例を参照してください。See the schema extension example to learn how to add custom data to groups.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
CreateCreate schemaExtensionschemaExtension スキーマ拡張機能の定義を作成します。Create a schema extension definition.
ListList schemaExtensionschemaExtension 使用可能な schemaExtension の定義とそのプロパティを一覧表示します。List the available schemaExtension definitions and their properties.
GetGet schemaExtensionschemaExtension 特定の schemaExtension 定義のプロパティを読み取ります。Read the properties of a specific schemaExtension definition.
UpdateUpdate schemaExtensionschemaExtension schemaExtension 定義を更新します。Update a schemaExtension definition.
DeleteDelete なしNone schemaExtension 定義を削除します。Delete a schemaExtension definition.

プロパティProperties

プロパティProperty Type 説明Description
descriptiondescription StringString スキーマ拡張機能の説明。Description for the schema extension.
idid StringString スキーマ拡張機能の定義の一意の識別子。The unique identifier for the schema extension definition.
値の割り当ては、以下の 2 方法のいずれかで行うことができます。You can assign a value in one of two ways:
  • 確認されたドメインの内の 1 つの名前とスキーマ拡張機能の名前を連結して、{domainName}_{schemaName} という形式の一意の文字列を形成します。たとえば、contoso_mySchema です。 Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, {domainName}_{schemaName}. As an example, contoso_mySchema.
  • スキーマ名を指定し、Microsoft Graph がそのスキーマ名を使用して id 割り当てを完了するには、次の形式を使用します。ext{8-random-alphanumeric-chars}_{schema-name}。たとえば、extkvbmkofy_mySchema です。Provide a schema name, and let Microsoft Graph use that schema name to complete the id assignment in this format: ext{8-random-alphanumeric-chars}_{schema-name}. An example would be extkvbmkofy_mySchema.
作成後、このプロパティは変更できません。This property cannot be changed after creation.
ownerowner StringString スキーマ拡張機能の所有者であるアプリケーションの appId です。The appId of the application that is the owner of the schema extension. このプロパティは作成時に指定して所有者を設定できます。This property can be supplied on creation, to set the owner. 指定しない場合、呼び出し元のアプリケーションの appId が所有者として設定されます。If not supplied, then the calling application's appId will be set as the owner. どちらの場合も、サインインしたユーザーがアプリケーションの所有者でなければなりません。In either case, the signed-in user must be the owner of the application. 設定すると、このプロパティは読み取り専用で、変更することはできません。Once set, this property is read-only and cannot be changed.
propertiesproperties extensionSchemaProperty コレクションextensionSchemaProperty collection スキーマ拡張機能の定義を構成するプロパティ名と種類のコレクション。The collection of property names and types that make up the schema extension definition.
statusstatus StringString スキーマ拡張機能のライフサイクル状態。The lifecycle state of the schema extension. 考えられる状態は、InDevelopmentAvailable、および Deprecated です。Possible states are InDevelopment, Available, and Deprecated. 作成時に自動で InDevelopment に設定されます。Automatically set to InDevelopment on creation. 考えられる状態遷移と動作の詳細については、「スキーマ拡張機能」をご覧ください。Schema extensions provides more information on the possible state transitions and behaviors.
targetTypestargetTypes String コレクションString collection スキーマ拡張機能に適用できる (拡張機能をサポートできる) 一連の Microsoft Graph の種類。Set of Microsoft Graph types (that can support extensions) that the schema extension can be applied to. contactdeviceeventgroupmessageorganizationpostuser のいずれかから選択します。Select from contact, device, event, group, message, organization, post, or user.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

{
  "description": "String",
  "id": "String (identifier)",
  "owner": "String",
  "properties": [{"@odata.type": "microsoft.graph.extensionSchemaProperty"}],
  "status": "String",
  "targetTypes": ["String"]
}