管理员的 Power Platform V2

Microsoft Power Platform中所有管理功能的统一连接器

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 标准 所有 Power Automate 区域
逻辑应用程序 标准 所有 逻辑应用区域
Power Apps 标准 所有 Power Apps 区域
Power Automate 标准 所有 Power Automate 区域
联系人​​
Name Microsoft 支持部门
URL https://admin.powerplatform.microsoft.com/support
Email support@microsoft.com
连接器元数据
发布者 Microsoft
Website https://admin.powerplatform.com
隐私策略 https://admin.powerplatform.com/privacy
类别 IT作

管理员的 Power Platform V2

Power Platform for Admins V2 连接器是 Power Platform 客户的管理和控制平面管理的下一个演变。 利用 Microsoft Power Platform API,此连接器将定期刷新,以便从 Power Platform 管理中心获得最新且最强大的功能。

服务主体身份验证

大多数作都支持服务主体身份验证,但在使用此连接器建立连接之前,它确实需要其他设置。 有关详细信息,请访问 使用 PowerShell 创建服务主体应用程序

已知问题和限制

  1. 创建计费策略时不支持服务主体身份验证。 需要对这些作使用 OAuth 连接。
  2. 某些作(如建议)要求为租户中的至少一个环境启用托管环境。

正在创建连接

连接器支持以下身份验证类型:

OAuth 连接 OAuth 连接 所有区域 不可共享
服务主体连接 服务主体连接 所有区域 可共享
默认值 [已弃用] 此选项仅适用于没有显式身份验证类型的较旧连接,并且仅用于向后兼容性。 所有区域 不可共享

OAuth 连接

身份验证 ID:oauth2-auth

适用:所有区域

OAuth 连接

这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。

服务主体连接

身份验证 ID:oAuthClientCredentials

适用:所有区域

服务主体连接

这是可共享的连接。 如果 Power App 与其他用户共享,则连接也会共享。 有关详细信息,请参阅画布应用的 Connectors 概述 - Power Apps |Microsoft Docs

Name 类型 Description 必选
客户 ID 字符串 True
客户端密码 securestring True
租户 字符串 True

默认值 [已弃用]

适用:所有区域

此选项仅适用于没有显式身份验证类型的较旧连接,并且仅用于向后兼容性。

这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

上传网站的证书

验证并上传指定网站的 SSL 或托管证书。 证书文件和密码必须作为多部分形式数据提供。

下载 Maker 评估快照

下载与特定制造商评估测试作为 ZIP 文件运行的机器人内容快照。

下载代理通道清单

将指定代理和通道的通道清单包下载为 zip 文件。 目前仅支持“M365”通道。

为指定环境启用托管治理

为指定环境启用托管治理。

为指定环境执行 DR 演练

为指定环境执行 DR 演练。

为环境分配和解除分配货币

能够分配和解除分配环境的货币。

为网站启用的印花启动版本 5 (5) 状态

为网站启用的 Stamp bootstrap 版本 5 (5) 状态。

从Power Pages网站中删除允许的 IP 地址

从网站的 IP 限制允许列表中删除指定的 IP 地址。

从环境组中删除环境

能够从环境组中删除环境。

从现有策略中删除规则集

从现有策略中删除规则集。

从网站中删除自定义域

从网站中删除指定的自定义主机名,并清理关联的 SSL 绑定和 AFD 配置。

以管理员身份获取应用

返回 PowerApp。

以管理员身份获取应用

返回应用列表。

使用分页和筛选选项获取每个流容量源数据的用户

能够使用分页和筛选选项获取每个流容量源数据的用户。

使用筛选器检索云流

返回云流的列表。

使用筛选器检索流作

返回流作的列表。

修改指定环境的 SKU

修改指定环境的 SKU。

停止Power Pages网站

停止给定网站 ID 的网站。

切换Power Pages网站的 AFD 流量路由

切换门户Azure Front Door和 Web 应用之间的流量路由。 如果 enableAFD 为 true,请启用 AFD 终结点并将服务标记限制添加到 Web 应用。 如果为 false,则删除服务标记并禁用 AFD 终结点。

列出 Maker 评估测试运行

列出机器人的所有制造商评估测试运行。

列出 Maker 评估测试集

检索指定环境中的机器人的测试集列表。

列出Power Pages网站

获取环境中所有网站的列表。

列出基于规则的策略

列出租户中可用的基于规则的策略。

列出基于规则的策略分配

列出具有规则集详细信息的租户的规则分配。

列出特定环境的基于规则的策略分配

列出特定环境的规则分配。

列出特定环境组的基于规则的策略分配

列出环境组的规则分配。

列出特定策略的基于规则的策略分配

列出具有规则集详细信息的策略的规则分配。

列出环境中的连接

检索指定环境中的连接列表。

列出环境中的连接器

检索指定环境中的连接器列表。

列出环境组

能够列出环境组。

列出环境组角色分配

检索指定环境组的角色分配列表。 预览版。

列出环境角色分配

检索指定环境的角色分配列表。 预览版。

列出租户的可安装应用程序包

获取租户的可用应用程序包列表。

列出租户的规则集

返回具有 OData 分页支持的给定租户下的所有规则集。

列出租户的跨租户连接报告

能够列出租户的跨租户连接报告。

列出网站的自定义主机名

返回为指定网站配置的自定义主机名列表。

列出角色分配

检索角色分配的列表。 预览版。

列出角色定义

检索角色定义列表。 预览版。

创建 ISV 协定

创建 ISV 协定。

创建Power Pages网站

触发新网站的创建。

创建基于环境组规则的分配

为环境组创建基于规则的策略分配。

创建基于环境规则的分配

为环境创建基于规则的策略分配。

创建基于规则的策略

使用规则集和元数据创建基于规则的策略。

创建或更新环境资源的资源阈值

能够创建或更新环境资源的资源阈值。

创建指定环境的备份

创建指定环境的备份。

创建环境管理设置

能够创建环境管理设置。

创建环境组

能够创建环境组。

创建环境组角色分配

为指定的环境组创建新的角色分配。 预览版。

创建环境角色分配

为指定环境创建新的角色分配。 预览版。

创建规则集

为环境组创建规则集。

创建角色分配

创建新的角色分配。 预览版。

删除 DSR 符合性的审批

删除 DSR 符合性的审批和关联记录。

删除 DSR 符合性连接

删除 DSR 符合性的连接。

删除 ISV 协定

删除 ISV 协定。

删除Power Pages网站

通过指定网站 ID 触发网站删除。

删除Power Pages网站上的 Web 应用程序防火墙自定义规则

删除给定网站上的 Web 应用程序防火墙自定义规则。

删除与网站关联的证书

从网站中删除由给定指纹和类型标识的证书。

删除指定的备份

删除指定的备份。

删除环境组

能够删除环境组。

删除环境组角色分配

按 ID 删除指定环境组的角色分配。 预览版。

删除环境角色分配

按 ID 删除指定环境的角色分配。 预览版。

删除用于 DSR 符合性的 AI 模型提示

删除用于 DSR 符合性的 AI 模型提示符。

删除符合 DSR 的流

删除 M365 Copilot工作流环境中的流,以满足 DSR 合规性。

删除规则集

删除规则集。 只有租户管理员可以删除。

删除角色分配

按 ID 删除角色分配。 预览版。

删除计费策略

能够删除计费策略。

刷新计费策略预配状态

能够刷新计费策略预配状态。

取消链接环境中的计费策略 ID

能够取消链接环境中的计费策略 ID。

向网站添加 SSL 绑定

将指定的证书指纹绑定到网站的自定义域主机名。

启动Power Pages网站

启动给定网站 ID 的网站。

在 Copilot Studio 中删除机器人

删除机器人。

在Power Pages网站上创建 Web 应用程序防火墙规则

在给定网站上创建 Web 应用程序防火墙规则。

在Power Pages网站上启用 Web 应用程序防火墙

在给定网站上启用 Web 应用程序防火墙。

在Power Pages网站上添加允许的 IP 地址

这些 IP 地址将能够访问网站。

在Power Pages网站上禁用 Web 应用程序防火墙

在给定网站上禁用 Web 应用程序防火墙。

在指定的环境中启用灾难恢复

在指定的环境中启用灾难恢复。

在租户级别创建计费策略

能够在租户级别创建计费策略。

基于修补规则的策略

允许向现有策略添加或更新一个或多个规则集。

存储警告阈值

存储警告阈值的功能。

对Power Pages网站执行快速扫描

对Power Pages网站执行快速扫描。

对指定环境执行故障回复

对指定环境执行故障回复,将其从当前(配对)区域切换回其原始主要区域。 这是强制故障转移的反函数。

对指定的环境执行强制故障转移

将环境故障转移到 LastSyncTime 的配对区域。

将 Dataverse 实例链接到现有环境

将 Dataverse 实例链接到现有环境。

将指定的环境还原到以前的备份

将指定的环境还原到以前的备份。

将机器人设置为未隔离

将机器人的隔离状态设置为 false。

将机器人设置为隔离

将机器人的隔离状态设置为 true。

将环境从指定的源复制到目标

将环境从指定的源复制到目标。

将环境添加到环境组

能够将环境添加到环境组。

将系统管理员角色应用于所选用户

能够将系统管理员角色应用于所选用户。

将自定义域添加到网站

将指定的自定义主机名添加到网站。

将计费策略 ID 与环境链接

能够将计费策略 ID 与环境链接。

将试用版 Power Pages 网站转换为生产

将试用网站转换为生产网站。

应用财务和运营版本

将指定的 Finance and Operations 应用程序版本作为长时间运行的操作应用于环境。

开始在目标环境中安装应用程序包

将应用包的唯一名称安装到目标环境中。

开始深入扫描Power Pages网站

开始对Power Pages网站进行深入扫描。

恢复已删除的环境

恢复已删除的环境。

执行建议作

对一组建议资源执行建议作。

按 ID 删除指定环境

按 ID 删除指定的环境。

按 ID 更新基于规则的策略

按 ID(包括规则集和元数据)更新策略。

按 ID 检索单个环境(预览版)

能够按 ID 检索单个环境(预览版)。

按 ID 获取 Maker 评估测试运行

获取特定制造商评估测试运行的状态和结果。

按 ID 获取 Maker 评估测试集

获取机器人的创建者评估的特定测试集。

按 ID 获取基于规则的策略

按 ID 获取策略详细信息,包括规则集和元数据。

按 ID 获取环境管理设置

能够按 ID 获取环境管理设置。

按 ID 获取连接器

按指定环境中的 ID 检索特定连接器。

按主机名列出网站的 SSL 绑定

返回与网站上的指定主机名关联的 SSL 绑定(证书指纹)。

按工作流 ID 检索流运行

返回流运行的列表。

按权利和用户 ID 获取资源消耗

能够按权利和用户 ID 获取资源消耗。

按权利和资源 ID 获取租户用户消耗

能够按权利和资源 ID 获取租户用户消耗。

按标识符获取 ISV 协定(ID)

按标识符(ID)获取 ISV 协定。

按环境获取租户的权利

能够按环境获取租户的权利。

按租户的报告 ID 获取跨租户连接报告

能够按租户的报告 ID 获取跨租户连接报告。

按策略 ID 获取租户级别的计费策略

能够按策略 ID 在租户级别获取计费策略。

按类别和存储实体名称筛选的存储警告阈值

能够按类别和存储实体名称筛选的存储警告阈值。

按类别筛选的存储警告阈值

能够按类别筛选存储警告阈值。

按类型获取月份的临时货币计数和限制

能够按类型获取月份的临时货币计数和限制。

更新 ISV 协定

更新 ISV 协定。

更新Power Pages网站上的 Web 应用程序防火墙策略设置

更新给定网站上的策略级 Web 应用程序防火墙设置(强制模式和 JavaScript/CAPTCHA 质询 Cookie 生存期)。 仅应用请求正文中提供的字段;省略的字段保持不变。

更新环境的货币分配和强制规则

能够更新环境的货币分配和强制规则。

更新环境管理设置上的字段

能够更新环境管理设置上的字段。

更新环境组

能够更新环境组。

更新租户级别的计费策略

能够在租户级别更新计费策略。

更新网站的站点可见性的安全组

更新网站的站点可见性安全组。

更新网站的网站可见性

更新网站的网站可见性。

更新规则集

更新规则集。

更新财务和运营维护设置

更新由 Power Platform 管理中心管理的环境的 F&O 维护设置。

查询 Power Platform 资源

使用 ARG 分页针对 Azure Resource Graph 执行 KQL 查询。

检索环境列表(预览版)

返回可供经过身份验证的用户使用的环境列表。

生成或提取跨租户连接报告

能够生成或提取跨租户连接报告。

禁用指定环境中的灾难恢复

禁用指定环境中的灾难恢复。

禁用指定环境的托管治理

禁用指定环境的托管治理。

网站的戳记数据模型版本

为网站标记数据模型版本。

获取 DSR 导出的 AI 模型提示

返回 DSR 符合性导出的 AI 提示记录。

获取 DSR 导出的审批

返回 DSR 符合性导出的审批记录。

获取 DSR 导出的对话脚本

返回 DSR 符合性导出的对话脚本。

获取 DSR 导出的对话脚本(环境范围)

返回给定环境的聊天脚本。

获取 DSR 导出的流

返回调用用户拥有的用于 DSR 导出的流。

获取 DSR 导出的流运行

返回 DSR 导出流的流运行记录。

获取 DSR 导出的流运行操作

返回特定流运行的操作历史记录。

获取 DSR 导出的流运行操作(环境范围)

返回环境中流运行的操作历史记录。

获取 DSR 导出的流运行(环境范围)

返回环境中的流运行记录。

获取 DSR 导出的运行历史记录客户数据

返回流运行的运行历史记录客户数据。

获取 DSR 导出的运行历史记录客户数据(环境范围)

返回环境中流运行的运行历史记录数据。

获取 DSR 导出的连接

返回 DSR 符合性导出的用户连接。

获取 Web 应用程序防火墙状态

获取与给定网站关联的 Web 应用程序防火墙的状态。

获取 Web 应用程序防火墙规则

获取与给定网站关联的 Web 应用程序防火墙规则。

获取Power Pages网站的允许 IP 地址

返回网站的 IP 限制允许列表中的 IP 地址列表。

获取Power Pages网站的深度扫描分数

获取Power Pages网站的深度扫描分数。

获取Power Pages网站的深度扫描报告

获取Power Pages网站的深度扫描报告。

获取与网站关联的证书

返回与指定网站关联的证书列表,按证书类型进行筛选。

获取以前触发的安装的轮询状态

按作 ID 获取作的安装进度。

获取可作为目标环境复制的环境列表

获取可作为目标环境复制的环境的列表。

获取可供安装的应用程序包列表

列出具有 OData 筛选的目标环境的可用应用包。

获取可用于为范围分配的权利

能够获取可用于为范围分配的权利。

获取可用的财务和运营版本

检索可用于环境的 Finance 和 Operations 应用程序版本的列表。

获取建议

获取租户的建议列表。

获取建议资源

获取租户建议的资源列表。

获取所有环境中的权利的租户资源

能够获取所有环境中权利的租户资源。

获取所有环境的货币分配和强制规则

能够获取所有环境的货币分配和强制规则。

获取指定权利的所有资源阈值

能够获取指定权利的所有资源阈值。

获取指定权利的租户用户权利快照列表

能够获取指定权利的租户用户权利快照列表。

获取指定权利租户的许可证趋势

能够获取租户的指定权利的许可证趋势。

获取指定环境的备份列表

获取指定环境的备份。

获取指定环境的完整业务连续性状态快照

获取包括 LastSyncTime 在内的业务连续性快照。

获取指定环境的还原候选项列表

获取从指定环境还原时还原候选项的列表。

获取操作状态

能够获取作状态。

获取机器人隔离状态

检索机器人的隔离状态。

获取权利的环境资源权利快照

能够获取权利的环境资源权利快照。

获取每个流容量源用户上下文摘要

能够获取每个流容量源用户上下文摘要。

获取每个流容量源用户的流上下文摘要

能够获取每个流容量源的用户的流上下文摘要。

获取每个流容量源的用户的租户上下文摘要

能够获取每个流容量源的用户的租户上下文摘要。

获取特定环境的环境生命周期操作列表

列出特定环境的环境生命周期作。

获取特定用户每个流容量源的用户上下文摘要

能够获取特定用户每个流容量源的用户上下文摘要。

获取特定用户的每个流容量源的流上下文摘要

能够获取特定用户的每个流容量源的流上下文摘要。

获取环境生命周期操作的状态

获取环境生命周期作的状态。

获取环境的货币分配

能够获取环境的货币分配。

获取环境的货币分配和强制规则

能够获取环境的货币分配和强制规则。

获取环境的链接计费策略详细信息

能够获取环境的链接计费策略详细信息。

获取环境组

能够获取环境组。

获取环境组的规则集

返回给定环境组的规则集。

获取环境预配支持的位置列表

获取环境预配支持的位置列表。

获取用于在位置进行预配的可用货币列表

检索位置中的环境预配的可用货币。

获取用于在某个位置进行预配的可用模板列表

检索位置中的环境预配的可用模板。

获取用于在某个位置进行预配的可用语言列表

检索位置中的环境预配的可用语言。

获取租户的 FinOps 许可证摘要(V2)

能够获取租户的 FinOps 许可证摘要(V2)。

获取租户的 ISV 合同列表

获取租户的 ISV 合同列表。

获取租户的权利详细信息

能够获取租户的权利详细信息。

获取租户的租户容量详细信息

能够获取租户的租户容量详细信息。

获取租户的计费策略列表

能够获取租户的计费策略列表。

获取租户的货币报表

能够获取租户的货币报表。

获取范围的保留权利

能够获取范围的保留权利。

获取财务和运营操作错误

检索财务和操作环境的最新操作错误。

获取财务和运营环境属性

检索财务和操作环境属性,例如 AOS 计数、部署类型和演示数据集。

获取财务和运营维护设置

检索由 Power Platform 管理中心管理的环境的 F&O 维护设置。

获取连接器许可绕过

获取机器人的管理员连接器许可绕过设置。

获取链接到计费策略的环境

能够获取链接到计费策略的环境。

获取链接到计费策略的环境列表

能够获取链接到计费策略的环境列表。

获取限定为特定环境的生命周期操作的状态

获取在特定环境中范围内的环境生命周期操作的状态,从而在操作查找上启用环境级授权。

设置作用域的分配

能够设置范围的分配。

设置连接器许可绕过

为机器人设置管理员连接器许可绕过设置。

运行 Maker 评估测试集

触发特定测试集的创建者评估测试运行。

通过指定其唯一标识符(ID)获取Power Pages网站详细信息

使用指定的网站 ID 获取网站详细信息。

通过证书指纹删除网站的 SSL 绑定

从网站中删除指定主机名和证书指纹的 SSL 绑定。

重启Power Pages网站

重启给定站点 ID 的网站。

重新分配机器人的所有者

重新分配机器人的所有者。

重置环境

重置指定的环境。

预配新环境

预配新环境。

上传网站的证书

验证并上传指定网站的 SSL 或托管证书。 证书文件和密码必须作为多部分形式数据提供。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

证书类型
certType True string

证书的类型(例如 SSL、MANAGED)。

Api-version
api-version True string

API 版本。

证书文件
file file

证书文件 (.pfx)。

密码
password string

证书密码。

返回

上传的证书的指纹。

response
string

下载 Maker 评估快照

下载与特定制造商评估测试作为 ZIP 文件运行的机器人内容快照。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

测试运行 ID
TestRunId True uuid

测试运行 ID。

Api-version
api-version True string

API 版本。

返回

response
binary

下载代理通道清单

将指定代理和通道的通道清单包下载为 zip 文件。 目前仅支持“M365”通道。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

代理 ID
AgentId True uuid

机器人 ID。

通道名称
ChannelName True string

通道名称。 目前仅支持“M365”。

包括代理架构
includeAgentSchema boolean

是否在下载的清单包中包含代理架构。

Api-version
api-version True string

API 版本。

返回

response
binary

为指定环境启用托管治理

为指定环境启用托管治理。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

为指定环境执行 DR 演练

为指定环境执行 DR 演练。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

为环境分配和解除分配货币

能够分配和解除分配环境的货币。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

currencyType
currencyType string

可分配给环境的可用货币类型。

分配
allocated integer

指定货币计数。

返回

