名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
テナント内のエージェント ID ブループリント プリンシパルを表します。 エージェント ID ブループリント プリンシパルは agentIdentityBlueprintPrincipal オブジェクトからインスタンス化され、Microsoft Entra ID テナント内にエージェント ID を作成し、作成されたすべてのエージェント ID に影響を与えるさまざまな ID 管理操作を実行するために使用されます。
servicePrincipal から継承します。
このリソースは、ここに記載されているプロパティを超える追加のプロパティを許可するオープン型です。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | agentIdentityBlueprintPrincipal コレクション | agentIdentityBlueprintPrincipal オブジェクトとそのプロパティの一覧を取得します。 |
| Create | agentIdentityBlueprintPrincipal | 新しい agentIdentityBlueprintPrincipal オブジェクトを作成します。 |
| Get | agentIdentityBlueprintPrincipal | agentIdentityBlueprintPrincipal オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | agentIdentityBlueprintPrincipal | agentIdentityBlueprintPrincipal オブジェクトのプロパティを更新します。 |
| Delete | なし | agentIdentityBlueprintPrincipal オブジェクトを削除します。 |
| App role assignments | ||
| に割り当てられているアプリ ロールを一覧表示する | appRoleAssignment コレクション | このエージェント ID ブループリント プリンシパルに割り当てられたアプリ ロールのユーザー、グループ、エージェント ID を取得します。 |
| 割り当てられたアプリ ロールを追加する | appRoleAssignment | このエージェント ID ブループリント プリンシパルのアプリ ロールをユーザー、グループ、またはサービス プリンシパルに割り当てます。 |
| に割り当てられたアプリ ロールを削除する | なし | ユーザー、グループ、またはサービス プリンシパルから、このエージェント ID ブループリント プリンシパルのアプリ ロールの割り当てを削除します。 |
| アプリの役割の割り当てを一覧表示する | appRoleAssignment コレクション | このエージェント ID ブループリント プリンシパルが割り当てられているアプリ ロールを取得します。 |
| アプリの役割の割り当てを追加する | appRoleAssignment | このエージェント ID ブループリント プリンシパルにアプリ ロールを割り当てます。 |
| アプリの役割の割り当てを削除する | なし | このエージェント ID ブループリント プリンシパルからアプリ ロールの割り当てを削除します。 |
| 委任された権限の付与 | ||
| OAuth 2.0 のアクセス許可許可の一覧表示 | oAuth2PermissionGrant コレクション | サインインしているユーザーの代わりに API にアクセスすることをこのエージェント ID ブループリント プリンシパルに許可する委任されたアクセス許可を取得します。 |
| 削除済みアイテム | ||
| List | directoryObject コレクション | 最近削除されたエージェント ID の一覧を取得します。 |
| Get | directoryObject | 最近削除されたエージェント ID のプロパティを取得します。 |
| 復元 | directoryObject | 最近削除したエージェント ID を復元します。 |
| 完全に削除 | なし | エージェント ID を完全に削除します。 |
| Directory objects | ||
| 所有されているオブジェクトを一覧表示する | directoryObject コレクション | このエージェント ID ブループリント プリンシパルが所有するディレクトリ オブジェクトを取得します。 |
| 作成されたオブジェクトを一覧表示する | directoryObject コレクション | このエージェント ID ブループリント プリンシパルによって作成されたディレクトリ オブジェクトを取得します。 |
| Memberships | ||
| 所属を一覧表示する | directoryObject コレクション | このエージェント ID ブループリント プリンシパルが直接メンバーであるグループを取得します。 |
| 所有者 | ||
| 所有者を一覧表示する | directoryObject コレクション | このエージェント ID ブループリント プリンシパルの所有者を取得します。 |
| 所有者の追加 | なし | このエージェント ID ブループリント プリンシパルに所有者を割り当てます。 |
| 所有者を削除する | なし | このエージェント ID ブループリント プリンシパルから所有者を削除します。 |
| Sponsors | ||
| List sponsors | directoryObject コレクション | このエージェント ID ブループリント プリンシパルのスポンサーを取得します。 |
| スポンサーを追加する | directoryObject | スポンサー コレクションに投稿してスポンサーを追加します。 |
| Remove sponsors | なし | directoryObject オブジェクトを削除します。 |
プロパティ
重要
このリソースは servicePrincipal から継承されますが、一部のプロパティは適用されず、 null または既定値が返されます。 これらのプロパティは、次の表から除外されます。
| プロパティ | 型 | 説明 |
|---|---|---|
| accountEnabled | ブール値 |
true エージェント ID ブループリント プリンシパル アカウントが有効になっている場合。それ以外の場合は、 false。
falseに設定されている場合、ユーザーは割り当てられている場合でも、このアプリにサインインできません。
servicePrincipal から継承されます。 |
| appDescription | String | 関連付けられているエージェント ID ブループリントによって公開される説明。 servicePrincipal から継承されます。 |
| appDisplayName | String | 関連付けられているエージェント ID ブループリントによって公開される表示名。 最大文字数は 256 文字です。 servicePrincipal から継承されます。 |
| appId | String | 関連付けられているエージェント ID ブループリントの appId 。 代替キー。 servicePrincipal から継承されます。 |
| appOwnerOrganizationId | Guid | エージェント ID ブループリントが登録されているテナント ID を格納します。 これは、アプリケーションによってサポートされるエージェント ID ブループリント プリンシパルにのみ適用されます。 servicePrincipal から継承されます。 |
| appRoleAssignmentRequired | ブール値 | ユーザーがサインインするか、アプリがトークンを取得する前に、ユーザーまたは他のサービス プリンシパルにこのエージェント ID ブループリント プリンシパルのアプリ ロールの割り当てを付与する必要があるかどうかを指定します。 既定値は false です。 null 許容ではありません。
servicePrincipal から継承されます。 |
| appRoles | appRole コレクション | エージェント ID ブループリントによって公開されるロール。このエージェント ID ブループリント プリンシパルが表します。 詳細については、アプリケーション エンティティの appRoles プロパティ定義に関するページを参照してください。 null 許容ではありません。 servicePrincipal から継承されます。 |
| createdByAppId | String | このエージェント ID ブループリント プリンシパルを作成したアプリケーションの appId (Microsoft Entra 管理センターのアプリケーション (クライアント) ID と呼ばれます)。 Microsoft Entra IDによって内部的に設定します。 読み取り専用です。 servicePrincipal から継承されます。 |
| disabledByMicrosoftStatus | String | 登録済みのエージェント ID ブループリントが Microsoft によって無効にされているかどうかを指定します。 使用可能な値は、 null (既定値)、 NotDisabled、および DisabledDueToViolationOfServicesAgreement です (疑わしい、虐待的、または悪意のあるアクティビティ、または Microsoft サービス契約違反が考えられます)。
servicePrincipal から継承されます。 |
| displayName | 文字列 | エージェント ID ブループリント プリンシパルの表示名。 servicePrincipal から継承されます。 |
| id | 文字列 | エージェント ID ブループリント プリンシパルの一意識別子。 エンティティから継承 されます。 キー。 null 許容ではありません。 読み取り専用です。 |
| info | informationalUrl | アプリのマーケティング、サポート、利用規約、プライバシーに関する声明のURLなど、取得したアプリケーションの基本的なプロファイル情報。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 servicePrincipal から継承されます。 |
| publishedPermissionScopes | permissionScope コレクション | アプリケーションによって公開された委任された権限。 詳細については、エージェント ID ブループリント エンティティの api プロパティの oauth2PermissionScopes プロパティを参照してください。 null 許容ではありません。 servicePrincipal から継承されます。 |
| publisherName | String | アプリケーションを発行したMicrosoft Entra テナントの名前。 servicePrincipal から継承されます。 |
| servicePrincipalNames | String コレクション | 関連付けられたエージェント ID ブループリントからコピーされた identifiersUris の一覧が含まれます。 ハイブリッド エージェント ID ブループリントには、さらに多くの値を追加できます。 これらの値は、Microsoft Entra ID内でこのアプリによって公開されるアクセス許可を識別するために使用できます。 null 許容ではありません。 エージェント ID ブループリント プリンシパルでブロックされたプロパティ。 servicePrincipal から継承されます。 |
| servicePrincipalType | String | エージェント ID ブループリント プリンシパルがアプリケーションを表しているかどうかを識別します。 これは、内部的にMicrosoft Entra IDによって設定されます。 アプリケーションを表すエージェント ID ブループリント プリンシパルの場合、これは Application として設定 されます。 servicePrincipal から継承されます。 |
| signInAudience | 文字列 | 現在のエージェント ID ブループリントでサポートされている Microsoft アカウントを指定します。 読み取り専用です。 サポートされる値は、 AzureADMyOrg、 AzureADMultipleOrgs、 AzureADandPersonalMicrosoftAccount、 PersonalMicrosoftAccountです。
servicePrincipal から継承されます。 |
| tags | String collection | エージェント ID ブループリント プリンシパルを分類して識別するために使用できるカスタム文字列。 null 許容ではありません。 値は、ここで、関連付けられているエージェント ID ブループリント エンティティの tags プロパティに設定された文字列の和集合です。 servicePrincipal から継承されます。 |
| verifiedPublisher | verifiedPublisher | このエージェント ID ブループリント プリンシパルにリンクされているアプリケーションの検証済み発行元を指定します。 servicePrincipal から継承されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy コレクション | このエージェント ID ブループリント プリンシパルに適用された appManagementPolicy。 microsoft.graph.servicePrincipal から継承 |
| appRoleAssignedTo | appRoleAssignment コレクション | ユーザー、グループ、およびその他のサービス プリンシパルに付与される、このエージェント ID ブループリント プリンシパルのアプリ ロールの割り当て。
$expand をサポートします。
microsoft.graph.servicePrincipal から継承 |
| appRoleAssignments | appRoleAssignment コレクション | このエージェント ID ブループリント プリンシパルに付与される、別のアプリまたはサービスのアプリ ロールの割り当て。
$expand をサポートします。
microsoft.graph.servicePrincipal から継承 |
| createdObjects | directoryObject コレクション | このエージェント ID ブループリント プリンシパルによって作成されたディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。 microsoft.graph.servicePrincipal から継承 |
| memberOf | directoryObject コレクション | このエージェント ID ブループリント プリンシパルがメンバーであるロール。 HTTP メソッド: GET 読み取り専用。 Null 許容型です。
$expand をサポートします。
microsoft.graph.servicePrincipal から継承 |
| oauth2PermissionGrants | oAuth2PermissionGrant コレクション | 委任されたアクセス許可は、サインインしているユーザーの代わりに API にアクセスすることをこのエージェント ID ブループリント プリンシパルに許可します。 読み取り専用です。 Null 許容型。 microsoft.graph.servicePrincipal から継承 |
| ownedObjects | directoryObject コレクション | このエージェント ID ブループリント プリンシパルが所有するディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。
$expand および $filter (/$count eq 0、/$count ne 0、/$count eq 1、/$count ne 1) をサポートします。
microsoft.graph.servicePrincipal から継承 |
| owners | directoryObject コレクション | このエージェント ID ブループリント プリンシパルの所有者であるディレクトリ オブジェクト。 所有者は、このオブジェクトの変更を許可されている管理者以外のユーザーまたは servicePrincipals のセットです。
$expand および $filter (/$count eq 0、/$count ne 0、/$count eq 1、/$count ne 1) をサポートします。
microsoft.graph.servicePrincipal から継承 |
| スポンサー | directoryObject コレクション | このエージェント ID ブループリント プリンシパルのスポンサー。 スポンサーは、エージェント ID インスタンスのライフサイクルを承認および管理できるユーザーまたはサービス プリンシパルです。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。 既定では、すべてのプロパティのサブセットのみが返されます。 その他のすべてのプロパティは、 $selectを使用してのみ取得できます。
{
"@odata.type": "#microsoft.graph.agentIdentityBlueprintPrincipal",
"id": "String (identifier)",
"accountEnabled": "Boolean",
"createdByAppId": "String",
"appDescription": "String",
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"appRoleAssignmentRequired": "Boolean",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"publisherName": "String",
"servicePrincipalNames": [
"String"
],
"servicePrincipalType": "String",
"signInAudience": "String",
"tags": [
"String"
],
"appRoles": [
{
"@odata.type": "microsoft.graph.appRole"
}
],
"info": {
"@odata.type": "microsoft.graph.informationalUrl"
},
"publishedPermissionScopes": [
{
"@odata.type": "microsoft.graph.permissionScope"
}
],
"verifiedPublisher": {
"@odata.type": "microsoft.graph.verifiedPublisher"
}
}