名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
管理単位は、ユーザー、グループ、およびデバイス ディレクトリ オブジェクトの概念的なコンテナーを提供します。 管理単位を使用すると、会社の管理者は、管理単位に含まれるユーザー、グループ、およびデバイスを管理する、または管理単位にスコープが適用されるユーザー、グループ、デバイスを管理するための管理責任を、地域または部門の管理者に委任できるようになりました。 管理単位の詳細については、「Microsoft Entra ID の管理単位に関するページをご覧ください。
このリソースは、ここに記載されているもの以外の追加のプロパティを許可するオープン型です。
このリソースは以下をサポートしています。
- 拡張機能として、カスタム プロパティに独自のデータを追加します。
- デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。
-
$select、$filter、$search、$topなどの OData クエリ機能。 特定の使用は、 高度なクエリ機能でのみサポートされます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | administrativeUnit | 新しい管理単位を作成します。 |
| List | administrativeUnit コレクション | すべての administrativeUnits のプロパティを一覧表示します。 |
| Get | administrativeUnit | 特定の administrativeUnit オブジェクトのプロパティと関係を読み取ります。 |
| Update | administrativeUnit | administrativeUnit オブジェクトを更新します。 |
| Delete | なし | administrativeUnit オブジェクトを削除します。 |
| Get delta | administrativeUnit | リソース コレクション全体の完全な読み取りを実行することなく、新しく作成、更新、または削除された administrativeUnits を取得します。 |
| Memberships | ||
| メンバーを追加する | directoryObject | メンバー (ユーザーまたはグループ) を追加します。 |
| メンバーを一覧表示する | directoryObject コレクション | (ユーザーとグループ) メンバーのリストを取得します。 |
| メンバーを取得する | directoryObject | 特定のメンバーを取得します。 |
| メンバーを削除する | directoryObject | メンバーを削除します。 |
| ロールの割り当て | ||
| スコープを使用してロールを割り当てる | scopedRoleMembership | 管理単位スコープで Microsoft Entra ロールを割り当てます。 |
| スコープを使用してロールの割り当てを一覧表示する | scopedRoleMembership コレクション | 管理単位のスコープを持つ Microsoft Entra ロールの割り当てを一覧表示します。 |
| スコープを使用してロールの割り当てを取得する | scopedRoleMembership | 管理単位スコープで Microsoft Entra ロールの割り当てを取得します。 |
| スコープを使用してロールの割り当てを削除する | scopedRoleMembership | 管理単位スコープで Microsoft Entra ロールの割り当てを削除します。 |
| 削除済みアイテム | ||
| List | directoryObject コレクション | ディレクトリ オブジェクトのコレクションから、最近削除された管理単位の一覧を取得します。 |
| Get | directoryObject | 最近削除された管理単位オブジェクトのプロパティを取得します。 |
| 復元 | directoryObject | 最近削除された管理単位オブジェクトを復元します。 |
注:
administrativeUnits API を呼び出すための URL エンドポイントは、beta エンドポイントに/administrativeUnitsされていますが、v1.0エンドポイントに/directory/administrativeUnitsされています。
プロパティ
重要
$filter および $search クエリ パラメーターの具体的な使用方法は、ConsistencyLevel ヘッダーの設定を eventual と $count に使用する場合にのみサポートされます。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
| プロパティ. | 型 | 説明 |
|---|---|---|
| description | String | 管理単位の省略可能な説明。
$filter (eq、ne、in、startsWith)、$search をサポートします。 |
| displayName | 文字列 | 管理単位の表示名。 最大文字数は 256 文字です。
$filter (eq、ne、not、ge、le、in、startsWith、および eq の null値)、$search、および $orderby をサポートします。 |
| id | 文字列 | 管理単位の一意識別子。 読み取り専用です。
$filter (eq)をサポートしています。 |
| isMemberManagementRestricted | ブール型 |
true この管理単位のメンバーを機密性の高いものとして扱う必要がある場合。管理するには特定のアクセス許可が必要です。 設定されていない場合、既定値は null で、既定の動作は false です。 このプロパティを使用して、テナント レベルの管理者から継承されない役割を持つ管理単位を定義し、個々のメンバー オブジェクトの管理が、制限された管理管理単位にスコープされた管理者に限定されます。 このプロパティは変更不可であり、後で変更することはできません。 制限された管理単位を操作する方法の詳細については、「 Microsoft Entra ID の制限された管理管理単位」を参照してください。 |
| membershipRule | String | 管理単位の動的メンバーシップ ルール。 動的な管理単位と動的なグループに使用できるルールの詳細については、「Microsoft Entra ID で動的メンバーシップ グループのルールを管理する」を参照してください。 |
| membershipRuleProcessingState | String | 動的メンバーシップ ルールがアクティブに処理されるかどうかを制御します。 動的メンバーシップ ルールをアクティブにする場合は On に設定し、メンバーシップの動的な更新を停止する場合は Paused に設定します。 |
| membershipType | 文字列 | 管理単位のメンバーシップの種類を示します。 可能な値は dynamic、 assigned です。 設定されていない場合、既定値は null になり、既定の動作が割り当てられます。 |
| visibility | String | 管理単位とそのメンバーを非表示にするかパブリックにするかを制御します。
HiddenMembership または Public に設定できます。 設定されていない場合、既定値は null で、既定の動作はパブリックです。
HiddenMembership に設定すると、管理単位のメンバーのみが管理単位の他のメンバーを一覧表示できます。 |
ヒント
ディレクトリ拡張機能と関連データは既定で返されますが、スキーマ拡張機能と関連データを取得するには $select が必要です。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| extensions | extension コレクション | この管理単位に定義されているオープン拡張機能のコレクション。 Null 許容型。 |
| members | directoryObject コレクション | この管理単位のメンバーであるユーザーとグループ。
$expand をサポートします。 |
| scopedRoleMembers | scopedRoleMembership コレクション | この管理単位のスコープを指定されたロール メンバー。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"isMemberManagementRestricted": "Boolean",
"membershipRule": "String",
"membershipRuleProcessingState": "String",
"membershipType": "String",
"visibility": "String"
}