响应正文包括环境 ID 和分配的货币。

为网站启用的印花启动版本 5 (5) 状态

为网站启用的 Stamp bootstrap 版本 5 (5) 状态。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

从Power Pages网站中删除允许的 IP 地址

从网站的 IP 限制允许列表中删除指定的 IP 地址。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

IP地址
IpAddress string

IP 地址或 CIDR 范围(例如“208.130.0.0/16”)

IpAddressType
IpAddressType string

IP 地址的类型

从环境组中删除环境

能够从环境组中删除环境。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True uuid

组 ID。

环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

从现有策略中删除规则集

从现有策略中删除规则集。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

Api-version
api-version True string

API 版本。

姓名
name string

策略的名称。

id
id string

规则集的唯一标识符。

版本
version string

规则集的版本。

输入
inputs object

规则集的输入可能会因规则而异。

返回

Body
Policy

从网站中删除自定义域

从网站中删除指定的自定义主机名,并清理关联的 SSL 绑定和 AFD 配置。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

主机名
hostName True string

要从网站中删除的自定义主机名。

Api-version
api-version True string

API 版本。

以管理员身份获取应用

返回 PowerApp。

参数

名称 密钥 必需 类型 说明
环境名称
environmentId True string

环境的名称字段。

PowerApp 名称
app True string

PowerApp 的名称字段。

Api-version
api-version True string

API 版本。

返回

Body
PowerApp

以管理员身份获取应用

返回应用列表。

参数

名称 密钥 必需 类型 说明
环境名称
environmentId True string

环境的名称字段。

页面大小
$top integer

响应中的应用数。

跳过令牌
$skiptoken string

获取下一页的响应。

Api-version
api-version True string

API 版本。

返回

使用分页和筛选选项获取每个流容量源数据的用户

能够使用分页和筛选选项获取每个流容量源数据的用户。

参数

名称 密钥 必需 类型 说明
开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

页码
pageNumber integer

分页的页码。

页面大小
pageSize integer

分页的页面大小。

用户 ID
userId string

按用户标识符进行筛选。

流上下文
flowContext string

按流上下文进行筛选。

流许可证分类
flowLicenseCategorization string

按流许可证分类进行筛选。

资源 ID
resourceId string

按资源标识符进行筛选。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

每个流容量源记录的用户分页结果容器。

使用筛选器检索云流

返回云流的列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

工作流 ID
workflowId uuid

工作流 ID。

资源 ID
resourceId uuid

资源 ID。

创建者
createdBy uuid

创建者 Dataverse ID。

所有者 ID
ownerId uuid

所有者 Dataverse ID。

在开始日期创建
createdOnStartDate date

筛选在此日期或之后创建的日期。

在结束日期创建
createdOnEndDate date

筛选在此日期或之前创建的日期。

在开始日期修改
modifiedOnStartDate date

筛选此日期或之后的修改时间。

在结束日期修改
modifiedOnEndDate date

筛选此日期或在此日期之前修改的日期。

Api-version
api-version True string

API 版本。

返回

名称 路径 类型 说明
value
value array of CloudFlow
nextLink
nextLink string

用于检索下一页结果的 URL(如果有)。 页面大小为 250。

使用筛选器检索流作

返回流作的列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

工作流 ID
workflowId uuid

工作流 ID。

父进程阶段 ID
parentProcessStageId uuid

父进程阶段 ID。

Connector
connector string

连接器名称。

Is Trigger
isTrigger boolean

指示作是否为触发器。 如果未设置,则不筛选。

参数名称
parameterName string

在参数名称字段中搜索的关键字。

参数值
parameterValue string

要在参数值字段中搜索的关键字。

确切
exact boolean

对 parameterName 和 parameterValue 使用完全匹配。

Api-version
api-version True string

API 版本。

返回

名称 路径 类型 说明
value
value array of FlowAction
nextLink
nextLink string

用于检索下一页结果的 URL(如果有)。 页面大小为 250。

修改指定环境的 SKU

修改指定环境的 SKU。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

environmentSku
environmentSku True string

环境 SKU。

停止Power Pages网站

停止给定网站 ID 的网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

切换Power Pages网站的 AFD 流量路由

切换门户Azure Front Door和 Web 应用之间的流量路由。 如果 enableAFD 为 true,请启用 AFD 终结点并将服务标记限制添加到 Web 应用。 如果为 false,则删除服务标记并禁用 AFD 终结点。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

启用 F D
enableAFD True boolean

如果启用 AFD 路由,则为 true,则为 false 以禁用。

Api-version
api-version True string

API 版本。

返回

列出 Maker 评估测试运行

列出机器人的所有制造商评估测试运行。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

创建者评估测试运行的集合。

列出 Maker 评估测试集

检索指定环境中的机器人的测试集列表。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

制造商评估测试集的集合。

列出Power Pages网站

获取环境中所有网站的列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

跳过
skip string

返回剩余项之前要跳过的项数。

Api-version
api-version True string

API 版本。

返回

列出基于规则的策略

列出租户中可用的基于规则的策略。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

列出基于规则的策略分配

列出具有规则集详细信息的租户的规则分配。

参数

名称 密钥 必需 类型 说明
包括规则集计数
includeRuleSetCounts True boolean

用于在响应中包含规则集计数的标志。

Api-version
api-version True string

API 版本。

返回

列出特定环境的基于规则的策略分配

列出特定环境的规则分配。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境组的唯一标识符。

包括规则集计数
includeRuleSetCounts True boolean

用于在响应中包含规则集计数的标志。

Api-version
api-version True string

API 版本。

返回

列出特定环境组的基于规则的策略分配

列出环境组的规则分配。

参数

名称 密钥 必需 类型 说明
环境组 ID
environmentGroupId True string

环境组的唯一标识符。

包括规则集计数
includeRuleSetCounts True boolean

用于在响应中包含规则集计数的标志。

Api-version
api-version True string

API 版本。

返回

列出特定策略的基于规则的策略分配

列出具有规则集详细信息的策略的规则分配。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

包括规则集计数
includeRuleSetCounts True boolean

用于在响应中包含规则集计数的标志。

Api-version
api-version True string

API 版本。

返回

列出环境中的连接

检索指定环境中的连接列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

Api-version
api-version True string

API 版本。

返回

列出环境中的连接器

检索指定环境中的连接器列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

$过滤器
$filter True string

筛选查询以指定环境。

Api-version
api-version True string

API 版本。

返回

列出环境组

能够列出环境组。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

列出环境组角色分配

检索指定环境组的角色分配列表。 预览版。

参数

名称 密钥 必需 类型 说明
环境组 ID
environmentGroupId True string

环境组的唯一标识符。

Api-version
api-version True string

API 版本。

返回

角色分配。

列出环境角色分配

检索指定环境的角色分配列表。 预览版。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的唯一标识符。

Api-version
api-version True string

API 版本。

返回

角色分配。

列出租户的可安装应用程序包

获取租户的可用应用程序包列表。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

列出租户的规则集

返回具有 OData 分页支持的给定租户下的所有规则集。

参数

名称 密钥 必需 类型 说明
$select
$select string

OData 选择查询选项。

$过滤器
$filter string

OData 筛选器查询选项。

$expand
$expand string

OData 展开查询选项。

$skiptoken
$skiptoken string

OData 跳过分页的令牌。

$top
$top integer

用于限制结果的 OData 顶级查询选项。

Api-version
api-version True string

API 版本。

返回

具有延续支持的 OData 响应包装器。

列出租户的跨租户连接报告

能够列出租户的跨租户连接报告。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

列出网站的自定义主机名

返回为指定网站配置的自定义主机名列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

名称 路径 类型 说明
array of string

列出角色分配

检索角色分配的列表。 预览版。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

角色分配。

列出角色定义

检索角色定义列表。 预览版。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

分配的可用角色定义。

创建 ISV 协定

创建 ISV 协定。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

姓名
name True string
状态
status True string

所需的 ISV 协定状态。

地区
geo True string

用于创建计费帐户的资源位置。 不可变。

tenantId
tenantId uuid

客户租户的 ID。

allowOtherPremiumConnectors
allowOtherPremiumConnectors boolean

是否可以将按流量计费的使用情况归咎于高级连接器。

姓名
name string

API 连接器的名称。

订阅编号
subscriptionId uuid

租户订阅 ID。

resourceGroup
resourceGroup string

租户订阅中的资源组。

id
id string
cloudFlowRunsPayAsYouGoState
cloudFlowRunsPayAsYouGoState string

返回

创建Power Pages网站

触发新网站的创建。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

dataverseOrganizationId
dataverseOrganizationId True uuid

Dataverse 组织的唯一标识符(ID)

姓名
name True string

网站的名称

模板名称
templateName True string

网站模板名称

selectedBaseLanguage
selectedBaseLanguage True integer

语言 ID - https://go.microsoft.com/fwlink/?linkid=2208135

子域
subdomain True string

网站 URL 的子域

websiteRecordId
websiteRecordId string

网站的 Dataverse 记录唯一标识符(ID)

创建基于环境组规则的分配

为环境组创建基于规则的策略分配。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

组 ID
groupId True string

环境组的唯一标识符。

Api-version
api-version True string

API 版本。

resourceId
resourceId True string

资源 ID(例如环境组 ID)。

resourceType
resourceType True string

资源类型。

behaviorType
behaviorType True string

行为类型。

返回

创建基于环境规则的分配

为环境创建基于规则的策略分配。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

环境 ID
environmentId True string

环境的唯一标识符。

Api-version
api-version True string

API 版本。

resourceId
resourceId True string

资源 ID(例如环境组 ID)。

resourceType
resourceType True string

资源类型。

behaviorType
behaviorType True string

行为类型。

返回

创建基于规则的策略

使用规则集和元数据创建基于规则的策略。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

姓名
name string

策略的名称。

id
id string

规则集的唯一标识符。

版本
version string

规则集的版本。

输入
inputs object

规则集的输入可能会因规则而异。

返回

Body
Policy

创建或更新环境资源的资源阈值

能够创建或更新环境资源的资源阈值。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

权利 ID
entitlementId True string

权利 ID。

资源 ID
resourceId True string

资源 ID。

Api-version
api-version True string

API 版本。

stopResource
stopResource boolean
limit
limit integer
stopIfOverCapacity
stopIfOverCapacity boolean
notifyIfOverCapacity
notifyIfOverCapacity boolean
notificationThreshold
notificationThreshold integer
resourceConsumption
resourceConsumption double

返回

创建指定环境的备份

创建指定环境的备份。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

Api-version
api-version True string

API 版本。

标签
label True string

手动创建的备份的标签。

返回

表示环境备份。

创建环境管理设置

能够创建环境管理设置。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

object

返回

表示此服务中 API 的响应对象。

创建环境组

能够创建环境组。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

id
id uuid
displayName
displayName string
描述
description string
parentGroupId
parentGroupId uuid
childrenGroupIds
childrenGroupIds array of uuid
createdTime (创建时间)
createdTime date-time
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string
最后修改时间
lastModifiedTime date-time
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string

返回

创建环境组角色分配

为指定的环境组创建新的角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
环境组 ID
environmentGroupId True string

环境组的唯一标识符。

Api-version
api-version True string

API 版本。

principalObjectId
principalObjectId string

要分配的主体的 ID

角色定义 ID
roleDefinitionId string

角色定义的 ID

作用域
scope string

分配范围

主体类型
principalType string

主体的类型

返回

角色分配。

创建环境角色分配

为指定环境创建新的角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的唯一标识符。

Api-version
api-version True string

API 版本。

principalObjectId
principalObjectId string

要分配的主体的 ID

角色定义 ID
roleDefinitionId string

角色定义的 ID

作用域
scope string

分配范围

主体类型
principalType string

主体的类型

返回

角色分配。

创建规则集

为环境组创建规则集。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True uuid

环境组的唯一标识符。

Api-version
api-version True string

API 版本。

id
id string

规则集的 ID。

lastModified
lastModified date-time

上次修改的时间戳。

类型
type string

环境筛选器的类型。

id
id string

环境的 ID。

类型
type string

环境的类型。

姓名
name string

环境的名称。

类型
type True string

规则集的类型。

resourceType
resourceType True string

资源的类型。

id
id string

规则 ID。

value
value string

规则值。

返回

规则集数据传输对象。

Body
RuleSetDto

创建角色分配

创建新的角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

principalObjectId
principalObjectId string

要分配的主体的 ID

角色定义 ID
roleDefinitionId string

角色定义的 ID

作用域
scope string

分配范围

主体类型
principalType string

主体的类型

返回

角色分配。

删除 DSR 符合性的审批

删除 DSR 符合性的审批和关联记录。

参数

名称 密钥 必需 类型 说明
审批 ID
approvalId True uuid

审批 ID。

Api-version
api-version True string

API 版本。

删除 DSR 符合性连接

删除 DSR 符合性的连接。

参数

名称 密钥 必需 类型 说明
连接标识符
connectionIdentifier True string

apiName/connectionName 格式的连接标识符。

Api-version
api-version True string

API 版本。

删除 ISV 协定

删除 ISV 协定。

参数

名称 密钥 必需 类型 说明
Isv 合同 ID
isvContractId True string

ISV 协定 ID。

Api-version
api-version True string

API 版本。

删除Power Pages网站

通过指定网站 ID 触发网站删除。

参数

名称 密钥 必需 类型 说明
作 - 位置
Operation-Location True string

作位置。

环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

删除Power Pages网站上的 Web 应用程序防火墙自定义规则

删除给定网站上的 Web 应用程序防火墙自定义规则。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

身体
body True array of string

自定义规则名称列表

删除与网站关联的证书

从网站中删除由给定指纹和类型标识的证书。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Thumbprint
thumbprint True string

要删除的证书的指纹。

证书类型
certType True string

证书的类型(例如 SSL、MANAGED)。

Api-version
api-version True string

API 版本。

删除指定的备份

删除指定的备份。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

备份 ID
backupId True string

备份的 ID。

Api-version
api-version True string

API 版本。

删除环境组

能够删除环境组。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True string

组 ID。

Api-version
api-version True string

API 版本。

删除环境组角色分配

按 ID 删除指定环境组的角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
环境组 ID
environmentGroupId True string

环境组的唯一标识符。

角色分配 ID
roleAssignmentId True string

角色分配的唯一标识符。

Api-version
api-version True string

API 版本。

删除环境角色分配

按 ID 删除指定环境的角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的唯一标识符。

角色分配 ID
roleAssignmentId True string

角色分配的唯一标识符。

Api-version
api-version True string

API 版本。

删除用于 DSR 符合性的 AI 模型提示

删除用于 DSR 符合性的 AI 模型提示符。

参数

名称 密钥 必需 类型 说明
提示 ID
promptId True uuid

AI 模型提示 ID。

Api-version
api-version True string

API 版本。

删除符合 DSR 的流

删除 M365 Copilot工作流环境中的流,以满足 DSR 合规性。

参数

名称 密钥 必需 类型 说明
流 ID
flowId True uuid

流 ID。

Api-version
api-version True string

API 版本。

删除规则集

删除规则集。 只有租户管理员可以删除。

参数

名称 密钥 必需 类型 说明
规则集 ID
ruleSetId True uuid

规则集的唯一标识符。

Api-version
api-version True string

API 版本。

删除角色分配

按 ID 删除角色分配。 预览版。

参数

名称 密钥 必需 类型 说明
角色分配 ID
roleAssignmentId True string

角色分配的唯一标识符。

Api-version
api-version True string

API 版本。

删除计费策略

能够删除计费策略。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

刷新计费策略预配状态

能够刷新计费策略预配状态。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

返回

取消链接环境中的计费策略 ID

能够取消链接环境中的计费策略 ID。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

environmentIds
environmentIds array of string

向网站添加 SSL 绑定

将指定的证书指纹绑定到网站的自定义域主机名。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Thumbprint
thumbprint True string

要绑定的证书的指纹。

主机名
hostName True string

要将证书绑定到的自定义域主机名。

Api-version
api-version True string

API 版本。

启动Power Pages网站

启动给定网站 ID 的网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

在 Copilot Studio 中删除机器人

删除机器人。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

在Power Pages网站上创建 Web 应用程序防火墙规则

在给定网站上创建 Web 应用程序防火墙规则。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

姓名
name string

自定义规则的名称

priority
priority integer

规则的优先级

enabledState
enabledState string

规则的状态

ruleType
ruleType string

WAF 规则类型

rateLimitDuration(分钟)
rateLimitDurationInMinutes integer

速率限制的持续时间(以分钟为单位)

rateLimitThreshold
rateLimitThreshold integer

速率限制的阈值

matchVariable 的
matchVariable string

要匹配的变量

选择器
selector string

匹配变量的选择器

操作员
operator string

匹配条件的运算符

negate条件
negateCondition boolean

是否否定条件

matchValue 匹配值
matchValue array of string

要匹配的值

变换
transforms array of string

要应用的转换

操作
action string

规则匹配时要执行的作

RuleSetType
RuleSetType string

托管规则集的类型

RuleSetVersion
RuleSetVersion string

托管规则集的版本

RuleSetAction
RuleSetAction string

要对规则集执行的作

排除事项
Exclusions array of string

规则集的排除项列表

RuleGroupName
RuleGroupName string

规则组的名称

排除事项
Exclusions array of string

规则组的排除项列表

规则编号
RuleId string

规则的 ID

EnabledState
EnabledState string

规则的状态

Action
Action string

要对规则执行的作

排除事项
Exclusions array of string

规则的排除项列表

在Power Pages网站上启用 Web 应用程序防火墙

在给定网站上启用 Web 应用程序防火墙。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

在Power Pages网站上添加允许的 IP 地址

这些 IP 地址将能够访问网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

IP地址
IpAddress string

IP 地址或 CIDR 范围(例如“208.130.0.0/16”)

IpAddressType
IpAddressType string

IP 地址的类型

在Power Pages网站上禁用 Web 应用程序防火墙

在给定网站上禁用 Web 应用程序防火墙。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

Web 应用程序防火墙状态

在指定的环境中启用灾难恢复

在指定的环境中启用灾难恢复。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

在租户级别创建计费策略

能够在租户级别创建计费策略。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

姓名
name string
位置
location string
订阅编号
subscriptionId uuid

租户订阅 ID。

resourceGroup
resourceGroup string

租户订阅中的资源组。

id
id string
状态
status string

所需的 ISV 协定状态。

返回

基于修补规则的策略

允许向现有策略添加或更新一个或多个规则集。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

Api-version
api-version True string

API 版本。

姓名
name string

策略的名称。

id
id string

规则集的唯一标识符。

版本
version string

规则集的版本。

输入
inputs object

规则集的输入可能会因规则而异。

返回

Body
Policy

存储警告阈值

存储警告阈值的功能。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

对Power Pages网站执行快速扫描

对Power Pages网站执行快速扫描。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Lcid
lcid string

网站的语言代码标识符(LCID)。

Api-version
api-version True string

API 版本。

返回

对指定环境执行故障回复

对指定环境执行故障回复,将其从当前(配对)区域切换回其原始主要区域。 这是强制故障转移的反函数。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

对指定的环境执行强制故障转移

将环境故障转移到 LastSyncTime 的配对区域。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

lastSyncTime
lastSyncTime date-time

要故障转移到的同步时间。 可选:如果为 null 或省略,则故障转移到最新的可用同步点。

将 Dataverse 实例链接到现有环境

将 Dataverse 实例链接到现有环境。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

要链接到 Dataverse 的环境 ID。

Api-version
api-version True string

API 版本。

baseLanguageCode
baseLanguageCode integer

基本语言代码(例如,英语为 1033)。

代码
code string

货币代码(例如美元)。

姓名
name string

货币名称。

符号
symbol string

货币符号。

精准率
precision integer

货币精度。

templates
templates array of string

要应用的模板。

securityGroupId
securityGroupId string

安全组 ID。

域名
domainName string

域名。

templateMetadata
templateMetadata object

为所选模板自定义的 JSON 对象有效负载。

将指定的环境还原到以前的备份

将指定的环境还原到以前的备份。

参数

名称 密钥 必需 类型 说明
目标环境 ID
targetEnvironmentId True string

将被覆盖的目标环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

restorePointDateTime
restorePointDateTime True date-time

将环境还原到的时间点。 必须包括每个 RFC 3339 的时区偏移量(例如,2025-04-30T12:34:56+02:00)。

sourceEnvironmentId
sourceEnvironmentId True string

