extensionProperty リソースの種類

[アーティクル]
06/30/2022

名前空間: microsoft.graph

外部データストアを必要とせずにディレクトリオブジェクトにカスタムプロパティを追加するために使用できるディレクトリ拡張機能を表します。たとえば、組織にディレクトリ内の各ユーザーの Skype ID を必要とする基幹業務 (LOB) アプリケーションがある場合、Microsoft Graph を使用して、ディレクトリの User オブジェクトに skypeId という名前の新しいプロパティを登録し、特定のユーザーの新しいプロパティに値を書き込むことができます。

ディレクトリ拡張機能は、次のディレクトリオブジェクトに追加できます。

すべての 種類と すべての アプリケーションにわたって、100 個の拡張値のみを 1 つの Azure AD リソースに書き込むことができます。

このリソースと関連するメソッドを使用して、ディレクトリ拡張機能の定義を管理します。拡張リソースインスタンスでディレクトリ拡張データを管理するには、リソースインスタンスの管理に使用するのと同じ REST 要求を使用します。

Microsoft Graph の機能拡張の詳細については、「拡張機能を使用してリソースにカスタムプロパティを追加する」を参照してください。

directoryObject から継承します。

注意

Azure AD Graph を使用して作成された拡張機能 (非推奨) と、Azure AD Connect Sync を使用してオンプレミスの Active Directoryから同期されたカスタムデータは、Microsoft Graph のディレクトリ拡張機能として表されます。

メソッド

メソッド	戻り値の型	説明
extensionProperties の作成	extensionProperty	application オブジェクトの拡張プロパティを作成します。
extensionProperties の一覧表示	extensionProperty コレクション	application オブジェクトの拡張プロパティを一覧表示します。
extensionProperty の取得	extensionProperty コレクション	application オブジェクトの拡張プロパティを一覧表示します。
extensionProperty の削除	なし	application オブジェクトから拡張プロパティを削除します。オンプレミスのアクティブディレクトリから同期されていないプロパティのみを削除できます。

ヒント

拡張機能プロパティの値を targetObjects で指定されたリソースのインスタンスに設定するには、リソースの Update 操作を使用します。たとえば、ユーザーの値を設定するようにユーザー API を更新します。
targetObjects で指定されているリソースのインスタンスから拡張機能プロパティとその値を削除するには、拡張機能プロパティnullの値を .

プロパティ

プロパティ	型	説明
appDisplayName	String	この拡張機能プロパティが定義されているアプリケーションオブジェクトの表示名。読み取り専用です。
dataType	String	拡張機能プロパティが保持できる値のデータ型を指定します。次の値がサポートされています。 null 許容ではありません。 `Binary` - 最大 256 バイト `Boolean` `DateTime` - ISO 8601 形式で指定する必要があります。 UTC で格納されます。 `Integer` - 32 ビット値。 `LargeInteger` - 64 ビット値。 `String` - 最大 256 文字
deletedDateTime	DateTimeOffset	このオブジェクトが削除された日時。オブジェクトが削除されていない場合は常に `null`。 directoryObject から継承されます。
isSyncedFromOnPremises	Boolean	この拡張機能プロパティが Azure AD Connect を使用してオンプレミスのアクティブディレクトリから同期されたかどうかを示します。読み取り専用です。
name	String	拡張機能プロパティの名前。 null 許容ではありません。
targetObjects	String collection	次の値がサポートされています。 null 許容型ではありません。 `User` `Group` `Organization` `Device` `Application`

リレーションシップ

なし

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.extensionProperty",
  "id": "String (identifier)",
  "deletedDateTime": "String (timestamp)",
  "appDisplayName": "String",
  "name": "String",
  "dataType": "String",
  "isSyncedFromOnPremises": "Boolean",
  "targetObjects": [
    "String"
  ]
}

extensionProperty リソースの種類

メソッド

プロパティ

リレーションシップ

JSON 表記

関連項目

フィードバック