extensionProperty リソースの種類 (ディレクトリ拡張機能)
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
外部データ ストアを必要とせずに、ディレクトリ オブジェクトにカスタム プロパティを追加するために使用できるディレクトリ 拡張機能 を表します。 たとえば、組織に、ディレクトリ内の各ユーザーの Skype ID を必要とする基幹業務 (LOB) アプリケーションがある場合、Microsoft Graph を使用してディレクトリの User オブジェクトに skypeId という名前の新しいプロパティを登録し、特定のユーザーの新しいプロパティに値を書き込むことができます。 ディレクトリ拡張機能は、テナントで に同意されているマルチテナント アプリでも使用できます。
ディレクトリ拡張機能は、次のディレクトリ オブジェクトに追加できます。
1 つの Microsoft Entra リソース インスタンスに書き込める拡張機能の値は、 すべての 種類と すべての アプリケーションで 100 個のみです。
このリソースと関連するメソッドを使用して、ディレクトリ拡張機能の定義を管理します。 拡張リソース インスタンス上のディレクトリ拡張機能データを管理するには、リソース インスタンスの管理に使用するのと同じ REST 要求を使用します。
Microsoft Graph の拡張機能の詳細については、「 拡張機能を使用してリソースにカスタム プロパティを追加する」を参照してください。
directoryObject から継承します。
注:
Microsoft Entra Connect Sync を使用してオンプレミスの Active Directory から同期された Azure AD Graph を通じて作成された拡張機能 (現在は廃止サイクル中) とカスタム データは、Microsoft Graph のディレクトリ拡張機能として表されます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | extensionProperty | アプリケーション オブジェクトにディレクトリ拡張機能を作成します。 |
| List | extensionProperty コレクション | アプリケーション オブジェクトのディレクトリ拡張機能を一覧表示します。 |
| Get | extensionProperty コレクション | アプリケーション オブジェクトのディレクトリ拡張機能を取得します。 |
| Delete | なし | アプリケーション オブジェクトからディレクトリ拡張機能を削除します。 削除できるのは、オンプレミスの Active Directory から同期されていないディレクトリ拡張機能のみです。 |
ヒント
- 拡張プロパティの値を targetObjects で指定されたリソースのインスタンスに設定するには、リソースの Update 操作を使用します。 たとえば、ユーザーの値を設定する 更新 ユーザー API です。
-
targetObjects で指定されているリソースのインスタンスから拡張プロパティとその値を削除するには、拡張プロパティの値を
nullに設定します。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| appDisplayName | String | この拡張プロパティが定義されているアプリケーション オブジェクトの表示名。 読み取り専用です。 |
| dataType | String | 拡張プロパティが保持できる値のデータ型を指定します。 次の値がサポートされています。
|
| deletedDateTime | DateTimeOffset | このオブジェクトが削除された日時。 オブジェクトが削除されていない場合は常に null。
directoryObject から継承されます。 |
| isSyncedFromOnPremises | ブール型 | Microsoft Entra Connect を使用して、この拡張機能プロパティがオンプレミスの Active Directory から同期されたかどうかを示します。 読み取り専用です。 |
| name | String | 拡張プロパティの名前。 null 許容ではありません。
$filter (eq)をサポートしています。 |
| isMultiValued | ブール型 | ディレクトリ拡張機能を複数値プロパティとして定義します。
trueすると、ディレクトリ拡張プロパティは dataType のオブジェクトのコレクション (たとえば、"extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"] などの文字列型のコレクション) を格納できます。 既定値は false です。
$filter (eq)をサポートしています。 |
| targetObjects | String collection | 次の値がサポートされています。 null 許容型ではありません。
|
リレーションシップ
なし
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.extensionProperty",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"appDisplayName": "String",
"name": "String",
"dataType": "String",
"isSyncedFromOnPremises": "Boolean",
"isMultiValued": "Boolean",
"targetObjects": [
"String"
]
}