将从中还原备份的源环境的 ID。

environmentNameToOverride
environmentNameToOverride string

要覆盖目标环境的环境名称。

securityGroupIdToOverride
securityGroupIdToOverride string

要覆盖目标环境的安全组 ID。

skipAuditData
skipAuditData boolean

用于在还原期间跳过审核数据的布尔标志。

将机器人设置为未隔离

将机器人的隔离状态设置为 false。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

将机器人设置为隔离

将机器人的隔离状态设置为 true。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

将环境从指定的源复制到目标

将环境从指定的源复制到目标。

参数

名称 密钥 必需 类型 说明
目标环境 ID
targetEnvironmentId True string

将被覆盖的目标环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

sourceEnvironmentId
sourceEnvironmentId True string

要从中复制的源环境 ID。

copyType
copyType True string

表示复制作的类型。

environmentNameToOverride
environmentNameToOverride string

要覆盖目标环境的环境名称。

securityGroupIdToOverride
securityGroupIdToOverride string

要覆盖目标环境的安全组 ID。

skipAuditData
skipAuditData boolean

用于跳过复制的审核数据的布尔标志。

executeAdvancedCopyForFinanceAndOperations
executeAdvancedCopyForFinanceAndOperations boolean

用于为财务和运营数据执行高级复制的布尔标志。

将环境添加到环境组

能够将环境添加到环境组。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True uuid

组 ID。

环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

将系统管理员角色应用于所选用户

能够将系统管理员角色应用于所选用户。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

将自定义域添加到网站

将指定的自定义主机名添加到网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Custom Domain
customDomain True string

要添加到网站的自定义主机名。

Api-version
api-version True string

API 版本。

将计费策略 ID 与环境链接

能够将计费策略 ID 与环境链接。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

environmentIds
environmentIds array of string

将试用版 Power Pages 网站转换为生产

将试用网站转换为生产网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

EnableCDN
EnableCDN boolean

为网站启用内容分发网络(CDN)

EnableWAF
EnableWAF boolean

为网站启用 Web 应用程序防火墙(WAF)

UseDynamics365PortalAddOnLicense
UseDynamics365PortalAddOnLicense boolean

使用 Dynamics 365 门户 Add-On 网站的许可证

应用财务和运营版本

将指定的 Finance and Operations 应用程序版本作为长时间运行的操作应用于环境。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

版本
version True string

要应用的 Finance 和 Operations 应用程序版本(例如 10.0.47.5)。

Api-version
api-version True string

API 版本。

返回

长时间运行的应用版本操作的已接受响应。

开始在目标环境中安装应用程序包

将应用包的唯一名称安装到目标环境中。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID(不会与组织 ID 混淆)。

唯一名称
uniqueName True string

包唯一名称。

Api-version
api-version True string

API 版本。

payloadValue
payloadValue string

返回

开始深入扫描Power Pages网站

开始对Power Pages网站进行深入扫描。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

恢复已删除的环境

恢复已删除的环境。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

执行建议作

对一组建议资源执行建议作。

参数

名称 密钥 必需 类型 说明
身体
body True dynamic

要执行的作的请求正文

作名称
actionName True string

要执行的作的名称。

Api-version
api-version True string

API 版本。

返回

针对资源执行的作的响应

按 ID 删除指定环境

按 ID 删除指定的环境。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

按 ID 更新基于规则的策略

按 ID(包括规则集和元数据)更新策略。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

Api-version
api-version True string

API 版本。

姓名
name string

策略的名称。

id
id string

规则集的唯一标识符。

版本
version string

规则集的版本。

输入
inputs object

规则集的输入可能会因规则而异。

返回

按 ID 检索单个环境(预览版)

能够按 ID 检索单个环境(预览版)。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

$select
$select string

要在响应中包括的属性的列表(以逗号分隔)。

Api-version
api-version True string

API 版本。

返回

按 ID 获取 Maker 评估测试运行

获取特定制造商评估测试运行的状态和结果。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

测试运行 ID
TestRunId True uuid

测试运行 ID。

Api-version
api-version True string

API 版本。

返回

获取评估运行详细信息请求的响应有效负载。

Body
TestRun

按 ID 获取 Maker 评估测试集

获取机器人的创建者评估的特定测试集。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

测试集 ID
TestSetId True string

测试集 ID。

Api-version
api-version True string

API 版本。

返回

获取测试集请求的响应有效负载。

Body
TestSet

按 ID 获取基于规则的策略

按 ID 获取策略详细信息,包括规则集和元数据。

参数

名称 密钥 必需 类型 说明
策略 ID
policyId True string

策略的唯一标识符。

Api-version
api-version True string

API 版本。

返回

Body
Policy

按 ID 获取环境管理设置

能够按 ID 获取环境管理设置。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境管理设置的 ID。

$top
$top integer

要检索的记录数。 如果未设置,则默认为 500。

$select
$select string

要为此实体选择的属性列表。

Api-version
api-version True string

API 版本。

返回

表示此服务中 API 的响应对象。

按 ID 获取连接器

按指定环境中的 ID 检索特定连接器。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

连接器 ID
connectorId True string

连接器的 ID。

$过滤器
$filter True string

筛选查询以指定环境。

Api-version
api-version True string

API 版本。

返回

按主机名列出网站的 SSL 绑定

返回与网站上的指定主机名关联的 SSL 绑定(证书指纹)。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

主机名
hostName True string

用于筛选 SSL 绑定依据的自定义域主机名。

Api-version
api-version True string

API 版本。

返回

按工作流 ID 检索流运行

返回流运行的列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

工作流 ID
workflowId True uuid

工作流 ID。

Api-version
api-version True string

API 版本。

返回

名称 路径 类型 说明
value
value array of FlowRun
nextLink
nextLink string

用于检索下一页结果的 URL(如果有)。 页面大小为 250。

按权利和用户 ID 获取资源消耗

能够按权利和用户 ID 获取资源消耗。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

用户 ID
userId True string

用户 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

页面大小
pageSize integer

分页的页面大小。

搜索请求
searchRequest string

用于筛选的搜索请求。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

按权利和资源 ID 获取租户用户消耗

能够按权利和资源 ID 获取租户用户消耗。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

资源 ID
resourceId True string

资源 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

页面大小
pageSize integer

分页的页面大小。

搜索请求
searchRequest string

用于筛选的搜索请求。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

按标识符获取 ISV 协定(ID)

按标识符(ID)获取 ISV 协定。

参数

名称 密钥 必需 类型 说明
Isv 合同 ID
isvContractId True string

ISV 协定 ID。

Api-version
api-version True string

API 版本。

返回

按环境获取租户的权利

能够按环境获取租户的权利。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

$过滤器
$filter string

OData 筛选器表达式。

Api-version
api-version True string

API 版本。

返回

按租户的报告 ID 获取跨租户连接报告

能够按租户的报告 ID 获取跨租户连接报告。

参数

名称 密钥 必需 类型 说明
报表 ID
reportId True string

报表 ID。

Api-version
api-version True string

API 版本。

返回

按策略 ID 获取租户级别的计费策略

能够按策略 ID 在租户级别获取计费策略。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

返回

按类别和存储实体名称筛选的存储警告阈值

能够按类别和存储实体名称筛选的存储警告阈值。

参数

名称 密钥 必需 类型 说明
存储类别
storageCategory True string

存储类别值。

实体名称
entityName True string

实体的名称。

Api-version
api-version True string

API 版本。

返回

按类别筛选的存储警告阈值

能够按类别筛选存储警告阈值。

参数

名称 密钥 必需 类型 说明
存储类别
storageCategory True string

存储类别值。

Api-version
api-version True string

API 版本。

返回

按类型获取月份的临时货币计数和限制

能够按类型获取月份的临时货币计数和限制。

参数

名称 密钥 必需 类型 说明
货币类型
currencyType True string

货币类型。

Api-version
api-version True string

API 版本。

返回

更新 ISV 协定

更新 ISV 协定。

参数

名称 密钥 必需 类型 说明
Isv 合同 ID
isvContractId True string

ISV 协定 ID。

Api-version
api-version True string

API 版本。

姓名
name string
状态
status string

所需的 ISV 协定状态。

allowOtherPremiumConnectors
allowOtherPremiumConnectors boolean

是否可以将按流量计费的使用情况归咎于高级连接器。

姓名
name string

API 连接器的名称。

cloudFlowRunsPayAsYouGoState
cloudFlowRunsPayAsYouGoState string

返回

更新Power Pages网站上的 Web 应用程序防火墙策略设置

更新给定网站上的策略级 Web 应用程序防火墙设置(强制模式和 JavaScript/CAPTCHA 质询 Cookie 生存期)。 仅应用请求正文中提供的字段;省略的字段保持不变。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

mode
mode string

Web 应用程序防火墙强制模式。 防护阻止匹配请求;检测仅记录它们。

javascriptChallengeExpirationInMinutes
javascriptChallengeExpirationInMinutes integer

JavaScript 质询 Cookie 有效期(以分钟为单位)。 接受的范围通过Azure Front Door进行验证。

captchaExpirationInMinutes
captchaExpirationInMinutes integer

CAPTCHA 质询 Cookie 有效期(以分钟为单位)。 接受的范围通过Azure Front Door进行验证。

返回

策略级 Web 应用程序防火墙设置。 所有属性都是可选的;仅应用提供的属性,并且任何省略的属性保持不变。

更新环境的货币分配和强制规则

能够更新环境的货币分配和强制规则。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

environmentId
environmentId string

环境 ID。

currencyType
currencyType string

可分配给环境的可用货币类型。

分配
allocated integer
autoAllocated
autoAllocated integer
ruleType
ruleType string
enabled
enabled boolean

返回

环境的货币分配和强制规则。

更新环境管理设置上的字段

能够更新环境管理设置上的字段。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

正在更新的环境管理设置的 ID。

Api-version
api-version True string

API 版本。

object

返回

表示此服务中 API 的响应对象。

更新环境组

能够更新环境组。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True uuid

组 ID。

Api-version
api-version True string

API 版本。

id
id uuid
displayName
displayName string
描述
description string
parentGroupId
parentGroupId uuid
childrenGroupIds
childrenGroupIds array of uuid
createdTime (创建时间)
createdTime date-time
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string
最后修改时间
lastModifiedTime date-time
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string

返回

更新租户级别的计费策略

能够在租户级别更新计费策略。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

姓名
name string
状态
status string

所需的 ISV 协定状态。

返回

更新网站的站点可见性的安全组

更新网站的站点可见性安全组。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

安全组 ID
securityGroupId string

安全组 ID。

Api-version
api-version True string

API 版本。

更新网站的网站可见性

更新网站的网站可见性。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

网站可见性
siteVisibility string

网站可见性。

Api-version
api-version True string

API 版本。

更新规则集

更新规则集。

参数

名称 密钥 必需 类型 说明
规则集 ID
ruleSetId True uuid

规则集的唯一标识符。

Api-version
api-version True string

API 版本。

id
id string

规则集的 ID。

lastModified
lastModified date-time

上次修改的时间戳。

类型
type string

环境筛选器的类型。

id
id string

环境的 ID。

类型
type string

环境的类型。

姓名
name string

环境的名称。

类型
type True string

规则集的类型。

resourceType
resourceType True string

资源的类型。

id
id string

规则 ID。

value
value string

规则值。

返回

规则集数据传输对象。

Body
RuleSetDto

更新财务和运营维护设置

更新由 Power Platform 管理中心管理的环境的 F&O 维护设置。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

Api-version
api-version True string

API 版本。

updatedMaintenanceWindowDaysOfWeek
updatedMaintenanceWindowDaysOfWeek string

一周中的一天(与 .NET System.DayOfWeek 枚举保持一致)。

updatedMaintenanceWindowCadence
updatedMaintenanceWindowCadence string

主要版本应用程序更新的节奏。

返回

财务和运营维护响应。

查询 Power Platform 资源

使用 ARG 分页针对 Azure Resource Graph 执行 KQL 查询。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

TableName
TableName True string

目标表/资源集(例如“PowerPlatformResources”)

$type
$type True string

子句类型的鉴别器。

Top
Top integer

每页的最大行数

跳过
Skip integer

抵消;使用 SkipToken 时不包括

SkipToken
SkipToken string

上一页的延续标记

返回

检索环境列表(预览版)

返回可供经过身份验证的用户使用的环境列表。

参数

名称 密钥 必需 类型 说明
IDs
ids array

要检索的环境 ID 的逗号分隔列表。 指定后,仅返回与这些 ID 匹配的环境。

$过滤器
$filter string

OData 筛选器表达式,用于限制返回的环境集。 支持的筛选器属性包括dataverseId、、typegeostate、和environmentGroupIddomainName

$select
$select string

要在响应中包括的属性的列表(以逗号分隔)。

$top
$top integer

要返回的最大环境数。

$skip
$skip integer

返回结果之前要跳过的环境数。

$orderby
$orderby string

用于对结果进行排序的 OData 排序依据表达式。

Api-version
api-version True string

API 版本。

返回

生成或提取跨租户连接报告

能够生成或提取跨租户连接报告。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

禁用指定环境中的灾难恢复

禁用指定环境中的灾难恢复。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

禁用指定环境的托管治理

禁用指定环境的托管治理。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

网站的戳记数据模型版本

为网站标记数据模型版本。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

dataModelVersionValue
dataModelVersionValue True boolean

IsNewDataModel 的数据模型版本值

获取 DSR 导出的 AI 模型提示

返回 DSR 符合性导出的 AI 提示记录。

参数

名称 密钥 必需 类型 说明
继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的审批

返回 DSR 符合性导出的审批记录。

参数

名称 密钥 必需 类型 说明
继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的对话脚本

返回 DSR 符合性导出的对话脚本。

参数

名称 密钥 必需 类型 说明
继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

包含 DSR 导出会话脚本的响应。

获取 DSR 导出的对话脚本(环境范围)

返回给定环境的聊天脚本。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

包含 DSR 导出会话脚本的响应。

获取 DSR 导出的流

返回调用用户拥有的用于 DSR 导出的流。

参数

名称 密钥 必需 类型 说明
继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的流运行

返回 DSR 导出流的流运行记录。

参数

名称 密钥 必需 类型 说明
流 ID
flowId True uuid

流 ID。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的流运行操作

返回特定流运行的操作历史记录。

参数

名称 密钥 必需 类型 说明
Ai Flow Id
aiFlowId True string

工作流 ID。

运行 ID
runId True string

运行 ID。

继续标记
continuationToken integer

分页的字节偏移延续标记。

Api-version
api-version True string

API 版本。

返回

包含 DSR 导出的流运行操作历史记录的响应。

获取 DSR 导出的流运行操作(环境范围)

返回环境中流运行的操作历史记录。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Ai Flow Id
aiFlowId True string

工作流 ID。

运行 ID
runId True string

运行 ID。

继续标记
continuationToken integer

分页的字节偏移延续标记。

Api-version
api-version True string

API 版本。

返回

包含 DSR 导出的流运行操作历史记录的响应。

获取 DSR 导出的流运行(环境范围)

返回环境中的流运行记录。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

流 ID
flowId True uuid

流 ID。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的运行历史记录客户数据

返回流运行的运行历史记录客户数据。

参数

名称 密钥 必需 类型 说明
流 ID
flowId True uuid

流 ID。

运行 ID
runId True string

运行 ID。

继续标记
continuationToken string

用于分页的 Base64 编码延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的运行历史记录客户数据(环境范围)

返回环境中流运行的运行历史记录数据。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

流 ID
flowId True uuid

流 ID。

运行 ID
runId True string

运行 ID。

继续标记
continuationToken string

用于分页的 Base64 编码延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 DSR 导出的连接

返回 DSR 符合性导出的用户连接。

参数

名称 密钥 必需 类型 说明
继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

DSR 符合性 API 的通用分页响应。

获取 Web 应用程序防火墙状态

获取与给定网站关联的 Web 应用程序防火墙的状态。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

Web 应用程序防火墙状态

获取 Web 应用程序防火墙规则

获取与给定网站关联的 Web 应用程序防火墙规则。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

规则类型
ruleType string

要检索的 Web 应用程序防火墙规则的类型。

Api-version
api-version True string

API 版本。

返回

获取Power Pages网站的允许 IP 地址

返回网站的 IP 限制允许列表中的 IP 地址列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

允许的 IP 地址列表

获取Power Pages网站的深度扫描分数

获取Power Pages网站的深度扫描分数。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

获取Power Pages网站的深度扫描报告

获取Power Pages网站的深度扫描报告。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

获取与网站关联的证书

返回与指定网站关联的证书列表,按证书类型进行筛选。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

证书类型
certType True string

要检索的证书的类型。 允许的值:SSL、MANAGED。

Api-version
api-version True string

API 版本。

返回

获取以前触发的安装的轮询状态

按作 ID 获取作的安装进度。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID(不会与组织 ID 混淆)。

作 ID
operationId True uuid

作 ID。

Api-version
api-version True string

API 版本。

返回

获取可作为目标环境复制的环境列表

获取可作为目标环境复制的环境的列表。

参数

名称 密钥 必需 类型 说明
源环境 ID
sourceEnvironmentId True string

要从中复制的源环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

返回

获取可供安装的应用程序包列表

列出具有 OData 筛选的目标环境的可用应用包。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID (不要与组织 ID 混淆)。

应用安装状态
appInstallState string

应用程序包安装状态。

Lcid
lcid string

应用程序包支持的语言 ID。

Api-version
api-version True string

API 版本。

返回

获取可用于为范围分配的权利

能够获取可用于为范围分配的权利。

参数

名称 密钥 必需 类型 说明
$过滤器
$filter string

OData 筛选器表达式。

Api-version
api-version True string

API 版本。

返回

分配可用性响应模型。

获取可用的财务和运营版本

检索可用于环境的 Finance 和 Operations 应用程序版本的列表。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

Api-version
api-version True string

API 版本。

返回

财务和运营可用版本响应。

获取建议

获取租户的建议列表。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

建议分页列表

获取建议资源

获取租户建议的资源列表。

参数

名称 密钥 必需 类型 说明
建议名称
scenario True string

建议名称。

Api-version
api-version True string

API 版本。

返回

建议资源的分页列表

获取所有环境中的权利的租户资源

能够获取所有环境中权利的租户资源。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

页面大小
pageSize integer

要扇出到每页的最大环境数。

继续标记
continuationToken string

上一页返回的不透明延续标记或第一页的 null。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

获取所有环境的货币分配和强制规则

能够获取所有环境的货币分配和强制规则。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

获取指定权利的所有资源阈值

能够获取指定权利的所有资源阈值。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

Api-version
api-version True string

API 版本。

返回

获取指定权利的租户用户权利快照列表

能够获取指定权利的租户用户权利快照列表。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

页面大小
pageSize integer

分页的页面大小。

搜索请求
searchRequest string

用于筛选用户的搜索请求。

Orderby Consumed
orderbyConsumed string

按已用字段排序。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

获取指定权利租户的许可证趋势

能够获取租户的指定权利的许可证趋势。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

$top
$top integer

要返回的最大记录数。

$过滤器
$filter string

OData 筛选器表达式。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

获取指定环境的备份列表

获取指定环境的备份。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

Api-version
api-version True string

API 版本。

返回

获取指定环境的完整业务连续性状态快照

获取包括 LastSyncTime 在内的业务连续性快照。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

Api-version
api-version True string

API 版本。

返回

环境的业务连续性(灾难恢复)状态快照。

获取指定环境的还原候选项列表

获取从指定环境还原时还原候选项的列表。

参数

名称 密钥 必需 类型 说明
源环境 ID
sourceEnvironmentId True string

要从中还原的源环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

返回

获取操作状态

能够获取作状态。

参数

名称 密钥 必需 类型 说明
作 ID
operationId True uuid

作 ID。

Api-version
api-version True string

API 版本。

获取机器人隔离状态

检索机器人的隔离状态。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

获取权利的环境资源权利快照

能够获取权利的环境资源权利快照。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

环境 ID
environmentId True string

环境 ID。

起始日期
fromDate True string

查询范围的开始日期(含)。

截止日期
toDate True string

查询范围的结束日期(含)。

搜索请求
searchRequest string

用于筛选资源的搜索请求。

包括字段
includeFields string

逗号分隔其他字段以包含在响应中。

Orderby Consumed
orderbyConsumed string

如果指定,则按已用日期时间排序。

