命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示租户中的代理标识蓝图主体。 代理标识蓝图主体从 agentIdentityBlueprintPrincipal 对象实例化,用于在Microsoft Entra ID租户中创建代理标识,并执行影响所创建的所有代理标识的各种标识管理作。
继承自 servicePrincipal。
此资源是一种开放类型,它允许除此处所述的属性之外的其他属性。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | agentIdentityBlueprintPrincipal 集合 | 获取 agentIdentityBlueprintPrincipal 对象及其属性的列表。 |
| 创建 | agentIdentityBlueprintPrincipal | 创建新的 agentIdentityBlueprintPrincipal 对象。 |
| Get | agentIdentityBlueprintPrincipal | 读取 agentIdentityBlueprintPrincipal 对象的属性和关系。 |
| 更新 | agentIdentityBlueprintPrincipal | 更新 agentIdentityBlueprintPrincipal 对象的属性。 |
| 删除 | 无 | 删除 agentIdentityBlueprintPrincipal 对象。 |
| 应用角色分配 | ||
| 列出分配到的应用角色 | appRoleAssignment 集合 | 获取此代理标识蓝图主体的用户、组和代理标识分配的应用角色。 |
| 添加分配到的应用角色 | appRoleAssignment | 将此代理标识蓝图主体的应用角色分配给用户、组或服务主体。 |
| 删除分配到的应用角色 | 无 | 从用户、组或服务主体中删除此代理标识蓝图主体的应用角色分配。 |
| 列出应用角色分配 | appRoleAssignment 集合 | 获取此代理标识蓝图主体分配的应用角色。 |
| 添加应用角色分配 | appRoleAssignment | 将应用角色分配给此代理标识蓝图主体。 |
| 删除应用角色分配 | 无 | 从此代理标识蓝图主体中删除应用角色分配。 |
| 委派权限授予 | ||
| 列出 OAuth 2.0 权限授予 | oAuth2PermissionGrant 集合 | 获取授权此代理标识蓝图主体代表已登录用户访问 API 的委托权限。 |
| 已删除项目 | ||
| List | directoryObject collection | 检索最近删除的代理标识的列表。 |
| Get | directoryObject | 检索最近删除的代理标识的属性。 |
| 还原 | directoryObject | 还原最近删除的代理标识。 |
| 永久删除 | 无 | 永久删除代理标识。 |
| 目录对象 | ||
| 列出拥有的对象 | directoryObject collection | 获取此代理标识蓝图主体拥有的目录对象。 |
| 列出创建的对象 | directoryObject collection | 获取此代理标识蓝图主体创建的目录对象。 |
| Memberships | ||
| 列出隶属于 | directoryObject collection | 获取此代理标识蓝图主体是其直接成员的组。 |
| Owners | ||
| List owners | directoryObject 集合 | 获取此代理标识蓝图主体的所有者。 |
| 添加所有者 | None | 将所有者分配到此代理标识蓝图主体。 |
| 删除所有者 | 无 | 从此代理标识蓝图主体中删除所有者。 |
| 赞助商 | ||
| 列出赞助商 | directoryObject collection | 获取此代理标识蓝图主体的发起人。 |
| 添加赞助商 | directoryObject | 通过发布到赞助商集合来添加赞助商。 |
| 删除赞助商 | 无 | 删除 directoryObject 对象。 |
属性
重要
虽然此资源继承自 servicePrincipal,但某些属性不适用,返回 null 或默认值。 下表中排除了这些属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| accountEnabled | Boolean |
true 如果启用了代理标识蓝图主体帐户,则为 ;否则为 false。 如果设置为 false,则任何用户都无法登录到此应用,即使他们已分配到此应用。 继承自 servicePrincipal。 |
| 应用说明 | String | 关联的代理标识蓝图公开的说明。 继承自 servicePrincipal。 |
| appDisplayName | String | 关联的代理标识蓝图公开的显示名称。 最大长度为 256 个字符。 继承自 servicePrincipal。 |
| appId | String | 关联的代理标识蓝图的 appId 。 备用键。 继承自 servicePrincipal。 |
| appOwnerOrganizationId | Guid | 包含在其中注册代理标识蓝图的租户 ID。 这仅适用于应用程序支持的代理标识蓝图主体。 继承自 servicePrincipal。 |
| appRoleAssignmentRequired | Boolean | 指定是否需要向用户或其他服务主体授予此代理标识蓝图主体的应用角色分配,然后用户才能登录或应用获取令牌。 默认值为 false。 不可为空。 继承自 servicePrincipal。 |
| appRoles | appRole 集合 | 代理标识蓝图公开的角色,此代理标识蓝图主体表示。 有关详细信息,请参阅应用程序实体上的 appRoles 属性定义。 不可为 null。 继承自 servicePrincipal。 |
| createdByAppId | 字符串 | 创建此代理标识蓝图主体的应用程序Microsoft Entra 管理中心) 上的 appId (名为 Application (客户端) ID。 通过Microsoft Entra ID在内部设置。 只读。 继承自 servicePrincipal。 |
| disabledByMicrosoftStatus | String | 指定Microsoft是否已禁用已注册的代理标识蓝图。 可能的值为: null (默认值) NotDisabled, (DisabledDueToViolationOfServicesAgreement 原因可能包括可疑、滥用或恶意活动,或违反Microsoft服务协议) 。 继承自 servicePrincipal。 |
| displayName | String | 代理标识蓝图主体的显示名称。 继承自 servicePrincipal。 |
| id | String | 代理标识蓝图主体的唯一标识符。 继承自 entity。 键。 不可为 null。 只读。 |
| info | informationalUrl | 所获取应用程序的基本配置文件信息,如应用的市场营销、支持、服务条款和隐私声明 URL。 服务条款和隐私声明通过用户同意体验展示给用户。 继承自 servicePrincipal。 |
| publishedPermissionScopes | permissionScope 集合 | 应用程序公开的委派权限。 有关详细信息,请参阅代理标识蓝图实体的 api 属性上的 oauth2PermissionScopes 属性。 不可为 null。 继承自 servicePrincipal。 |
| publisherName | String | 发布应用程序的Microsoft Entra租户的名称。 继承自 servicePrincipal。 |
| servicePrincipalNames | 字符串集合 | 包含从关联的代理标识蓝图复制的 identifiersUris 列表。 可以向混合代理标识蓝图添加更多值。 这些值可用于标识此应用在Microsoft Entra ID中公开的权限。 不可为 null。 代理标识蓝图主体上阻止的属性。 继承自 servicePrincipal。 |
| servicePrincipalType | String | 标识代理标识蓝图主体是否表示应用程序。 这是由内部Microsoft Entra ID设置的。 对于表示应用程序的代理标识蓝图主体,此主体设置为 “应用程序”。 继承自 servicePrincipal。 |
| signInAudience | String | 指定当前代理标识蓝图支持的Microsoft帐户。 只读。 支持的值为: AzureADMyOrg、 AzureADMultipleOrgs、 AzureADandPersonalMicrosoftAccount和 PersonalMicrosoftAccount。 继承自 servicePrincipal。 |
| tags | 字符串集合 | 可用于对代理标识蓝图主体进行分类和标识的自定义字符串。 不可为 null。 该值是此处和关联代理标识蓝图实体的 tags 属性上设置的字符串的联合。 继承自 servicePrincipal。 |
| verifiedPublisher | verifiedPublisher | 指定已链接到此代理标识蓝图主体的应用程序的已验证发布者。 继承自 servicePrincipal。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy 集合 | 应用于此代理标识蓝图主体的 appManagementPolicy。 继承自 microsoft.graph.servicePrincipal |
| appRoleAssignedTo | appRoleAssignment 集合 | 此代理标识蓝图主体的应用角色分配,授予用户、组和其他服务主体。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| appRoleAssignments | appRoleAssignment 集合 | 授予此代理标识蓝图主体的另一个应用或服务的应用角色分配。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| createdObjects | directoryObject collection | 此代理标识蓝图主体创建的目录对象。 只读。 可为 Null。 继承自 microsoft.graph.servicePrincipal |
| memberOf | directoryObject collection | 此代理标识蓝图主体所属的角色。 HTTP 方法:GET 只读。 可为空。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| oauth2PermissionGrants | oAuth2PermissionGrant 集合 | 委派权限授予此代理标识蓝图主体代表已登录用户访问 API 的授权。 只读。 可为 Null。 继承自 microsoft.graph.servicePrincipal |
| ownedObjects | directoryObject collection | 此代理标识蓝图主体拥有的目录对象。 只读。 可为 Null。 支持 $expand 和 $filter (/$count eq 0、 /$count ne 0、 /$count eq 1) /$count ne 1 。 继承自 microsoft.graph.servicePrincipal |
| owners | directoryObject collection | 作为此代理标识蓝图主体所有者的目录对象。 所有者是一组允许修改此对象的非管理员用户或 servicePrincipal。 支持 $expand 和 $filter (/$count eq 0、 /$count ne 0、 /$count eq 1) /$count ne 1 。 继承自 microsoft.graph.servicePrincipal |
| 赞助商 | directoryObject collection | 此代理标识蓝图主体的发起方。 发起者是可以授权和管理代理标识实例生命周期的用户或服务主体。 |
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"
}
}