包表示组织目录中的代理或工具,例如插件、MCP 服务器或技能。 程序包管理 API 使 IT 管理员能够查看和管理整个组织中的代理和工具。 此 API 提供终结点来列出代理和工具,并检索有关单个包的详细信息,包括元数据和详细元素。 默认情况下,列出程序包仅返回包含代理的游戏。 若要列出包含工具的标题,请按元素类型进行筛选。 API 不返回 Power Platform 连接器。
重要
访问程序包管理 API 需要 Microsoft Agent 365 许可证。
关键功能
- 检索组织内代理和工具的清单,可选择按以下内容进行筛选:
- (Copilot、Outlook、Teams) 托管
- 平台 (Copilot Studio、智能 智能 Microsoft 365 Copilot 副驾驶® 副驾驶®代理生成器)
- 上次更新时间
- 包中包含的元素类型,包括机器人 (代理类型、声明式代理以及插件、MCP 服务器和技能) (更多) 和工具类型。
- 请求状态或请求类型,用于查看组织中的用户请求的代理和工具。
- 检索特定代理或工具的更多元数据。
- 检索包详细信息时,检查代理请求的显式受让人和创建时间。
- 按暂存游戏和版本 (预览) 拒绝待处理的包游戏提交。
- 阻止、取消阻止和重新分配包的所有权。
- 发现策略模板、读取保存的设置并完成适用选项、显式更新或复制自定义模板,以及为一个发布请求自定义策略而不保存它们。
- 检查确切的挂起版本及其请求元数据,并发布具有可用性和可选购置受众的常规程序包。
- 批准单个请求,为其经理激活代理模板,或恢复符合条件的软删除包。
beta 版发布操作返回工作流结果,而不是更新的包。 可选的常规包获取独立于发布可用性,替换管理员获取受众,并异步传播;它不保证主机安装或授予许可。 已部署的包跳过获取,而不应用提供的安装受众。
示例场景
- 组织管理员检索所有代理的清单。
- 管理员审查程序包详细信息,包括可用性和部署状态。
- 管理员审查用户请求的代理,以便他们可以对待处理的需求进行会审。
- 管理员检查代理请求的显式受让人,并拒绝 Beta 版中待处理的包游戏提交。
- 管理员检索组织中插件、MCP 服务器和技能的清单。
- 管理员审查 MCP 服务器的挂起请求。
- 管理员审阅代理元素详细信息,包括 declarativeAgent 或 customEngineAgent 元素对象。
- 管理员阻止包以防止它在整个组织中使用。
- 当员工离开组织时,管理员会重新分配包所有权。
- 管理员为挂起的程序包版本选择适用的策略模板和发布受众。
- 管理员将模板保存的选定设置与其完整的适用定义目录分开读取。
- 管理员将更改保存到现有可写自定义模板,或将服务器上的更改复制到新的自定义模板中。
- 管理员为发布提供完整的请求本地策略配置;稍后激活将使用新保存的设置及其所需的模板 ID。
- 在发布已知尚未获取的常规包时,管理员可以选择单独的获取受众。
- 管理员选择单个访问或雇用请求的标识符和存储版本进行审批。
- 管理员为经理受众激活已加入的模板,而无需创建实例或批准单个请求。
- 管理员使用保留的标识符还原符合条件的软删除的包;取消阻止是一个不同的操作。
API 列表
| 操作 | HTTP 方法 | 说明 |
|---|---|---|
| 列出包 | 获取 /copilot/admin/catalog/packages |
获取组织中的代理,以及插件、MCP 服务器和技能等工具(可选)。 |
| 获取程序包详细信息 | 获取 /copilot/admin/catalog/packages/{id} |
获取特定代理或工具的详细元数据。 |
| 更新程序包 (预览) | 修补 /copilot/admin/catalog/packages/{id} |
更新包元数据。 |
| 阻止 (预览) | 发布 /copilot/admin/catalog/packages/{id}/block |
阻止包以防止其使用。 |
| 取消阻止 (预览) | 发布 /copilot/admin/catalog/packages/{id}/unblock |
取消阻止包以允许其使用。 |
| 重新分配 (预览) | 发布 /copilot/admin/catalog/packages/{id}/reassign |
将包的所有权重新分配给其他用户。 |
| 列出程序包请求 | 获取 /copilot/admin/catalog/packages |
获取组织中代理和工具的活动请求。 |
| 获取代理请求详细信息 | 获取 /copilot/admin/catalog/packages/{id} |
获取特定代理请求的详细元数据。 |
| 列出策略模板 ( beta 版) | 获取 /copilot/admin/catalog/policyTemplates |
获取租户策略模板元数据。 |
| 获取策略模板 (建议的 beta 版合同) | 获取 /copilot/admin/catalog/policyTemplates/{policyTemplateId} |
读取一个模板并保存所选配置。 |
| 列出策略定义 ( 拟议的 beta 版合同) | 获取 /copilot/admin/catalog/policyTemplates/{policyTemplateId}/policyDefinitions |
阅读一个模板的完整适用系列和选项。 |
| 更新策略模板 (建议的 beta 版合同) | 修补 /copilot/admin/catalog/policyTemplates/{policyTemplateId} |
将受保护的更改保存到现有可写自定义模板。 |
| 复制策略模板 (建议的 beta 版协定) | 发布 /copilot/admin/catalog/policyTemplates/{policyTemplateId}/copy |
将服务器上的源复制到新的自定义模板中;返回新的 ID。 |
| 发布 (测试版) | 发布 /copilot/admin/catalog/packages/{id}/publish |
发布具有可用性、策略模板和可选常规程序包获取的挂起版本。 |
| 批准 (审阅的 beta 版合同) | 发布 /copilot/admin/catalog/packages/{id}/approve |
使用存储的请求 ID 和版本批准一个当前个人访问或雇用请求。 |
| 激活 (已审阅的 beta 版合约) | 发布 /copilot/admin/catalog/packages/{id}/activate |
为经理受众激活代理模板;不请求审批或实例创建。 |
| 还原 (已审阅的 beta 版合同) | 发布 /copilot/admin/catalog/packages/{id}/restore |
还原符合条件的软删除包;不是取消阻止或已删除项目发现。 |
| 拒绝包标题 (预览) | 发布 /copilot/admin/catalog/packages/{packageId}/reject |
拒绝待处理的暂存包游戏/版本提交。 |
资源
- copilotPackage 资源
- copilotPackageDetail 资源
- copilotPackagePolicyTemplate 资源 (beta)
- copilotPackagePolicyDefinition 资源 (建议的 beta 版合同)
- copilotPackagePolicyConfiguration 复杂类型 (建议的 beta 版协定)
- copilotPackagePublishResult 复杂类型 (beta)
- copilotPackageRequestMetadata 复杂类型 (beta)
- copilotPackageActivationResult 复杂类型 (已审阅 beta 版协定)