继续标记
continuationToken string

分页的延续标记。

Api-version
api-version True string

API 版本。

返回

带有继续标记的分页响应。

获取每个流容量源用户上下文摘要

能够获取每个流容量源用户上下文摘要。

参数

名称 密钥 必需 类型 说明
开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

页码
pageNumber integer

分页的页码。

页面大小
pageSize integer

分页的页面大小。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

用户上下文摘要记录的分页结果容器。

获取每个流容量源用户的流上下文摘要

能够获取每个流容量源的用户的流上下文摘要。

参数

名称 密钥 必需 类型 说明
开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

页码
pageNumber integer

分页的页码。

页面大小
pageSize integer

分页的页面大小。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

流上下文摘要记录的分页结果容器。

获取每个流容量源的用户的租户上下文摘要

能够获取每个流容量源的用户的租户上下文摘要。

参数

名称 密钥 必需 类型 说明
开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

获取特定环境的环境生命周期操作列表

列出特定环境的环境生命周期作。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

限度
limit string

每个请求返回的最大记录数。 必须是正整数;如果省略,则应用服务器默认值。

继续标记
continuationToken string

上一个响应返回的不透明令牌,用于提取下一页的结果。 省略以检索第一页。

Api-version
api-version True string

API 版本。

返回

获取特定用户每个流容量源的用户上下文摘要

能够获取特定用户每个流容量源的用户上下文摘要。

参数

名称 密钥 必需 类型 说明
用户 ID
userId True uuid

用户标识符。

开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

页码
pageNumber integer

分页的页码。

页面大小
pageSize integer

分页的页面大小。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

用户上下文摘要记录的分页结果容器。

获取特定用户的每个流容量源的流上下文摘要

能够获取特定用户的每个流容量源的流上下文摘要。

参数

名称 密钥 必需 类型 说明
用户 ID
userId True uuid

用户标识符。

开始日期
startDate True date-time

查询范围的开始日期。

结束日期
endDate date-time

查询范围的结束日期。 如果未提供,则默认为当前 UTC 时间。

页码
pageNumber integer

分页的页码。

页面大小
pageSize integer

分页的页面大小。

环境 ID
environmentId uuid

按环境标识符进行筛选。

Api-version
api-version True string

API 版本。

返回

流上下文摘要记录的分页结果容器。

获取环境生命周期操作的状态

获取环境生命周期作的状态。

参数

名称 密钥 必需 类型 说明
作 ID
operationId True string

作的 ID。

Api-version
api-version True string

API 版本。

返回

环境生命周期操作的结果。

获取环境的货币分配

能够获取环境的货币分配。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

返回

响应正文包括环境 ID 和分配的货币。

获取环境的货币分配和强制规则

能够获取环境的货币分配和强制规则。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

返回

环境的货币分配和强制规则。

获取环境的链接计费策略详细信息

能够获取环境的链接计费策略详细信息。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

返回

获取环境组

能够获取环境组。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True string

组 ID。

Api-version
api-version True string

API 版本。

返回

获取环境组的规则集

返回给定环境组的规则集。

参数

名称 密钥 必需 类型 说明
组 ID
groupId True uuid

环境组的唯一标识符。

Api-version
api-version True string

API 版本。

返回

具有延续支持的 OData 响应包装器。

获取环境预配支持的位置列表

获取环境预配支持的位置列表。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

列表预配位置终结点的响应信封。 显示顶级位置列表以及租户范围的预配元数据。

获取用于在位置进行预配的可用货币列表

检索位置中的环境预配的可用货币。

参数

名称 密钥 必需 类型 说明
位置
location True string

位置名称。

Api-version
api-version True string

API 版本。

返回

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

获取用于在某个位置进行预配的可用模板列表

检索位置中的环境预配的可用模板。

参数

名称 密钥 必需 类型 说明
位置
location True string

位置名称。

Api-version
api-version True string

API 版本。

返回

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

获取用于在某个位置进行预配的可用语言列表

检索位置中的环境预配的可用语言。

参数

名称 密钥 必需 类型 说明
位置
location True string

位置名称。

Api-version
api-version True string

API 版本。

返回

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

获取租户的 FinOps 许可证摘要(V2)

能够获取租户的 FinOps 许可证摘要(V2)。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

获取租户的 ISV 合同列表

获取租户的 ISV 合同列表。

参数

名称 密钥 必需 类型 说明
$top
$top string

结果的最高限制。

Api-version
api-version True string

API 版本。

返回

获取租户的权利详细信息

能够获取租户的权利详细信息。

参数

名称 密钥 必需 类型 说明
权利 ID
entitlementId True string

权利 ID。

Api-version
api-version True string

API 版本。

返回

表示租户的权利及其容量、即用即付和许可策略详细信息。

获取租户的租户容量详细信息

能够获取租户的租户容量详细信息。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

返回

获取租户的计费策略列表

能够获取租户的计费策略列表。

参数

名称 密钥 必需 类型 说明
$top
$top string

ISV 协定 ID。

Api-version
api-version True string

API 版本。

返回

获取租户的货币报表

能够获取租户的货币报表。

参数

名称 密钥 必需 类型 说明
包括分配
includeAllocations boolean

指示包含分配的标志。

包括消耗量
includeConsumptions boolean

指示包含消耗的标志。

Api-version
api-version True string

API 版本。

返回

获取范围的保留权利

能够获取范围的保留权利。

参数

名称 密钥 必需 类型 说明
$过滤器
$filter string

OData 筛选器表达式。

Api-version
api-version True string

API 版本。

返回

获取财务和运营操作错误

检索财务和操作环境的最新操作错误。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

最大结果
maxResults integer

要返回的最大操作错误数。 默认值为 20,上限为 1000。

Api-version
api-version True string

API 版本。

返回

包含环境的操作错误的响应。

获取财务和运营环境属性

检索财务和操作环境属性,例如 AOS 计数、部署类型和演示数据集。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

Api-version
api-version True string

API 版本。

返回

财务和运营环境属性响应。

获取财务和运营维护设置

检索由 Power Platform 管理中心管理的环境的 F&O 维护设置。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True uuid

环境的唯一标识符。

Api-version
api-version True string

API 版本。

返回

财务和运营维护响应。

获取连接器许可绕过

获取机器人的管理员连接器许可绕过设置。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

返回

管理员连接器同意机器人的绕过设置。

获取链接到计费策略的环境

能够获取链接到计费策略的环境。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

环境 ID
environmentId True string

环境 ID。

Api-version
api-version True string

API 版本。

返回

获取链接到计费策略的环境列表

能够获取链接到计费策略的环境列表。

参数

名称 密钥 必需 类型 说明
计费策略 ID
billingPolicyId True string

计费策略 ID。

Api-version
api-version True string

API 版本。

返回

获取限定为特定环境的生命周期操作的状态

获取在特定环境中范围内的环境生命周期操作的状态,从而在操作查找上启用环境级授权。

参数

名称 密钥 必需 类型 说明
目标环境 ID
targetEnvironmentId True string

目标环境的 ID。

作 ID
operationId True string

作的 ID。

Api-version
api-version True string

API 版本。

返回

环境生命周期操作的结果。

设置作用域的分配

能够设置范围的分配。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

tenantId
tenantId string
environmentGroupId
environmentGroupId string
environmentId
environmentId string
resourceId
resourceId string
userId
userId string
userGroupId
userGroupId string
数量
quantity double
autoAllocated
autoAllocated double
单位
unit string

权利度量单位。

授权编号
entitlementId string
ruleType
ruleType string

分配强制规则的类型。

enabled
enabled boolean

返回

Neptune 操作的结果。

设置连接器许可绕过

为机器人设置管理员连接器许可绕过设置。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

adminConsentBypass
adminConsentBypass True boolean

指示是否为机器人启用管理员连接器许可绕过。

返回

管理员连接器同意机器人的绕过设置。

运行 Maker 评估测试集

触发特定测试集的创建者评估测试运行。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

测试集 ID
TestSetId True string

测试集 ID。

Api-version
api-version True string

API 版本。

evaluationRunName
evaluationRunName string

评估运行的名称。

mcsConnectionId
mcsConnectionId string

用于执行评估运行的 MCS 连接器的连接 ID,或为匿名运行留空。

runOnPublishedBot
runOnPublishedBot boolean

指示操作是否应在已发布的机器人实例上运行。 如果设置为 false,则操作将在草稿机器人实例上运行。

botId
botId True string

Dataverse 机器人 ID。

botSchemaName
botSchemaName True string

机器人架构名称。

connectionId
connectionId True string

用户连接 ID。

connectionReferenceName
connectionReferenceName True string

机器人定义中的连接引用名称。

connectorId
connectorId True string

工具(连接器)ID。

返回

触发评估运行请求的响应有效负载。

通过指定其唯一标识符(ID)获取Power Pages网站详细信息

使用指定的网站 ID 获取网站详细信息。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

返回

Body
WebsiteDto

通过证书指纹删除网站的 SSL 绑定

从网站中删除指定主机名和证书指纹的 SSL 绑定。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

主机名
hostName True string

将删除其 SSL 绑定的自定义域主机名。

Thumbprint
thumbprint True string

要取消绑定的证书的指纹。

Api-version
api-version True string

API 版本。

重启Power Pages网站

重启给定站点 ID 的网站。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境 ID。

Id
id True string

网站唯一标识符(ID)。

Api-version
api-version True string

API 版本。

重新分配机器人的所有者

重新分配机器人的所有者。

参数

名称 密钥 必需 类型 说明
环境 ID
EnvironmentId True string

环境 ID。

机器人 ID
BotId True string

机器人 ID。

Api-version
api-version True string

API 版本。

NewOwnerAadUserId
NewOwnerAadUserId True string

新所有者Entra ID。

重置环境

重置指定的环境。

参数

名称 密钥 必需 类型 说明
环境 ID
environmentId True string

环境的 ID。

仅验证
ValidateOnly boolean

如果为 true,则验证请求而不执行请求。 与 validateProperties 一起使用,仅验证特定字段;如果 validateProperties 为空,则会验证整个请求。 默认为 false(验证和执行)。

验证属性
ValidateProperties string

要验证的属性名称的逗号分隔列表(例如“property1,property2”)。 仅当 validateOnly 为 true 时才适用。

Api-version
api-version True string

API 版本。

baseLanguageCode
baseLanguageCode integer

要重置到的环境的基本语言代码(例如,英语为 1033)。

代码
code string

货币代码(例如美元)。

姓名
name string

货币名称。

符号
symbol string

货币符号。

精准率
precision integer

货币精度。

displayName
displayName string

要重置为的环境的显示名称。

域名
domainName string

要重置到的环境的域名。

描述
description string

要重置到的环境的可选说明。

securityGroupId
securityGroupId string

要重置到的环境的安全组 ID。

templates
templates array of string

重置后要应用于环境的模板。

预配新环境

预配新环境。

参数

名称 密钥 必需 类型 说明
Api-version
api-version True string

API 版本。

位置
location string

将预配环境的位置。 与 MacroRegion 互斥。

macroRegion
macroRegion string

将在其中预配环境的宏区域。

displayName
displayName True string

环境的显示名称。

environmentSku
environmentSku True string

环境 SKU。

描述
description string

环境的可选说明。

databaseType
databaseType string

要创建的数据库类型(例如 CommonDataService)。

userId
userId string

用户的 ID。

类型
type string

用户标识的类型(例如用户)。

displayName
displayName string

用户的显示名称。

tenantId
tenantId string

用户的租户 ID。

id
id string

计费策略 ID。

baseLanguageCode
baseLanguageCode integer

基本语言代码(例如,英语为 1033)。

代码
code string

货币代码(例如美元)。

姓名
name string

货币名称。

符号
symbol string

货币符号。

精准率
precision integer

货币精度。

templates
templates array of string

要应用的模板。

securityGroupId
securityGroupId string

安全组 ID。

域名
domainName string

域名。

templateMetadata
templateMetadata object

为所选模板自定义的 JSON 对象有效负载。

id
id string

环境组 ID。

分类
category string

群集类别。 例如:FirstRelease。

protectionLevel
protectionLevel string

环境治理保护级别。

connectedGroupIdForTeamsEnvironment
connectedGroupIdForTeamsEnvironment string

Microsoft 365预配期间要链接到 Teams 环境的组 ID。 此属性不适用于非 Teams 环境。

id
id string

FinOps 环境 ID。

网址
url string

FinOps 环境 URL。

类型
type string

FinOps 环境链接类型。

返回

环境生命周期操作的结果。

定义

ActionEvent

流运行中的操作事件。 类型确定属性。

名称 路径 类型 说明
类型
type ActionEventType

操作事件的类型。

ActionEventType

操作事件的类型。

操作事件的类型。

AdvisorActionResponse

针对资源执行的作的响应

名称 路径 类型 说明
results
results array of AdvisorActionResult

AdvisorActionResult

对资源执行的作的结果

名称 路径 类型 说明
资源标识符
resourceId string

为其执行作的资源的唯一 ID

状态代码
statusCode integer

给定资源的作请求的状态代码

作结果
actionFinalResult string

作请求的最终状态

错误代码
errorCode string

与作执行期间遇到的任何错误关联的错误代码

错误消息
error string

与作执行期间遇到的任何错误关联的错误消息

AdvisorRecommendation

建议信息

名称 路径 类型 说明
建议名称
scenario string

建议名称。

详情
details AdvisorRecommendationDetails

建议的详细信息

AdvisorRecommendationDetails

建议的详细信息

名称 路径 类型 说明
资源计数
resourceCount integer

资源数

上次刷新时间戳
lastRefreshedTimestamp date-time

刷新建议的时间

预计下一次刷新时间戳
expectedNextRefreshTimestamp date-time

再次刷新建议的时间

AdvisorRecommendationIEnumerableResponseWithContinuation

建议分页列表

名称 路径 类型 说明
value
value array of AdvisorRecommendation

建议列表

下一个链接
nextLink string

获取下一页建议的链接

AdvisorRecommendationResource

建议中包含的资源的详细信息

名称 路径 类型 说明
资源显示名称
resourceName string

资源显示名称

资源标识符
resourceId string

资源唯一 ID

负责人 ID
resourceOwnerId string

资源所有者对象 ID

所有者名称
resourceOwner string

资源所有者显示名称

资源类型
resourceType string

资源类型

资源子类型
resourceSubType string

资源的子类型

资源说明
resourceDescription string

资源说明

资源使用情况
resourceUsage double

在过去 30 天内使用该资源的唯一用户数

环境名称
environmentName string

环境显示名称

环境 ID
environmentId string

环境唯一 ID

上次修改日期
lastModifiedDate date-time

上次修改资源的时间

上次使用日期
lastAccessedDate date-time

上次使用资源的时间

作状态
resourceActionStatus string

自上次刷新时间以来执行的任何作的当前状态

AdvisorRecommendationResourceIEnumerableResponseWithContinuation

建议资源的分页列表

名称 路径 类型 说明
value
value array of AdvisorRecommendationResource

建议资源列表

下一个链接
nextLink string

用于获取下一页资源的链接

警报

名称 路径 类型 说明
AlertId
AlertId string

警报的唯一标识符

AlertName
AlertName string

警报的名称

Description
Description string

警报的详细说明

缓解措施
Mitigation string

缓解问题的步骤

风险
Risk integer

与警报关联的风险级别

规则编号
RuleId string

生成警报的规则的标识符

LearnMoreLink
LearnMoreLink array of uri

有关警报的详细信息的链接

CallToAction
CallToAction array of string

解决警报的作

AllocationAvailabilityResponseModel

分配可用性响应模型。

名称 路径 类型 说明
作用域
scope ScopeModel
entitlementAllocationsAvailable
entitlementAllocationsAvailable array of EntitlementAllocationAvailabilityModel

范围权利的可用性。

AllocationByEnvironmentModel

环境的货币分配和强制规则。

名称 路径 类型 说明
environmentId
environmentId string

环境 ID。

currencyAllocations
currencyAllocations array of CurrencyAllocationModel

按货币分配,包括可以启用或禁用的 TenantPool 等强制规则。

AllocationEnforcementRule

名称 路径 类型 说明
ruleType
ruleType AllocationEnforcementRuleTypes

分配强制规则的类型。

enabled
enabled boolean

AllocationEnforcementRuleTypes

分配强制规则的类型。

分配强制规则的类型。

AllocationsByEnvironmentResponseModelV1

响应正文包括环境 ID 和分配的货币。

名称 路径 类型 说明
environmentId
environmentId string

为其分配了货币的环境 ID。

currencyAllocations
currencyAllocations array of CurrencyAllocationResponseModelV1

分配计数的货币集合。

ApplicationPackage

名称 路径 类型 说明
id
id uuid

映射到应用包 ID 的包或实例包 ID

唯一名称
uniqueName string

可用的包唯一名称或实例包唯一名称

版本
version string

可用的包版本或实例包版本

localizedDescription
localizedDescription string

应用程序包的本地化说明

localizedName
localizedName string

应用程序包的本地化名称

applicationId
applicationId uuid

应用程序 ID

应用程序名称
applicationName string

应用程序名称

应用描述
applicationDescription string

应用程序说明

singlePageApplicationUrl
singlePageApplicationUrl string

与应用程序关联的单页应用程序 (SPA) URL

出版商名称
publisherName string

发布者名称

publisherId
publisherId uuid

发布者 ID

learnMoreUrl
learnMoreUrl string

详细了解应用程序的 URL

platformMinVersion
platformMinVersion string

可用包平台最低版本

platformMaxVersion
platformMaxVersion string

可用包平台最大版本

customHandleUpgrade
customHandleUpgrade boolean

可用的包自定义升级

instancePackageId
instancePackageId uuid

仅用于安装重试的实例包 ID(例如重新安装)。

状态
state InstancePackageState

实例包的状态

catalogVisibility
catalogVisibility CatalogVisibility

应用程序的目录可见性

applicationVisibility
applicationVisibility ApplicationVisibility

应用程序可见性

lastError
lastError ErrorDetails
startDateUtc
startDateUtc date-time

应用程序包的开始日期

endDateUtc
endDateUtc date-time

应用程序包的结束日期

supportedCountries
supportedCountries array of string

应用程序支持的国家/地区列表

ApplicationPackageContinuationResponse

名称 路径 类型 说明
value
value array of ApplicationPackage
@odata.nextLink
@odata.nextLink string

ApplicationVisibility

应用程序可见性

应用程序可见性

ApplyFinOpsVersionAcceptedResponse

长时间运行的应用版本操作的已接受响应。

名称 路径 类型 说明
resourceId
resourceId string

操作应用到的环境资源的标识符。

operationId
operationId string

要轮询状态的长时间运行的操作的标识符。

AuditInfo

资源的审核信息。

名称 路径 类型 说明
createdBy
createdBy uuid

创建记录的用户的 ID。

createdTimeUtc
createdTimeUtc date-time

创建记录时的 UTC 时间。

modifiedBy
modifiedBy uuid

上次修改记录的用户的 ID。

modifiedTimeUtc
modifiedTimeUtc date-time

上次修改记录的 UTC 时间。

BillingInstrumentModel

ISV 计费工具信息。

名称 路径 类型 说明
订阅编号
subscriptionId uuid

租户订阅 ID。

resourceGroup
resourceGroup string

租户订阅中的资源组。

id
id string

BillingPolicyConditionsApiFilterModel

Power Platform 连接器筛选器。

名称 路径 类型 说明
allowOtherPremiumConnectors
allowOtherPremiumConnectors boolean

是否可以将按流量计费的使用情况归咎于高级连接器。

requiredApis
requiredApis array of BillingPolicyConditionsApiModel

至少一个必须处于按流量计费的使用情况中的连接器。

BillingPolicyConditionsApiModel

名称 路径 类型 说明
姓名
name string

API 连接器的名称。

BillingPolicyConditionsModel

ISV 协定 API 筛选器条件。

名称 路径 类型 说明
apiFilter
apiFilter BillingPolicyConditionsApiFilterModel

Power Platform 连接器筛选器。

BillingPolicyEnvironmentResponseModelV1

名称 路径 类型 说明
billingPolicyId
billingPolicyId string
environmentId
environmentId string

BillingPolicyEnvironmentResponseModelV1ResponseWithOdataContinuation

名称 路径 类型 说明
value
value array of BillingPolicyEnvironmentResponseModelV1
@odata.nextLink
@odata.nextLink string

BillingPolicyResponseModel

名称 路径 类型 说明
id
id string
姓名
name string
状态
status BillingPolicyStatus

所需的 ISV 协定状态。

位置
location string
billingInstrument
billingInstrument BillingInstrumentModel

ISV 计费工具信息。

createdOn
createdOn date-time
createdBy
createdBy LicensingPrincipal
lastModifiedOn
lastModifiedOn date-time
lastModifiedBy
lastModifiedBy LicensingPrincipal

BillingPolicyResponseModelResponseWithOdataContinuation

名称 路径 类型 说明
value
value array of BillingPolicyResponseModel
@odata.nextLink
@odata.nextLink string

BillingPolicyStatus

所需的 ISV 协定状态。

所需的 ISV 协定状态。

BotQuarantineStatus

名称 路径 类型 说明
isBotQuarantined
isBotQuarantined boolean

指示机器人是否已隔离。

lastUpdateTimeUtc
lastUpdateTimeUtc date-time

UTC 的上次更新时间。

BusinessContinuityStateFullSnapshot

环境的业务连续性(灾难恢复)状态快照。

名称 路径 类型 说明
lastSyncTime
lastSyncTime date-time

上次同步环境业务连续性状态的时间。

CapacityAvailabilityStatus

CapacityEntitlementModel

名称 路径 类型 说明
entitled
entitled EntitlementEntitledModel
消耗
consumed EntitlementConsumedModel
单位
unit EntitlementUnit

权利度量单位。

分配
allocated EntitlementAllocationModelV2
可用数量
availableQuantity double
状态
status OverageStatus

已授权容量的超额状态。

licenses
licenses array of CapacityLicenseModel

CapacityEntitlementType

CapacityLicenseModel

名称 路径 类型 说明
skuId
skuId string
productName
productName string
licenseQuantity
licenseQuantity integer
entitled
entitled EntitlementEntitledModel
licenseTier
licenseTier LicenseTier

许可证的层。

licenseStatus
licenseStatus string
nextLifecycleStatus
nextLifecycleStatus string
nextLifecycleDate
nextLifecycleDate date-time
licenseId
licenseId string
licenseSource
licenseSource LicenseSource

许可证的来源。

isUnlimited
isUnlimited boolean

CapacityStatusMessageCode

CapacitySummary

名称 路径 类型 说明
状态
status CapacityAvailabilityStatus
statusMessage
statusMessage string
statusMessageCode
statusMessageCode CapacityStatusMessageCode
finOpsStatus
finOpsStatus CapacityAvailabilityStatus
finOpsStatusMessage
finOpsStatusMessage string
finOpsStatusMessageCode
finOpsStatusMessageCode CapacityStatusMessageCode

CapacityType

CapacityUnits

CatalogPayGoEntitlementModel

名称 路径 类型 说明
entitled
entitled EntitlementEntitledModel
消耗
consumed EntitlementConsumedModel

CatalogVisibility

应用程序的目录可见性

应用程序的目录可见性

CertificateDTO

名称 路径 类型 说明
SubjectName
SubjectName string

证书的主题名称。

ExpirationDate
ExpirationDate date-time

证书的到期日期。

Thumbprint
Thumbprint string

证书的指纹。

位置
Location string

存储证书的Azure区域。

类型
Type string

证书的类型(例如 SSL、MANAGED、AZURE_MANAGED)。

CloudFlow

云流对象。

名称 路径 类型 说明
姓名
name string

流的显示名称。

createdOn
createdOn date-time

已创建流的日期和时间(UTC)。

modifiedOn
modifiedOn date-time

流的上次修改日期和时间(UTC)。

描述
description string

流的说明。

workflowId
workflowId uuid

工作流 ID。

resourceId
resourceId uuid

资源 ID。

parentWorkflowId
parentWorkflowId uuid

父工作流 ID。

stateCode
stateCode WorkflowStateCode

指示工作流状态。

状态码
statusCode WorkflowStatusCode

指示工作流状态。

modernFlowType
modernFlowType ModernFlowType

指示新式流类型。

定义
definition string

工作流记录的客户端数据字段。

唯一名称
uniqueName string

Dataverse 唯一名称。

createdBy
createdBy uuid

Dataverse ID 创建的。

createdOnBehalfBy
createdOnBehalfBy uuid

由 Dataverse ID 代表创建。

modifiedBy
modifiedBy uuid

Dataverse ID 修改后的 ID。

modifiedOnBehalfBy
modifiedOnBehalfBy uuid

按 ID 代表修改的。

所有者 ID
ownerId uuid

所有者 Dataverse ID。

owningBusinessUnit
owningBusinessUnit uuid

拥有的业务单位 Dataverse ID。

owningTeam
owningTeam uuid

拥有团队 Dataverse ID。

owningUser
owningUser uuid

拥有用户 Dataverse ID。

连接

名称 路径 类型 说明
姓名
name string
id
id string
类型
type string
apiId 的
properties.apiId string
displayName
properties.displayName string
图标 Uri
properties.iconUri uri
statuses
properties.statuses array of ConnectionStatus
姓名
properties.connectionParametersSet.name string
values
properties.connectionParametersSet.values object
connectionParameters (连接参数)
properties.connectionParameters object
keywordsRemaining
properties.keywordsRemaining integer
isSsoConnection
properties.isSsoConnection boolean
createdBy
properties.createdBy ConnectionCreatedBy
createdTime (创建时间)
properties.createdTime date-time
最后修改时间
properties.lastModifiedTime date-time
过期时间
properties.expirationTime date-time
testLinks
properties.testLinks array of object
requestUri
properties.testLinks.requestUri uri
方法
properties.testLinks.method string
id
properties.environment.id string
姓名
properties.environment.name string
账户名称
properties.accountName string
元数据
properties.metadata object
allowSharing
properties.allowSharing boolean

ConnectionCreatedBy

名称 路径 类型 说明
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string

ConnectionReference

名称 路径 类型 说明
连接器 ID
id string
连接器显示名称
displayName string
图标 URI
iconUri string
数据源
dataSources array of string

连接的数据源列表

依赖关系
dependencies array of string

连接的依赖项列表

家属
dependents array of string

连接器的依赖连接器列表

是本地连接
isOnPremiseConnection boolean

标志指示本地数据网关

绕过许可
bypassConsent boolean

标志指示绕过的 API 同意

API 层
apiTier string

API 层是标准层或高级层

自定义 API 标志
isCustomApiConnection boolean

标志指示自定义连接器

运行时策略名称
runtimePolicyName string

指示运行时策略名称的字符串

执行限制
executionRestrictions object

运行时策略的执行限制

共享连接 ID
sharedConnectionId string

指示共享连接的 ID 的字符串

ConnectionReferences

名称 路径 类型 说明
物品
ConnectionReference

连接状态

名称 路径 类型 说明
状态
status string
目标
target string
代码
error.code string
消息
error.message string

ConnectorConsentBypassResponse

管理员连接器同意机器人的绕过设置。

名称 路径 类型 说明
adminConsentBypass
adminConsentBypass boolean

指示是否为机器人启用了管理员连接器许可绕过。

ConsumerIdentityModel

ISV 协定的使用者标识。

名称 路径 类型 说明
tenantId
tenantId uuid

客户租户的 ID。

ConsumptionModel

名称 路径 类型 说明
实际
actual double
额定
rated double
actualUpdatedOn
actualUpdatedOn date-time
ratedUpdatedOn
ratedUpdatedOn date-time

对话记录

单个对话脚本记录。

名称 路径 类型 说明
tenantId
tenantId string

租户 ID。

objectId
objectId string

用户对象 ID。

时间戳
timestamp date-time

会话的时间戳。

serviceRequestCorrelationId
serviceRequestCorrelationId string

用于跟踪的服务请求关联 ID。

requestCorrelationId
requestCorrelationId string

请求跟踪的相关 ID。

systemMetadata
systemMetadata ConversationTranscriptSystemMetadata

聊天脚本的系统元数据。

申请
request ConversationTranscriptRequest

聊天脚本的请求部分。

response
response ConversationTranscriptResponse

聊天脚本的响应部分。

ConversationTranscriptCompletion

会话响应中生成的完成。

名称 路径 类型 说明
文本消息
text string

生成的文本内容。

finishReason
finishReason string

完成完成的原因(例如停止,tool_calls)。

toolCalls
toolCalls array of ConversationTranscriptToolCall

完成请求的工具调用。

ConversationTranscriptFunction

工具调用的函数详细信息。

名称 路径 类型 说明
姓名
name string

调用的函数的名称。

arguments
arguments string

传递给函数的 JSON 编码参数。

ConversationTranscriptMessage

对话中的消息。

名称 路径 类型 说明
角色
role string

消息发送者的角色(例如用户、助理、系统、工具)。

内容
content string

消息的文本内容。

姓名
name string

消息发件人的名称(如果适用)。

isCustomerContent
isCustomerContent boolean

此消息是否包含客户内容。

toolCalls
toolCalls array of ConversationTranscriptToolCall

在此消息中发出的工具调用。

toolCallId
toolCallId string

工具调用此消息的 ID 正在响应。

ConversationTranscriptRequest

聊天脚本的请求部分。

名称 路径 类型 说明
messages
messages array of ConversationTranscriptMessage

对话请求中的消息。

工具
tools array of ConversationTranscriptTool

对话期间可用的工具。

toolChoice
toolChoice string

工具选择策略。

ConversationTranscriptResponse

聊天脚本的响应部分。

名称 路径 类型 说明
补全
completions array of ConversationTranscriptCompletion

模型生成的完成。

成功
succeeded boolean

响应是否成功。

ConversationTranscriptScenario

发生对话的方案。

发生对话的方案。

ConversationTranscriptSystemMetadata

聊天脚本的系统元数据。

名称 路径 类型 说明
方案
scenario ConversationTranscriptScenario

发生对话的方案。

ConversationTranscriptTool

会话期间可用的工具。

名称 路径 类型 说明
类型
type string

工具的类型。

函数
function ConversationTranscriptToolFunction

工具的函数定义。

ConversationTranscriptToolCall

对话中的工具调用。

名称 路径 类型 说明
id
id string

工具调用的唯一标识符。

类型
type string

工具调用的类型。

函数
function ConversationTranscriptFunction

工具调用的函数详细信息。

ConversationTranscriptToolFunction

工具的函数定义。

名称 路径 类型 说明
描述
description string

函数的作用说明。

姓名
name string

函数的名称。

parameters
parameters object

定义函数参数的 JSON 架构。

CreateEnvironmentManagementSettingResponse

表示此服务中 API 的响应对象。

名称 路径 类型 说明
objectResult
objectResult string

获取或设置在响应中创建的实体的 ID

错误
errors EnvironmentServiceErrorResponse
nextLink
nextLink uri

获取或设置下一个链接(如果返回更多记录)

responseMessage
responseMessage string

获取或设置错误消息。

CrossTenantConnection

名称 路径 类型 说明
tenantId
tenantId uuid

Azure发生跨租户连接的 AD 租户 ID。

connectionType
connectionType string

跨租户连接的方向。

CrossTenantConnectionReport

名称 路径 类型 说明
tenantId
tenantId uuid

为其生成报表的Azure AD 租户 ID。

reportId
reportId uuid

报表 ID。

requestDate
requestDate date-time

请求跨租户连接报告的日期。

startDate
startDate date-time

报表日期窗口的开始。

结束日期
endDate date-time

报表日期窗口的结束。

状态
status string
connections
connections array of CrossTenantConnection

报表日期窗口中发生的跨租户连接页。

@odata.nextLink
@odata.nextLink string

下一页 URI,用于其他跨租户连接。

CrossTenantConnectionReportsResponseWithOdataContinuation

名称 路径 类型 说明
value
value array of CrossTenantConnectionReport

租户的跨租户连接报告。

@odata.nextLink
@odata.nextLink string

列表响应的下一页的 URI。

CurrencyAllocationModel

名称 路径 类型 说明
currencyType
currencyType ExternalCurrencyType

可分配给环境的可用货币类型。

分配
allocated integer
autoAllocated
autoAllocated integer
enforcementRules
enforcementRules array of EnforcementRule

CurrencyAllocationResponseModelV1

名称 路径 类型 说明
currencyType
currencyType ExternalCurrencyType

可分配给环境的可用货币类型。

分配
allocated integer

货币类型的分配计数

CurrencyConsumption

名称 路径 类型 说明
unitsConsumed
unitsConsumed integer
lastUpdatedDay
lastUpdatedDay date-time

CurrencyReportV2

名称 路径 类型 说明
currencyType
currencyType ExternalCurrencyType

可分配给环境的可用货币类型。

购买
purchased integer
分配
allocated integer
消耗
consumed CurrencyConsumption

CurrencyType

加载项的货币(容量)类型。

加载项的货币(容量)类型。

CustomRule (自定义规则)

名称 路径 类型 说明
姓名
name string

自定义规则的名称

priority
priority integer

规则的优先级

enabledState
enabledState string

规则的状态

ruleType
ruleType WafRuleType

WAF 规则类型

rateLimitDuration(分钟)
rateLimitDurationInMinutes integer

速率限制的持续时间(以分钟为单位)

rateLimitThreshold
rateLimitThreshold integer

速率限制的阈值

matchConditions
matchConditions array of object
matchVariable 的
matchConditions.matchVariable string

要匹配的变量

选择器
matchConditions.selector string

匹配变量的选择器

操作员
matchConditions.operator string

匹配条件的运算符

negate条件
matchConditions.negateCondition boolean

是否否定条件

matchValue 匹配值
matchConditions.matchValue array of string

要匹配的值

变换
matchConditions.transforms array of string

要应用的转换

操作
action string

规则匹配时要执行的作

DisabledReason

说明模板为何不适用于给定的 SKU。

名称 路径 类型 说明
代码
code string

原因代码。

消息
message string

原因消息。

DsrConversationTranscriptsResponse

包含 DSR 导出会话脚本的响应。

名称 路径 类型 说明
value
value array of ConversationTranscript

对话脚本列表。

nextLink
nextLink string

用于检索下一页结果的 URL(如果可用)。

DsrFlowRunData

单个流运行的操作事件数据。

名称 路径 类型 说明
runId
runId string

运行 ID。

actionEvents
actionEvents array of ActionEvent

运行中的操作事件列表。

DsrFlowRunsResponse

包含 DSR 导出的流运行操作历史记录的响应。

名称 路径 类型 说明
flowId
flowId string

工作流 ID。

value
value array of DsrFlowRunData

流运行数据条目的列表。

nextLink
nextLink string

用于检索下一页结果的 URL(如果可用)。

DsrPagedResponse

DSR 符合性 API 的通用分页响应。

名称 路径 类型 说明
value
value array of object

记录集合。 结构因资源类型而异。

物品
value object
nextLink
nextLink string

用于检索下一页结果的 URL(如果可用)。

EnforcementRule

名称 路径 类型 说明
ruleType
ruleType EnforcementRuleTypes
enabled
enabled boolean

EnforcementRuleTypes

EnterprisePolicies

链接到环境的一组企业策略。

名称 路径 类型 说明
加密
encryption EnterprisePolicyLink

环境和Azure企业策略资源之间的链接。

标识
identity EnterprisePolicyLink

环境和Azure企业策略资源之间的链接。

网络注入
networkInjection EnterprisePolicyLink

环境和Azure企业策略资源之间的链接。

privateEndpoint
privateEndpoint EnterprisePolicyLink

环境和Azure企业策略资源之间的链接。

环境和Azure企业策略资源之间的链接。

名称 路径 类型 说明
id
id string

企业策略的 ID。

resourceId
resourceId string

企业策略的完全限定Azure资源 ID。

状态
status EnterprisePolicyLinkStatus

环境与企业策略之间的链接状态。

错误
error string

链接状态为“失败”时的错误详细信息。

EnterprisePolicyLinkStatus

环境与企业策略之间的链接状态。

环境与企业策略之间的链接状态。

EntitlementAllocationAvailabilityModel

名称 路径 类型 说明
授权编号
entitlementId string
可用数量
availableQuantity double
单位
unit EntitlementUnit

权利度量单位。

EntitlementAllocationModelV2

名称 路径 类型 说明
value
value double
autoAllocated
autoAllocated double

EntitlementConsumedModel

名称 路径 类型 说明
value
value double
消费类型
consumptionType EntitlementConsumptionType

权利的使用类型。

lastUpdatedOn
lastUpdatedOn date-time
writeOff
writeOff double

EntitlementConsumptionType

权利的使用类型。

权利的使用类型。

EntitlementEntitledModel

名称 路径 类型 说明
value
value double

EntitlementReservedResponseModel

范围内权利保留分配。

名称 路径 类型 说明
保留
reserved ReservedModel

权利保留的数量和单位。

授权编号
entitlementId string

EntitlementUnit

权利度量单位。

权利度量单位。

环境

Power Platform 环境。

名称 路径 类型 说明
environmentId
environmentId string

环境 ID。

displayName
displayName string

环境的显示名称。

dataverseOrganizationUrl
dataverseOrganizationUrl string

环境的 Dataverse 组织 URL。

EnvironmentAddonResponseModel

附加到环境的 BAP 加载项。

名称 路径 类型 说明
addon类型
addonType CurrencyType

加载项的货币(容量)类型。

分配
allocated double
addonUnit
addonUnit string

EnvironmentBackup

表示环境备份。

名称 路径 类型 说明
backupPointDateTime
backupPointDateTime date-time

备份点日期时间。

标签
label string

手动创建的备份的标签。

backupExpiryDateTime
backupExpiryDateTime date-time

备份到期日期时间。

id
id string

环境备份的标识符。

createdBy
createdBy UserIdentity

表示用户的标识。

EnvironmentBackupPagedCollection

名称 路径 类型 说明
收藏
collection array of EnvironmentBackup
continuationToken
continuationToken string

EnvironmentCapacityEntitlementModel

环境范围的容量权利。

名称 路径 类型 说明
分配
allocated EntitlementAllocationModelV2
enforcementRules
enforcementRules array of AllocationEnforcementRule
消耗
consumed EntitlementConsumedModel
可用数量
availableQuantity double
状态
status OverageStatus

已授权容量的超额状态。

EnvironmentCurrency

表示可用于环境预配的货币。

名称 路径 类型 说明
代码
code string

货币代码(例如“USD”)。

符号
symbol string

货币符号(例如“$”)。

isTenantDefault
isTenantDefault boolean

这是否为租户的默认货币。

EnvironmentCurrencyResourceCollection

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

名称 路径 类型 说明
收藏
collection array of EnvironmentCurrency

EnvironmentDisasterRecoveryLocation

环境的灾难恢复位置。

环境的灾难恢复位置。

EnvironmentDisasterRecoveryState

环境的灾难恢复状态。

环境的灾难恢复状态。

EnvironmentEntitlementDetailServiceModel

环境范围权利的权利容量和即用即付详细信息。

名称 路径 类型 说明
单位
unit EntitlementUnit

权利度量单位。

产能
capacity EnvironmentCapacityEntitlementModel

环境范围的容量权利。

payGo
payGo CatalogPayGoEntitlementModel

EnvironmentEntitlementResponseModel

权利及其容量/即用即付详细信息的范围限定为单个环境,包括环境元数据。

名称 路径 类型 说明
授权编号
entitlementId string

权利 ID。

productCategories
productCategories array of ProductCategory

权利产品类别(例如 D365Apps、Dataverse、PowerApps、PowerAutomate)。

environmentId
environmentId string

环境 ID。

environmentType
environmentType EnvironmentType

环境的类型。

environmentName
environmentName string

环境名称。

isManagedEnvironment
isManagedEnvironment boolean

指示环境是否为托管环境。

位置
location string

环境的地理位置。

方案
scenario EnvironmentScenario

环境的场景。

disasterRecoveryState
disasterRecoveryState EnvironmentDisasterRecoveryState

环境的灾难恢复状态。

disasterRecoveryLocation
disasterRecoveryLocation EnvironmentDisasterRecoveryLocation

环境的灾难恢复位置。

权利
entitlement EnvironmentEntitlementDetailServiceModel

环境范围权利的权利容量和即用即付详细信息。

addons
addons array of EnvironmentAddonResponseModel

附加到环境的 BAP 加载项。

权限
permissions array of EnvironmentPermissionResponseModel

环境的 BAP 权限。

cleanupOpportunitySize
cleanupOpportunitySize integer

可回收的总存储(以字节为单位)。

recommendationCount
recommendationCount integer

活动清理建议的数目。

EnvironmentEntitlementSnapshotResponseModel

名称 路径 类型 说明
resources
resources array of EnvironmentResourceEntitlementSnapshotResponseModel

EnvironmentEntitlementSnapshotResponseModelPagedResponse

带有继续标记的分页响应。

名称 路径 类型 说明
value
value array of EnvironmentEntitlementSnapshotResponseModel
@odata.count
@odata.count integer
@odata.nextLink
@odata.nextLink string
continuationtoken(续传令牌)
continuationtoken string

EnvironmentGroup

名称 路径 类型 说明
id
id uuid
displayName
displayName string
描述
description string
parentGroupId
parentGroupId uuid
childrenGroupIds
childrenGroupIds array of uuid
createdTime (创建时间)
createdTime date-time
createdBy
createdBy Principal
最后修改时间
lastModifiedTime date-time
lastModifiedBy
lastModifiedBy Principal

EnvironmentGroupResponseWithOdataContinuation

名称 路径 类型 说明
value
value array of EnvironmentGroup
@odata.nextLink
@odata.nextLink string

EnvironmentLanguage

表示可用于环境预配的语言。

名称 路径 类型 说明
localeId
localeId integer

区域设置标识符(LCID,例如英语为 1033)。

localizedName
localizedName string

语言名称,本地化为显示。

isTenantDefault
isTenantDefault boolean

这是否为租户的默认语言。

EnvironmentLanguageResourceCollection

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

名称 路径 类型 说明
收藏
collection array of EnvironmentLanguage

EnvironmentList

名称 路径 类型 说明
value
value array of EnvironmentResponse
@odata.nextlink
@odata.nextlink uri

用于检索下一页结果的不透明 URL。 仅当其他页面可用时显示。

EnvironmentManagementSetting

名称 路径 类型 说明
id
id string
tenantId
tenantId uuid
enableIpBasedStorageAccessSignatureRule
enableIpBasedStorageAccessSignatureRule boolean
allowedIpRangeForStorageAccessSignatures
allowedIpRangeForStorageAccessSignatures string
ipBasedStorageAccessSignatureMode
ipBasedStorageAccessSignatureMode integer
loggingEnabledForIpBasedStorageAccessSignature
loggingEnabledForIpBasedStorageAccessSignature boolean
powerPages_AllowMakerCopilotsForNewSites
powerPages_AllowMakerCopilotsForNewSites string
powerPages_AllowMakerCopilotsForExistingSites
powerPages_AllowMakerCopilotsForExistingSites string
powerPages_AllowProDevCopilotsForSites
powerPages_AllowProDevCopilotsForSites string
powerPages_AllowSiteCopilotForSites
powerPages_AllowSiteCopilotForSites string
powerPages_AllowSearchSummaryCopilotForSites
powerPages_AllowSearchSummaryCopilotForSites string
powerPages_AllowListSummaryCopilotForSites
powerPages_AllowListSummaryCopilotForSites string
powerPages_AllowIntelligentFormsCopilotForSites
powerPages_AllowIntelligentFormsCopilotForSites string
powerPages_AllowSummarizationAPICopilotForSites
powerPages_AllowSummarizationAPICopilotForSites string
powerPages_AllowNonProdPublicSites
powerPages_AllowNonProdPublicSites string
powerPages_AllowNonProdPublicSites_Exemptions
powerPages_AllowNonProdPublicSites_Exemptions string
powerPages_AllowProDevCopilotsForEnvironment
powerPages_AllowProDevCopilotsForEnvironment string
powerApps_ChartVisualization
powerApps_ChartVisualization boolean
powerApps_FormPredictSmartPaste
powerApps_FormPredictSmartPaste boolean
powerApps_FormPredictAutomatic
powerApps_FormPredictAutomatic boolean
powerApps_CopilotChat
powerApps_CopilotChat boolean
powerApps_NLSearch
powerApps_NLSearch boolean
powerApps_EnableFormInsights
powerApps_EnableFormInsights boolean
powerApps_AllowCodeApps
powerApps_AllowCodeApps boolean
copilotStudio_ConnectedAgents
copilotStudio_ConnectedAgents boolean
copilotStudio_CodeInterpreter
copilotStudio_CodeInterpreter boolean
copilotStudio_ConversationAuditLoggingEnabled
copilotStudio_ConversationAuditLoggingEnabled boolean
d365CustomerService_Copilot
d365CustomerService_Copilot boolean
d365CustomerService_AIAgents
d365CustomerService_AIAgents boolean
copilotStudio_ComputerUseAppAllowlist
copilotStudio_ComputerUseAppAllowlist string
copilotStudio_ComputerUseWebAllowlist
copilotStudio_ComputerUseWebAllowlist string
copilotStudio_ComputerUseSharedMachines
copilotStudio_ComputerUseSharedMachines boolean
copilotStudio_ComputerUseCredentialsAllowed
copilotStudio_ComputerUseCredentialsAllowed boolean

EnvironmentPagedCollection

名称 路径 类型 说明
收藏
collection array of Environment
continuationToken
continuationToken string

EnvironmentPermissionResponseModel

对环境的 BAP 权限。

名称 路径 类型 说明
姓名
name string
displayName
displayName string

EnvironmentPrincipal

表示主体(用户或应用程序)。

名称 路径 类型 说明
id
id string

主体 ID。

类型
type string

主体类型。

EnvironmentResourceEntitlementSnapshotResponseModel

名称 路径 类型 说明
resourceId
resourceId string

资源 ID。

消耗
consumed double

已用值。

单位
unit EntitlementUnit

权利度量单位。

lastRefreshedDate
lastRefreshedDate date-time

上次刷新的日期。

元数据
metadata object

MCSMessages 的其他元数据,例如 Feature、ProductName 和 nonBillableConsumed。

EnvironmentResponse

名称 路径 类型 说明
id
id string

环境的 ID。

displayName
displayName string

环境的显示名称。

tenantId
tenantId string

环境所属的租户的 ID。

类型
type string

环境的类型(SKU)。

地区
geo string

环境的地理区域。

environmentGroupId
environmentGroupId string

此环境所属的环境组的 ID。

azureRegion
azureRegion string

环境的Azure区域。

clusterCategory
clusterCategory string

环境所属的群集类别。

createdBy
createdBy EnvironmentPrincipal

表示主体(用户或应用程序)。

createdFor
createdFor EnvironmentPrincipal

表示主体(用户或应用程序)。

createdDateTime
createdDateTime date-time

环境的创建日期和时间。

deletedDateTime
deletedDateTime date-time

环境的删除日期和时间。

dataverseId
dataverseId string

与环境关联的 Dataverse 数据库(组织)的 ID。

网址
url string

与环境关联的 Dataverse 数据库的 URL。

版本
version string

与环境关联的 Dataverse 数据库的版本。

域名
domainName string

与环境关联的 Dataverse 数据库的域名。

securityGroupId
securityGroupId string

控制对环境的访问的安全组。

connectedGroupId
connectedGroupId string

连接到环境的 AAD 组的 ID。

状态
state string

环境的当前状态。

adminMode
adminMode string

指示是否为环境启用或禁用仅管理员模式。

backgroundOperationsState
backgroundOperationsState string

指示是为环境启用或禁用后台操作。

protectionLevel
protectionLevel string

应用于环境的保护级别。

retentionPeriod
retentionDetails.retentionPeriod string

环境的保留期。

availableFromDateTime
retentionDetails.availableFromDateTime date-time

环境可用于恢复的日期和时间。

finOpsMetadata
finOpsMetadata FinOpsMetadata

描述链接的 FinOps 环境的元数据。

enterprisePolicies
enterprisePolicies EnterprisePolicies

链接到环境的一组企业策略。

scenarioName
scenarioName string

与环境关联的方案名称(例如单一实例方案类型)。

EnvironmentScenario

环境的场景。

环境的场景。

EnvironmentServiceErrorResponse

名称 路径 类型 说明
代码
code string
消息
message string
详情
details array of ErrorDetail

EnvironmentSku

环境 SKU。

环境 SKU。

EnvironmentTemplate

表示可用于环境预配的模板。

名称 路径 类型 说明
姓名
name string

模板名称(标识符)。

displayName
displayName string

模板名称,已本地化以供显示。

isCustomerEngagement
isCustomerEngagement boolean

模板是否为 Customer Engagement 模板。

isSupportedForResetOperation
isSupportedForResetOperation boolean

重置操作是否支持此模板。

availability
availability array of TemplateAvailability

此模板的每个 SKU 可用性。

EnvironmentTemplateResourceCollection

完全返回的资源的非分页集合(无继续标记)。 用于有限引用列表,其中部分结果不正确。

名称 路径 类型 说明
收藏
collection array of EnvironmentTemplate

EnvironmentType

环境的类型。

环境的类型。

错误详细信息

名称 路径 类型 说明
代码
code string
消息
message string
目标
target string
value
value string

ErrorDetails

名称 路径 类型 说明
errorName
errorName string

错误名称

错误代码
errorCode integer

Dataverse 中的错误代码

消息
message string

错误消息

类型
type string

错误类型

状态码
statusCode integer

错误状态代码

source string

错误的源

EvaluationRunState

描述当前活动阶段的评估运行的状态。

描述当前活动阶段的评估运行的状态。

执行状态 (ExecutionState)

指示创建者评估运行的进度状态的当前执行状态。

指示创建者评估运行的进度状态的当前执行状态。

ExternalCurrencyType

可分配给环境的可用货币类型。

可分配给环境的可用货币类型。

FinOpsAdminSettingsResponse

财务和运营维护响应。

名称 路径 类型 说明
maintenanceWindowDaysOfWeek
maintenanceWindowDaysOfWeek array of FinOpsDayOfWeek

RunOne 更新的首选星期几。

maintenanceWindowCadence
maintenanceWindowCadence FinOpsUpdateCadence

主要版本应用程序更新的节奏。

FinOpsAppVersion

财务和运营应用程序版本。

名称 路径 类型 说明
版本
version string

应用程序版本。

releaseStage
releaseStage string

版本的发布阶段。

FinOpsAttachLicenseConsumption

名称 路径 类型 说明
purchasedAttachUnassignedCount
purchasedAttachUnassignedCount integer
purchasedAttachAssignedCount
purchasedAttachAssignedCount integer

FinOpsBaseLicenseConsumption

名称 路径 类型 说明
purchasedBaseUnassignedCount
purchasedBaseUnassignedCount integer
purchasedBaseAssignedCount
purchasedBaseAssignedCount integer

FinOpsDayOfWeek

一周中的一天(与 .NET System.DayOfWeek 枚举保持一致)。

一周中的一天(与 .NET System.DayOfWeek 枚举保持一致)。

FinOpsDeploymentCategory

财务和运营环境的部署类别。

财务和运营环境的部署类别。

FinOpsLicenseRequirements

名称 路径 类型 说明
usersNeedingLicenseCount
usersNeedingLicenseCount integer

FinOpsLicensesConsumption

名称 路径 类型 说明
supplyChainManagement
supplyChainManagement FinOpsProductLicenseConsumption
金融
finance FinOpsProductLicenseConsumption
commerce
commerce FinOpsProductLicenseConsumption
projectOperations
projectOperations FinOpsProductLicenseConsumption
humanResources
humanResources FinOpsProductLicenseConsumption
operations
operations FinOpsOperationsLicenseConsumption
活动
activity FinOpsSimpleLicenseConsumption
teamMember
teamMember FinOpsSimpleLicenseConsumption
selfService
selfService FinOpsSimpleLicenseConsumption
supplyChainManagementOrFinanceOrCommerce
supplyChainManagementOrFinanceOrCommerce FinOpsSupplyChainManagementOrFinanceOrCommerceLicenseConsumption
projectOperationsOrHumanResources
projectOperationsOrHumanResources FinOpsProjectOperationsOrHumanResourcesLicenseConsumption

FinOpsLicenseSummaryV2Response

名称 路径 类型 说明
lastReportRefreshTime
lastReportRefreshTime date-time
tenantId
tenantId string
allUsersCount
allUsersCount integer
usersWithoutLicensesCount
usersWithoutLicensesCount integer
underLicensedUsersCount
underLicensedUsersCount integer
overLicensedUsersCount
overLicensedUsersCount integer
licensesConsumption
licensesConsumption FinOpsLicensesConsumption

FinOpsMetadata

描述链接的 FinOps 环境的元数据。

名称 路径 类型 说明
类型
type string

链接的 FinOps 环境类型。

id
id string

链接的 FinOps 环境 ID。

网址
url string

链接的 FinOps 环境 URL。

FinOpsOperationsLicenseConsumption

名称 路径 类型 说明
licenseRequirements
licenseRequirements FinOpsLicenseRequirements
baseConsumption
baseConsumption FinOpsBaseLicenseConsumption

FinOpsProductLicenseConsumption

名称 路径 类型 说明
licenseRequirements
licenseRequirements FinOpsLicenseRequirements
baseConsumption
baseConsumption FinOpsBaseLicenseConsumption
attachConsumption
attachConsumption FinOpsAttachLicenseConsumption

FinOpsProjectOperationsOrHumanResourcesLicenseConsumption

名称 路径 类型 说明
licenseRequirements
licenseRequirements FinOpsLicenseRequirements
projectOperationsConsumption
projectOperationsConsumption FinOpsBaseLicenseConsumption
humanResourcesConsumption
humanResourcesConsumption FinOpsBaseLicenseConsumption

FinOpsPropertiesResponse

财务和运营环境属性响应。

名称 路径 类型 说明
appId
appId string

财务和运营环境 ID (AppId)。

maxAOSCount
maxAOSCount string

为环境配置的交互式 AOS 实例的最大数目。

lastObservedAOSCount
lastObservedAOSCount integer

最后一个观察到的交互式 AOS 实例计数。

maxBatchAOSCount
maxBatchAOSCount string

为环境配置的批处理(非交互式)AOS 实例的最大数量。

lastObservedBatchAOSCount
lastObservedBatchAOSCount integer

最后一个观察到的批处理(非交互式)AOS 实例计数。

deploymentType
deploymentType FinOpsDeploymentCategory

财务和运营环境的部署类别。

demoDataset
demoDataset string

环境的演示数据集名称。

FinOpsSimpleLicenseConsumption

名称 路径 类型 说明
licenseRequirements
licenseRequirements FinOpsLicenseRequirements
baseConsumption
baseConsumption FinOpsBaseLicenseConsumption

FinOpsSupplyChainManagementOrFinanceOrCommerceLicenseConsumption

名称 路径 类型 说明
licenseRequirements
licenseRequirements FinOpsLicenseRequirements
supplyChainManagementConsumption
supplyChainManagementConsumption FinOpsBaseLicenseConsumption
financeConsumption
financeConsumption FinOpsBaseLicenseConsumption
commerceConsumption
commerceConsumption FinOpsBaseLicenseConsumption

FinOpsUpdateCadence

主要版本应用程序更新的节奏。

主要版本应用程序更新的节奏。

FinOpsVersionsResponse

财务和运营可用版本响应。

名称 路径 类型 说明
availableVersions
availableVersions array of FinOpsAppVersion

可用财务和运营应用程序版本的列表。

FlowAction

流作对象。

名称 路径 类型 说明
workflowId
workflowId uuid

工作流 ID。

所有者 ID
ownerId uuid

所有者 Dataverse ID。

parentProcessStageId
parentProcessStageId uuid

父进程阶段 ID。

连接器
connector string

连接器名称。

isTrigger
isTrigger boolean

作是否为触发器。

operationId
operationId string

作 ID。

operationKind
operationKind FlowActionKind

指示进程阶段中使用的作的类型。

operationType
operationType FlowActionType

指示进程阶段中使用的作的类型。

owningBusinessUnit
owningBusinessUnit uuid

拥有的业务单位 Dataverse ID。

参数名称
parameterName string

参数名称。

参数值
parameterValue string

参数值。

processStageId
processStageId uuid

进程阶段 ID。

stageName
stageName string

阶段名称。

FlowActionKind

指示进程阶段中使用的作的类型。

指示进程阶段中使用的作的类型。

FlowActionType

指示进程阶段中使用的作的类型。

指示进程阶段中使用的作的类型。

FlowRun

流运行对象。

名称 路径 类型 说明
flowRunId
flowRunId uuid

流运行 ID。

parentRunId
parentRunId string

父运行 ID。

姓名
name string

流运行名称。

createdOn
createdOn date-time

创建流运行的日期和时间。

modifiedOn
modifiedOn date-time

上次修改流运行的日期和时间。

startTime
startTime date-time

流运行的开始时间

endTime
endTime date-time

流运行的结束时间。

状态
status string

流运行的状态。

durationMs
durationMs integer

流运行的持续时间(以毫秒为单位)。

ttlInSeconds
ttlInSeconds integer

生存时间(以秒为单位)。

workflowId
workflowId uuid

工作流 ID。

modernFlowType
modernFlowType ModernFlowType

指示新式流类型。

triggerType
triggerType string

触发器类型。

runningUser
runningUser uuid

运行流的用户的 Dataverse ID。

所有者 ID
ownerId uuid

所有者 Dataverse ID。

GetConnectorByIdResponse

名称 路径 类型 说明
姓名
name string
id
id string
类型
type string
displayName
properties.displayName string
图标 Uri
properties.iconUri uri
iconBrandColor
properties.iconBrandColor string
apiEnvironment
properties.apiEnvironment string
isCustomApi
properties.isCustomApi boolean
blobUrisAreProxied
properties.blobUrisAreProxied boolean
runtimeUrls
properties.runtimeUrls array of uri
primaryRuntimeUrl
properties.primaryRuntimeUrl uri
doNotUseApiHubNetRuntimeUrl
properties.doNotUseApiHubNetRuntimeUrl uri
properties.metadata.source string
品牌颜色
properties.metadata.brandColor string
allowSharing
properties.metadata.allowSharing boolean
useNewApimVersion
properties.metadata.useNewApimVersion string
以前
properties.metadata.version.previous string
当前
properties.metadata.version.current string
capabilities
properties.capabilities array of string
接口
properties.interfaces object
描述
properties.description string
createdTime (创建时间)
properties.createdTime date-time
更改时间
properties.changedTime date-time
releaseTag
properties.releaseTag string
分层
properties.tier string
发布服务器
properties.publisher string
rateLimit
properties.rateLimit integer
apiVersion
properties.apiVersion string

GetEnvironmentManagementSettingResponse

表示此服务中 API 的响应对象。

名称 路径 类型 说明
objectResult
objectResult array of EnvironmentManagementSetting

获取或设置要查询的实体的字段。

错误
errors EnvironmentServiceErrorResponse
nextLink
nextLink uri

获取或设置下一个链接(如果返回更多记录)

responseMessage
responseMessage string

获取或设置错误消息。

GetTemporaryCurrencyEntitlementCountResponseModel

名称 路径 类型 说明
temporaryCurrencyEntitlementCount
temporaryCurrencyEntitlementCount integer
temporaryCurrencyEntitlementsAllowedPerMonth
temporaryCurrencyEntitlementsAllowedPerMonth integer
entitledQuantity
entitledQuantity integer

InstancePackage

名称 路径 类型 说明
id
id uuid

实例包 ID

软件包 ID
packageId uuid

包编号

applicationId
applicationId uuid

与实例包关联的应用程序 ID

应用程序名称
applicationName string

与实例包关联的应用程序名称

应用描述
applicationDescription string

与实例包关联的应用程序说明

singlePageApplicationUrl
singlePageApplicationUrl string

单页应用程序 (SPA) URL

出版商名称
publisherName string

应用程序的发布者名称

publisherId
publisherId uuid

发布者 ID

packageUniqueName
packageUniqueName string

包唯一名称。

packageVersion
packageVersion string

包版本

localizedDescription
localizedDescription string

应用程序的本地化说明

localizedName
localizedName string

应用程序的本地化名称

learnMoreUrl
learnMoreUrl string

了解应用程序的详细信息 URL

termsOfServiceBlobUris
termsOfServiceBlobUris array of string

应用程序的服务条款

applicationVisibility
applicationVisibility ApplicationVisibility

应用程序可见性

lastOperation
lastOperation InstancePackageOperation
customHandleUpgrade
customHandleUpgrade boolean

应用程序的自定义句柄升级标志

InstancePackageOperation

名称 路径 类型 说明
状态
state InstancePackageState

实例包的状态

createdOn
createdOn date-time

创建实例包作的日期和时间

modifiedOn
modifiedOn date-time

修改实例包作的日期和时间

错误详情
errorDetails ErrorDetails
statusMessage
statusMessage string

状态消息

instancePackageId
instancePackageId uuid

实例包 ID

operationId
operationId uuid

实例包上触发的作的作 ID

InstancePackageOperationPollingResponse

名称 路径 类型 说明
状态
status InstancePackageOperationStatus
createdDateTime
createdDateTime date-time
lastActionDateTime
lastActionDateTime date-time
错误
error ErrorDetails
statusMessage
statusMessage string
operationId
operationId uuid

InstancePackageOperationStatus

InstancePackageState

实例包的状态

实例包的状态

IpAddressEntity

表示允许列表中的 IP 地址条目

名称 路径 类型 说明
IP地址
IpAddress string

IP 地址或 CIDR 范围(例如“208.130.0.0/16”)

IpAddressType
IpAddressType IpAddressType

IP 地址的类型

IpAddressType

IP 地址的类型

IP 地址的类型

IsvContractResponseModel

名称 路径 类型 说明
id
id string
姓名
name string
状态
status BillingPolicyStatus

所需的 ISV 协定状态。

地区
geo string
使用者
consumer ConsumerIdentityModel

ISV 协定的使用者标识。

conditions
conditions BillingPolicyConditionsModel

ISV 协定 API 筛选器条件。

billingInstrument
billingInstrument BillingInstrumentModel

ISV 计费工具信息。

powerAutomatePolicy
powerAutomatePolicy PowerAutomatePolicyModel

Power Platform 请求策略。

createdOn
createdOn date-time
createdBy
createdBy LicensingPrincipal
lastModifiedOn
lastModifiedOn date-time
lastModifiedBy
lastModifiedBy LicensingPrincipal

IsvContractResponseModelResponseWithOdataContinuation

名称 路径 类型 说明
value
value array of IsvContractResponseModel
@odata.nextLink
@odata.nextLink string

LegacyCapacityModel

名称 路径 类型 说明
总容量
totalCapacity double
totalConsumption
totalConsumption double
capacityUnits
capacityUnits CapacityUnits

LicenseDetailsModel

名称 路径 类型 说明
entitlementCode
entitlementCode string
displayName
displayName string
isTemporaryLicense
isTemporaryLicense boolean
temporaryLicenseExpiryDate
temporaryLicenseExpiryDate date-time
servicePlanId
servicePlanId uuid
skuId
skuId uuid
支付
paid LicenseQuantity
试用
trial LicenseQuantity
总容量
totalCapacity double
nextLifecycleDate
nextLifecycleDate date-time
capabilityStatus
capabilityStatus string

LicensedPolicyModel

名称 路径 类型 说明
entitled
entitled boolean

LicenseModel

LicenseModelType

许可证模型类型。

许可证模型类型。

LicenseQuantity

名称 路径 类型 说明
enabled
enabled integer
警告
warning integer
暂停
suspended integer

LicenseSource

许可证的来源。

许可证的来源。

LicenseTier

许可证的层。

许可证的层。

LicensingPrincipal

名称 路径 类型 说明
id
id string
类型
type PrincipalType

ListConnectionsResponse

名称 路径 类型 说明
value
value array of Connection

ListConnectorsResponse

名称 路径 类型 说明
value
value array of GetConnectorByIdResponse

ListPolicyResponse

名称 路径 类型 说明
value
value array of Policy

位置

表示环境预配的位置/地理位置。

名称 路径 类型 说明
姓名
name string

位置名称。

displayName
displayName string

显示名称。

代码
code string

位置代码。

isDefault
isDefault boolean

这是否为默认位置。

isDisabled
isDisabled boolean

是否禁用此位置。

canProvisionDatabase
canProvisionDatabase boolean

是否允许数据库预配。

hasFirstReleaseIslandAvailableForProvisioning
hasFirstReleaseIslandAvailableForProvisioning boolean

首次发布岛是否可用于在此位置进行预配。

LocationSelectionMode

描述租户如何选择预配位置。 返回与支持的位置一起,告知调用方是选择特定位置还是宏区域。

描述租户如何选择预配位置。 返回与支持的位置一起,告知调用方是选择特定位置还是宏区域。

MacroRegion

表示对一个或多个预配位置进行分组的宏区域。

名称 路径 类型 说明
macroRegionId
macroRegionId string

宏区域标识符。

displayName
displayName string

宏区域的显示名称。

dataResidencyNote
dataResidencyNote string

此宏区域的客户显示的数据驻留说明。

Metric

与创建者评估运行中的测试用例关联的评分器指标。

名称 路径 类型 说明
结果
result MetricResult

创建者评估运行中评分器指标的结果。

类型
type MetricType

创建者评估运行中的评分器指标的类型。

MetricErrorReason

错误原因提供有关指标评估结果的其他信息。

错误原因提供有关指标评估结果的其他信息。

MetricResult

创建者评估运行中评分器指标的结果。

名称 路径 类型 说明
aiResultReason
aiResultReason string

LLM 生成的原因,为评估结果提供其他上下文。

数据
data object

定义此指标的键值对集。 键规范化为小写。

errorReason
errorReason MetricErrorReason

错误原因提供有关指标评估结果的其他信息。

状态
status MetricStatus

评分器指标的状态会导致制造商评估运行。

MetricStatus

评分器指标的状态会导致制造商评估运行。

评分器指标的状态会导致制造商评估运行。

度量类型

创建者评估运行中的评分器指标的类型。

创建者评估运行中的评分器指标的类型。

MgGovEnvironmentValues

环境信息。

名称 路径 类型 说明
id
id string

环境的 ID。

类型
type string

环境的类型。

姓名
name string

环境的名称。

MgGovFilterType

环境筛选器的类型。

环境筛选器的类型。

MgGovODataResponse

具有延续支持的 OData 响应包装器。

名称 路径 类型 说明
value
value array of RuleSetDto

规则集的数组。

@odata.nextLink
@odata.nextLink string

指向下一页结果的链接。

MgGovPolicyEnvironmentFilter

定义环境筛选器。

名称 路径 类型 说明
类型
type MgGovFilterType

环境筛选器的类型。

values
values array of MgGovEnvironmentValues

环境信息。

MgGovResourceType

资源的类型。

资源的类型。

MgGovRule

规则定义。

名称 路径 类型 说明
id
id string

规则 ID。

value
value string

规则值。

MgGovRuleSetType

规则集的类型。

规则集的类型。

ModernFlowType

指示新式流类型。

指示新式流类型。

NeptuneOperationResult

Neptune 操作的结果。

名称 路径 类型 说明
状态码
statusCode integer

操作结果的 HTTP 状态代码。

isErrorResult
isErrorResult boolean

指示操作结果是否表示错误。

ODataListWebsitesDto

名称 路径 类型 说明
@odata.metadata
@odata.metadata string
value
value array of WebsiteDto
@odata.nextLink
@odata.nextLink string

OperationErrorDetail

失败请求的结构化错误详细信息。

名称 路径 类型 说明
代码
code string

错误代码。

fieldErrors
fieldErrors object

按字段错误详细信息,按字段名称键键。

OperationErrorItem

单个财务和运营操作错误。

名称 路径 类型 说明
operationType
operationType string

操作类型。

correlationId
correlationId string

相关 ID。

failedActionName
failedActionName string

失败操作的名称。

错误代码
errorCode string

错误代码。

errorMessage
errorMessage string

客户友好的错误消息。

failedAt
failedAt date-time

操作失败时的时间戳。

OperationErrorsResponse

包含环境的操作错误的响应。

名称 路径 类型 说明
environmentId
environmentId string

环境 ID。

错误
errors array of OperationErrorItem

操作错误列表。

OperationExecutionResult

环境生命周期操作的结果。

名称 路径 类型 说明
姓名
name string

操作的名称。

状态
status OperationStatus

作的状态。

operationId
operationId string

作的 ID。

startTime
startTime date-time

作的开始时间。

endTime
endTime date-time

操作的结束时间。

updatedEnvironment
updatedEnvironment Environment

Power Platform 环境。

requestedBy
requestedBy UserIdentity

表示用户的标识。

errorDetail 错误
errorDetail OperationErrorDetail

失败请求的结构化错误详细信息。

stageStatuses
stageStatuses array of StageStatus

操作的按阶段进度。

OperationExecutionResultPagedCollection

名称 路径 类型 说明
收藏
collection array of OperationExecutionResult
continuationToken
continuationToken string

OperationResponse

表示此服务中 API 的响应对象。

名称 路径 类型 说明
objectResult
objectResult

获取或设置响应的对象

错误
errors EnvironmentServiceErrorResponse
nextLink
nextLink uri

获取或设置下一个链接(如果返回更多记录)

debugErrors
debugErrors string

获取或设置仅针对专用/本地测试显示的调试错误

responseMessage
responseMessage string

获取或设置错误消息。

OperationStatus

作的状态。

作的状态。

OverageStatus

已授权容量的超额状态。

已授权容量的超额状态。

OverflowCapacityModel

名称 路径 类型 说明
capacityType
capacityType CapacityType
value
value double

PayAsYouGoState

Policy

名称 路径 类型 说明
id
id string

策略分配的唯一标识符。

tenantId
tenantId string

租户的唯一标识符。

姓名
name string

策略的名称。

lastModified
lastModified date-time

上次修改策略的日期和时间。

ruleSets
ruleSets array of RuleSet
ruleSetCount
ruleSetCount integer

与此策略关联的规则集数。

PortalScanIssues

名称 路径 类型 说明
问题
issue string

已确定的特定问题

分类
category string

问题的类别

结果
result string

问题检查的结果

描述
description string

问题的详细说明

learnMoreUrl
learnMoreUrl uri

有关此问题的详细信息的 URL

PowerApp

名称 路径 类型 说明
id
id string

PowerApp ID 字段。

姓名
name string

PowerApp 名称字段。

appVersion
properties.appVersion date-time

PowerApp 属性 appVersion。

major
properties.createdByClientVersion.major integer

PowerApp 属性 createdByClientVersion major。

未成年人
properties.createdByClientVersion.minor integer

PowerApp 属性 createdByClientVersion minor。

内部版本
properties.createdByClientVersion.build integer

PowerApp 属性 createdByClientVersion 生成。

修订
properties.createdByClientVersion.revision integer

PowerApp 属性 createdByClientVersion 修订版。

majorRevision
properties.createdByClientVersion.majorRevision integer

PowerApp 属性 createdByClientVersion majorRevision。

minorRevision
properties.createdByClientVersion.minorRevision integer

PowerApp 属性 createdByClientVersion minorRevision。

major
properties.minClientVersion.major integer

PowerApp 属性 minClientVersion 主要。

未成年人
properties.minClientVersion.minor integer

PowerApp 属性 minClientVersion minor。

内部版本
properties.minClientVersion.build integer

PowerApp 属性 minClientVersion 生成。

修订
properties.minClientVersion.revision integer

PowerApp 属性 minClientVersion 修订版。

majorRevision
properties.minClientVersion.majorRevision integer

PowerApp 属性 minClientVersion majorRevision。

minorRevision
properties.minClientVersion.minorRevision integer

PowerApp 属性 minClientVersion minorRevision。

id
properties.owner.id string

PowerApp 所有者主体用户 ID。

displayName
properties.owner.displayName string

PowerApp 所有者主体显示名称。

电子邮件
properties.owner.email string

PowerApp 所有者主体电子邮件。

类型
properties.owner.type string

PowerApp 所有者主体类型。

tenantId
properties.owner.tenantId string

PowerApp 所有者主体租户 ID。

userPrincipalName
properties.owner.userPrincipalName string

PowerApp 所有者主体用户主体名称。

id
properties.createdBy.id string

PowerApp 创建者主体对象 ID。

displayName
properties.createdBy.displayName string

PowerApp 创建者主体显示名称。

电子邮件
properties.createdBy.email string

PowerApp 创建者主体电子邮件。

类型
properties.createdBy.type string

PowerApp 创建者主体类型。

tenantId
properties.createdBy.tenantId string

PowerApp 创建者主体租户 ID。

userPrincipalName
properties.createdBy.userPrincipalName string

PowerApp 创建者主体用户主体名称。

id
properties.lastModifiedBy.id string

PowerApp 上次由主体对象 ID 修改。

displayName
properties.lastModifiedBy.displayName string

PowerApp 上次修改了主体显示名称。

电子邮件
properties.lastModifiedBy.email string

PowerApp 上次由主体电子邮件修改。

类型
properties.lastModifiedBy.type string

PowerApp 上次按主体类型修改。

tenantId
properties.lastModifiedBy.tenantId string

PowerApp 上次由主体租户 ID 修改。

userPrincipalName
properties.lastModifiedBy.userPrincipalName string

PowerApp 上次由主体 userPrincipalName 修改。

backgroundColor
properties.backgroundColor string

PowerApp 背景色。

backgroundImageUri
properties.backgroundImageUri string

PowerApp 背景图像 URI。

displayName
properties.displayName string

PowerApp 显示名称。

描述
properties.description string

PowerApp 说明。

value
properties.appUris.documentUri.value string

PowerApp appUri 文档 URI 值。

readonlyValue
properties.appUris.documentUri.readonlyValue string

PowerApp appUri 文档 URI 只读值。

imageUris
properties.appUris.imageUris array of string

PowerApp appUri 映像 URI 数组。

createdTime (创建时间)
properties.createdTime date-time

PowerApp 属性创建时间。

最后修改时间
properties.lastModifiedTime date-time

上次修改时间的 PowerApp 属性。

sharedGroupsCount
properties.sharedGroupsCount integer

PowerApp 属性共享组计数。

sharedUsersCount
properties.sharedUsersCount integer

PowerApp 属性共享用户计数。

appOpenProtocolUri
properties.appOpenProtocolUri string

PowerApp 属性应用打开协议 URI。

appOpenUri
properties.appOpenUri string

PowerApp 属性应用打开 URI。

收藏
properties.userAppMetadata.favorite string

PowerApp 属性用户应用元数据收藏夹。

includeInAppsList
properties.userAppMetadata.includeInAppsList boolean

PowerApp 属性用户应用元数据包含在应用列表中。

isFeaturedApp
properties.isFeaturedApp boolean

PowerApp 属性是特色应用。

bypassConsent
properties.bypassConsent boolean

PowerApp 属性绕过许可。

isHeroApp
properties.isHeroApp boolean

指示 hero 应用程序的 PowerApp 属性。

id
properties.environment.id string

PowerApp 环境 ID。

姓名
properties.environment.name string

PowerApp 环境名称。

connectionReferences
properties.connectionReferences ConnectionReferences
primaryDeviceWidth
tags.primaryDeviceWidth string

PowerApp 标记主要设备宽度。

primaryDeviceHeight
tags.primaryDeviceHeight string

PowerApp 标记主要设备高度。

sienaVersion
tags.sienaVersion string

PowerApp 标记 siena 版本。

deviceCapabilities
tags.deviceCapabilities string

PowerApp 标记设备功能。

supportsPortrait
tags.supportsPortrait string

PowerApp 标记支持纵向。

supportsLandscape
tags.supportsLandscape string

PowerApp 标记支持横向。

primaryFormFactor
tags.primaryFormFactor string

PowerApp 标记主要外形规格。

publisherVersion
tags.publisherVersion string

PowerApp 标记发布者版本。

minimumRequiredApiVersion
tags.minimumRequiredApiVersion date-time

PowerApp 标记所需的最低 API 版本。

类型
type string

PowerApp 类型字段。

PowerAutomatePolicyModel

Power Platform 请求策略。

名称 路径 类型 说明
cloudFlowRunsPayAsYouGoState
cloudFlowRunsPayAsYouGoState PayAsYouGoState
desktopFlowUnattendedRunsPayAsYouGoState
desktopFlowUnattendedRunsPayAsYouGoState PayAsYouGoState
desktopFlowAttendedRunsPayAsYouGoState
desktopFlowAttendedRunsPayAsYouGoState PayAsYouGoState

PowerPlatformRequestSnapshotResultWithoutPagesUserPerFlowCapacitySourceFlowContextRecord

流上下文摘要记录的分页结果容器。

名称 路径 类型 说明
currentPage
currentPage integer

当前页码。

记录
records array of UserPerFlowCapacitySourceFlowContextRecord

流上下文摘要记录的集合。

PowerPlatformRequestSnapshotResultWithoutPagesUserPerFlowCapacitySourceRecord

每个流容量源记录的用户分页结果容器。

名称 路径 类型 说明
currentPage
currentPage integer

当前页码。

记录
records array of UserPerFlowCapacitySourceRecord

每个流容量源记录的用户集合。

PowerPlatformRequestSnapshotResultWithoutPagesUserPerFlowCapacitySourceUserContextRecord

用户上下文摘要记录的分页结果容器。

名称 路径 类型 说明
currentPage
currentPage integer

当前页码。

记录
records array of UserPerFlowCapacitySourceUserContextRecord

用户上下文摘要记录的集合。

校长

名称 路径 类型 说明
id
id string
displayName
displayName string
电子邮件
email string
类型
type string
tenantId
tenantId string
userPrincipalName
userPrincipalName string

主体类型

产品类别

与权利关联的产品类别。

与权利关联的产品类别。

ProvisioningLocations

列表预配位置终结点的响应信封。 显示顶级位置列表以及租户范围的预配元数据。

名称 路径 类型 说明
收藏
collection array of Location

租户可用的预配位置列表。

locationSelectionMode
locationSelectionMode LocationSelectionMode

描述租户如何选择预配位置。 返回与支持的位置一起,告知调用方是选择特定位置还是宏区域。

macroRegions
macroRegions array of MacroRegion

租户可用的宏区域列表。

ReservedModel

权利保留的数量和单位。

名称 路径 类型 说明
数量
quantity double
单位
unit EntitlementUnit

权利度量单位。

ResourceArrayPowerApp

名称 路径 类型 说明
value
value array of PowerApp
下一个链接
nextLink string

用于获取应用列表下一页的 URL。 包含跳过令牌。

ResourceItem

具有特定于 Power Platform 的字段的 ARG 行。 任意属性可能存在于 properties.

名称 路径 类型 说明
id
id string
姓名
name string
类型
type string
tenantId
tenantId string
kind
kind string
位置
location string
resourceGroup
resourceGroup string
订阅编号
subscriptionId string
managedBy
managedBy string
sku
sku
计划
plan
属性
properties object

自由格式的 ARG 属性包

tags
tags
标识
identity
zones
extendedLocation
extendedLocation
environmentId
environmentId string
environmentId1
environmentId1 string
environmentName
environmentName string
environmentRegion
environmentRegion string
environmentType
environmentType string
isManagedEnvironment
isManagedEnvironment boolean

ResourceQueryResponse

名称 路径 类型 说明
totalRecords
totalRecords integer

与查询匹配的行总数

计数
count integer

此页面中的行

resultTruncated
resultTruncated integer

0 = 截断,1 = 未截断

skipToken
skipToken string

下一页的延续标记

数据
data array of ResourceItem

ResourceThresholdModel

名称 路径 类型 说明
resourceId
resourceId string

资源的唯一标识符。

授权编号
entitlementId string

与资源关联的权利 ID。

environmentId
environmentId string

与资源关联的环境的唯一标识符。

stopResource
stopResource boolean

指示用户是否已选择显式停止资源。 如果为“true”,则资源处于禁用状态。

limit
limit double

为资源消耗设置的限制。

stopIfOverCapacity
stopIfOverCapacity boolean

指示如果资源超出其限制,是否停止使用容量。

notifyIfOverCapacity
notifyIfOverCapacity boolean

指示资源消耗达到其通知阈值时是否通知。

notificationThreshold
notificationThreshold integer

发送有关资源消耗的通知的阈值百分比。

resourceConsumption
resourceConsumption double

资源的当前消耗量。

createdOn
createdOn date-time

首次创建资源阈值配置的 UTC 日期和时间。

RoleAssignmentResponse

角色分配。

名称 路径 类型 说明
value
value array of object
roleAssignmentId
value.roleAssignmentId string

角色分配 ID

principalObjectId
value.principalObjectId string

已分配主体的 ID

角色定义 ID
value.roleDefinitionId string

角色定义的 ID

作用域
value.scope string

分配范围

主体类型
value.principalType string

主体的类型

createdByPrincipalType
value.createdByPrincipalType string

创建者主体的类型

createdByPrincipalObjectId
value.createdByPrincipalObjectId string

创建者主体的 ID

createdOn
value.createdOn date-time

创建分配的日期/时间

RoleDefinitionResponse

分配的可用角色定义。

名称 路径 类型 说明
value
value array of object
角色定义 ID
value.roleDefinitionId string

角色定义 ID

roleDefinitionName
value.roleDefinitionName string

角色定义名称

权限
value.permissions array of string

规则

名称 路径 类型 说明
规则编号
RuleId string

规则的唯一标识符

规则名称
RuleName string

规则的名称

RuleStatus
RuleStatus string

规则的状态

AlertsCount
AlertsCount integer

规则生成的警报数

Alerts
Alerts array of Alert

规则生成的警报列表

RuleAssignment

名称 路径 类型 说明
ruleSetCount
ruleSetCount integer

分配的规则集计数。

policyId
policyId string

策略的唯一标识符。

tenantId
tenantId string

租户的唯一标识符。

resourceId
resourceId string

资源的唯一标识符。

resourceType
resourceType string

分配给规则的资源的类型。

RuleAssignmentsResponse

名称 路径 类型 说明
value
value array of RuleAssignment

RuleSet

名称 路径 类型 说明
id
id string

规则集的唯一标识符。

版本
version string

规则集的版本。

输入
inputs object

规则集的输入可能会因规则而异。

RuleSetDto

规则集数据传输对象。

名称 路径 类型 说明
id
id string

规则集的 ID。

lastModified
lastModified date-time

上次修改的时间戳。

environmentFilter
environmentFilter MgGovPolicyEnvironmentFilter

定义环境筛选器。

parameters
parameters array of RuleSetParameters

规则集参数。

RuleSetParameters

规则集的参数。

名称 路径 类型 说明
类型
type MgGovRuleSetType

规则集的类型。

resourceType
resourceType MgGovResourceType

资源的类型。

value
value array of MgGovRule

规则值。

RunStatusResponse

触发评估运行请求的响应有效负载。

名称 路径 类型 说明
callbackUri
callbackUri uri

要轮询评估运行结果的 URI。

executionState
executionState ExecutionState

指示创建者评估运行的进度状态的当前执行状态。

最后更新时间
lastUpdatedAt date-time

上次状态更新发生时的时间戳。

runId
runId uuid

此评估运行的唯一标识符。

状态
state EvaluationRunState

描述当前活动阶段的评估运行的状态。

testCasesProcessed
testCasesProcessed integer

评估运行中迄今已处理的测试用例数。

totalTestCases
totalTestCases integer

计算运行中要处理的测试用例总数。

ScopeModel

名称 路径 类型 说明
tenantId
tenantId string
environmentGroupId
environmentGroupId string
environmentId
environmentId string
resourceId
resourceId string
userId
userId string
userGroupId
userGroupId string

SiteSecurityResult

名称 路径 类型 说明
TotalRuleCount
TotalRuleCount integer

评估的规则总数

FailedRuleCount
FailedRuleCount integer

失败的规则数

TotalAlertCount
TotalAlertCount integer

生成的警报总数

UserName
UserName string

发起扫描的用户的名称

StartTime
StartTime date-time

扫描的开始时间

EndTime
EndTime date-time

扫描的结束时间

规则
Rules array of Rule

扫描期间评估的规则列表

SiteSecurityScore

名称 路径 类型 说明
totalRules
totalRules integer

规则总数

succeededRules
succeededRules integer

成功的规则数

SslBindingThumbprintDTO

名称 路径 类型 说明
Name
Name string

SSL 绑定关联的自定义主机名。

Thumbprint
Thumbprint string

绑定到主机名的证书指纹。

StageStatus

操作的单个阶段的状态。

名称 路径 类型 说明
姓名
name string

阶段的名称。

状态
status StepExecutionStatus

操作阶段的执行状态。

startTime
startTime date-time

阶段的开始时间。

endTime
endTime date-time

阶段的结束时间。

errorDetail 错误
errorDetail OperationErrorDetail

失败请求的结构化错误详细信息。

州代码

描述当前活动阶段的评估运行的状态。

描述当前活动阶段的评估运行的状态。

StepExecutionStatus

操作阶段的执行状态。

操作阶段的执行状态。

StorageWarningThresholds

名称 路径 类型 说明
storageCategory
storageCategory string
storageEntity
storageEntity string
thresholdInMB
thresholdInMB integer
warningMessageConstKey
warningMessageConstKey string

StorageWarningThresholdsDocument

名称 路径 类型 说明
storageCategory
storageCategory string
storageEntity
storageEntity string
阈 值
thresholds array of StorageWarningThresholds
isActive
isActive boolean

TemplateAvailability

特定环境 SKU 的模板的可用性。

名称 路径 类型 说明
environmentSku
environmentSku EnvironmentSku

环境 SKU。

isDisabled
isDisabled boolean

是否为此 SKU 禁用模板。

disabledReason
disabledReason DisabledReason

说明模板为何不适用于给定的 SKU。

TemporaryLicenseInfo

名称 路径 类型 说明
hasTemporaryLicense
hasTemporaryLicense boolean
temporaryLicenseExpiryDate
temporaryLicenseExpiryDate date-time

TenantApplicationPackage

名称 路径 类型 说明
唯一名称
uniqueName string

租户应用程序包的唯一名称

localizedDescription
localizedDescription string

租户应用程序包的本地化说明

localizedName
localizedName string

本地化名称

applicationId
applicationId uuid

应用程序 ID

应用程序名称
applicationName string

应用程序名称

应用描述
applicationDescription string

应用程序说明

出版商名称
publisherName string

发布者名称

publisherId
publisherId uuid

发布者 ID

learnMoreUrl
learnMoreUrl string

了解详细信息 URL

catalogVisibility
catalogVisibility CatalogVisibility

应用程序的目录可见性

applicationVisibility
applicationVisibility ApplicationVisibility

应用程序可见性

lastError
lastError ErrorDetails

TenantApplicationPackageContinuationResponse

名称 路径 类型 说明
value
value array of TenantApplicationPackage
@odata.nextLink
@odata.nextLink string

TenantCapacityAndConsumptionModel

名称 路径 类型 说明
capacityType
capacityType CapacityType
capacityUnits
capacityUnits CapacityUnits
总容量
totalCapacity double
maxCapacity
maxCapacity double
consumption
consumption ConsumptionModel
状态
status CapacityAvailabilityStatus
overflowCapacity
overflowCapacity array of OverflowCapacityModel
capacityEntitlements
capacityEntitlements array of TenantCapacityEntitlementModel

TenantCapacityConsumptionSnapshotResponseModel

名称 路径 类型 说明
tenantId
tenantId string
environmentId
environmentId string
resourceId
resourceId string
消耗
consumed double
单位
unit string
元数据
metadata object
asOfDate
asOfDate date-time

TenantCapacityConsumptionUserSnapshotResponseModel

名称 路径 类型 说明
tenantId
tenantId string
environmentId
environmentId string
userId
userId string
消耗
consumed double
单位
unit string
元数据
metadata object
asOfDate
asOfDate date-time

TenantCapacityDetailsModel

名称 路径 类型 说明
tenantId
tenantId uuid
licenseModelType
licenseModelType LicenseModel
capacitySummary
capacitySummary CapacitySummary
tenantCapacities
tenantCapacities array of TenantCapacityAndConsumptionModel
legacyModelCapacity
legacyModelCapacity LegacyCapacityModel
temporaryLicenseInfo
temporaryLicenseInfo TemporaryLicenseInfo

TenantCapacityEntitlementModel

名称 路径 类型 说明
capacityType
capacityType CapacityType
capacitySubType
capacitySubType CapacityEntitlementType
总容量
totalCapacity double
maxNextLifecycleDate
maxNextLifecycleDate date-time
licenses
licenses array of LicenseDetailsModel

TenantEntitlementDetailServiceModel

名称 路径 类型 说明
单位
unit EntitlementUnit

权利度量单位。

产能
capacity CapacityEntitlementModel
payGo
payGo CatalogPayGoEntitlementModel
licensedPolicy
licensedPolicy LicensedPolicyModel

TenantEntitlementLicenseModel

名称 路径 类型 说明
licenseId
licenseId string
skuId
skuId string
productName
productName string
licenseQuantity
licenseQuantity integer
entitled
entitled double
licenseTier
licenseTier LicenseTier

许可证的层。

licenseStatus
licenseStatus string

TenantEntitlementLicenseTrendResponseModel

名称 路径 类型 说明
date
date date-time
licenseModelType
licenseModelType LicenseModelType

许可证模型类型。

licenses
licenses array of TenantEntitlementLicenseModel

TenantEntitlementLicenseTrendResponseModelPagedResponse

带有继续标记的分页响应。

名称 路径 类型 说明
value
value array of TenantEntitlementLicenseTrendResponseModel
@odata.count
@odata.count integer
@odata.nextLink
@odata.nextLink string
continuationtoken(续传令牌)
continuationtoken string

TenantEntitlementResponseModel

表示租户的权利及其容量、即用即付和许可策略详细信息。

名称 路径 类型 说明
授权编号
entitlementId string

权利 ID。

productCategories
productCategories array of ProductCategory

权利产品类别(例如 D365Apps、Dataverse、PowerApps、PowerAutomate)。

权利
entitlement TenantEntitlementDetailServiceModel

TenantEnvironmentResourceSnapshotResponseModel

租户范围的、所有环境列表的按资源快照。

名称 路径 类型 说明
resourceId
resourceId string

资源 ID。

消耗
consumed double

已用值。

单位
unit EntitlementUnit

权利度量单位。

lastRefreshedDate
lastRefreshedDate date-time

上次刷新的日期。

元数据
metadata object

MCSMessages 的其他元数据,例如 Feature、ProductName 和 nonBillableConsumed。

environmentId
environmentId string

此资源所属的环境。

TenantEnvironmentResourceSnapshotResponseModelPagedResponse

带有继续标记的分页响应。

名称 路径 类型 说明
value
value array of TenantEnvironmentResourceSnapshotResponseModel
@odata.count
@odata.count integer
@odata.nextLink
@odata.nextLink string
continuationtoken(续传令牌)
continuationtoken string

TenantResourceResponseModel

名称 路径 类型 说明
resources
resources array of TenantCapacityConsumptionSnapshotResponseModel

与租户关联的资源列表。

TenantResourceResponseModelPagedResponse

带有继续标记的分页响应。

名称 路径 类型 说明
value
value array of TenantResourceResponseModel
@odata.count
@odata.count integer
@odata.nextLink
@odata.nextLink string
continuationtoken(续传令牌)
continuationtoken string

TenantUserResponseModel

名称 路径 类型 说明
users
users array of TenantCapacityConsumptionUserSnapshotResponseModel

与租户关联的用户列表。

TenantUserResponseModelPagedResponse

带有继续标记的分页响应。

名称 路径 类型 说明
value
value array of TenantUserResponseModel
@odata.count
@odata.count integer
@odata.nextLink
@odata.nextLink string
continuationtoken(续传令牌)
continuationtoken string

TestCaseResult

生成器评估运行中的测试用例的结果。

名称 路径 类型 说明
metricsResults
metricsResults array of Metric

与测试用例关联的分级程序指标列表。

状态
state TestCaseState

在创建者评估运行中测试用例的状态。

testCaseId
testCaseId uuid

测试用例的来源对象模型实体的 ID。

TestCaseState

在创建者评估运行中测试用例的状态。

在创建者评估运行中测试用例的状态。

TestRun

获取评估运行详细信息请求的响应有效负载。

名称 路径 类型 说明
cdsBotId
cdsBotId uuid

执行评估运行的 CDS 机器人 ID。

endTime
endTime date-time

评估运行结束时的时间戳。

environmentId
environmentId string

在其中执行评估运行的环境 ID。

id
id uuid

此评估运行的唯一标识符。

mcsConnectionId
mcsConnectionId string

评估运行中使用的 MCS 连接 ID。

姓名
name string

评估运行的名称。

所有者 ID
ownerId string

启动评估运行的所有者的 ID。

startTime
startTime date-time

评估运行启动时的时间戳。

状态
state EvaluationRunState

描述当前活动阶段的评估运行的状态。

testCasesResults
testCasesResults array of TestCaseResult

测试用例及其结果在评估运行中。

testSetId
testSetId uuid

与运行关联的对象模型测试集实体记录的 ID。

totalTestCases
totalTestCases integer

评估运行中包含的测试用例数。

TestRunCollection

创建者评估测试运行的集合。

名称 路径 类型 说明
value
value array of TestRun

测试运行的列表。

TestSet

获取测试集请求的响应有效负载。

名称 路径 类型 说明
auditInfo
auditInfo AuditInfo

资源的审核信息。

描述
description string

测试集的说明。

displayName
displayName string

测试集的显示名称。

id
id string

测试集组件的唯一标识符。

状态
state StateCode

描述当前活动阶段的评估运行的状态。

totalTestCases
totalTestCases integer

测试集中的测试用例数。

TestSetCollection

制造商评估测试集的集合。

名称 路径 类型 说明
value
value array of TestSet

测试集的列表。

ToggleAFDTrafficRoutingResponse

名称 路径 类型 说明
消息
message string

描述切换操作结果的结果消息。

UserIdentity

表示用户的标识。

名称 路径 类型 说明
userId
userId string

用户的 ID。

类型
type string

用户标识的类型(例如用户)。

displayName
displayName string

用户的显示名称。

tenantId
tenantId string

用户的租户 ID。

UserPerFlowCapacitySourceFlowContextRecord

每个流容量源的流上下文摘要。

名称 路径 类型 说明
tenantId
tenantId uuid

租户标识符。

environmentId
environmentId uuid

环境标识符。

userId
userId string

用户标识符。

flowContext
flowContext string

在其中执行流的上下文。

flowLicenseCategorization
flowLicenseCategorization string

流的许可证分类。

consumptionDate
consumptionDate date-time

消耗日期。

totalConsumption
totalConsumption integer

流的总消耗单位。

flowId
flowId string

流标识符。

UserPerFlowCapacitySourceRecord

特定流执行的详细容量源记录。

名称 路径 类型 说明
tenantId
tenantId uuid

租户标识符。

environmentId
environmentId uuid

环境标识符。

userId
userId string

用户标识符。

flowContext
flowContext string

在其中执行流的上下文。

flowLicenseCategorization
flowLicenseCategorization string

流的许可证分类。

resourceId
resourceId string

资源标识符。

consumptionUnits
consumptionUnits integer

使用的消耗单位数。

consumptionDate
consumptionDate date-time

消耗发生的日期。

UserPerFlowCapacitySourceTenantContextSummaryRecord

每个流容量源的租户级上下文摘要。

名称 路径 类型 说明
tenantId
tenantId uuid

租户标识符。

flowContext
flowContext string

在其中执行流的上下文。

countOfUsersInCompliance
countOfUsersInCompliance integer

容量限制范围内的用户数。

countOfUsersExceedingCapacity
countOfUsersExceedingCapacity integer

超出容量限制的用户数。

countOfUsersWithoutALicense
countOfUsersWithoutALicense integer

没有任何许可证的用户数。

countOfUsersWithoutPremiumLicenseUsingPremiumFeatures
countOfUsersWithoutPremiumLicenseUsingPremiumFeatures integer

在没有高级许可证的情况下使用高级功能的用户数。

UserPerFlowCapacitySourceUserContextRecord

每个流容量源的用户上下文摘要。

名称 路径 类型 说明
tenantId
tenantId uuid

租户标识符。

userId
userId string

用户标识符。

flowContext
flowContext string

在其中执行流的上下文。

flowLicenseCategorization
flowLicenseCategorization string

流的许可证分类。

consumptionDate
consumptionDate date-time

消耗日期。

totalConsumption
totalConsumption integer

用户的总消耗单位。

总容量
totalCapacity integer

用户可用的总容量。

totalFlows
totalFlows integer

用户执行的流总数。

WafRuleAction

要对规则执行的作

要对规则执行的作

WafRuleType

WAF 规则类型

WAF 规则类型

WebApplicationFirewallConfiguration

名称 路径 类型 说明
ManagedRules
ManagedRules array of object
id
ManagedRules.id string

托管规则集的唯一标识符

姓名
ManagedRules.name string

托管规则集的名称

provisioningState
ManagedRules.properties.provisioningState string

托管规则集的预配状态

ruleSetId
ManagedRules.properties.ruleSetId string

规则集的唯一标识符

规则集类型
ManagedRules.properties.ruleSetType string

规则集的类型

ruleSetVersion
ManagedRules.properties.ruleSetVersion string

规则集的版本

ruleGroups
ManagedRules.properties.ruleGroups array of object
ruleGroupName (规则组名称)
ManagedRules.properties.ruleGroups.ruleGroupName string

规则组的名称

描述
ManagedRules.properties.ruleGroups.description string

规则组的说明

规则
ManagedRules.properties.ruleGroups.rules array of object
规则 ID
ManagedRules.properties.ruleGroups.rules.ruleId string

规则的唯一标识符

defaultState
ManagedRules.properties.ruleGroups.rules.defaultState string

规则的默认状态

defaultAction
ManagedRules.properties.ruleGroups.rules.defaultAction WafRuleAction

要对规则执行的作

描述
ManagedRules.properties.ruleGroups.rules.description string

规则的说明

自定义规则
CustomRules array of CustomRule

WebApplicationFirewallPolicySettings

策略级 Web 应用程序防火墙设置。 所有属性都是可选的;仅应用提供的属性,并且任何省略的属性保持不变。

名称 路径 类型 说明
mode
mode string

Web 应用程序防火墙强制模式。 防护阻止匹配请求;检测仅记录它们。

javascriptChallengeExpirationInMinutes
javascriptChallengeExpirationInMinutes integer

JavaScript 质询 Cookie 有效期(以分钟为单位)。 接受的范围通过Azure Front Door进行验证。

captchaExpirationInMinutes
captchaExpirationInMinutes integer

CAPTCHA 质询 Cookie 有效期(以分钟为单位)。 接受的范围通过Azure Front Door进行验证。

Web应用程序防火墙状态

Web 应用程序防火墙状态

Web 应用程序防火墙状态

WebsiteDto

名称 路径 类型 说明
id
id string

网站唯一标识符(ID)

姓名
name string

网站名称

createdOn
createdOn string

ISO 8601 UTC 格式的网站创建时间

模板名称
templateName string

网站模板名称

websiteUrl
websiteUrl string

网站 URL

tenantId
tenantId string

网站的租户唯一标识符(ID)

dataverseInstanceUrl
dataverseInstanceUrl string

网站的组织 URL

environmentName
environmentName string

网站的环境名称

environmentId
environmentId string

网站的环境唯一标识符(ID)

dataverseOrganizationId
dataverseOrganizationId string

网站的组织唯一标识符(ID)

selectedBaseLanguage
selectedBaseLanguage integer

语言 ID - https://go.microsoft.com/fwlink/?linkid=2208135

customHostNames
customHostNames array of string

为网站添加的自定义主机名

websiteRecordId
websiteRecordId string

网站的 Dataverse 记录唯一标识符(ID)

子域
subdomain string

网站的子域

packageInstallStatus
packageInstallStatus string

网站的包安装状态

类型
type string

网站的应用程序类型

trialExpiringInDays
trialExpiringInDays integer

网站到期时间(以天为单位)

suspendedWebsiteDeletingInDays
suspendedWebsiteDeletingInDays integer

网站删除的时间(以天为单位),如果已暂停

packageVersion
packageVersion string

网站的包版本

isEarlyUpgradeEnabled
isEarlyUpgradeEnabled boolean

提前升级的网站资格

isCustomErrorEnabled
isCustomErrorEnabled boolean

网站自定义错误启用

applicationUserAadAppId
applicationUserAadAppId string

Entra ID (前Azure Active Directory) 对象唯一标识符 (ID)

所有者 ID
ownerId string

网站所有者的用户唯一标识符(ID)

状态
status string

网站状态

siteVisibility
siteVisibility string

网站可见性状态

WorkflowStateCode

指示工作流状态。

指示工作流状态。

WorkflowStatusCode

指示工作流状态。

指示工作流状态。

二进制

这是基本数据类型“binary”。

字符串

这是基本数据类型“string”。