Power Apps CLI 环境变量

使用环境变量配置 Power Apps CLI 身份验证,并在脚本和 CI/CD 管道中提供命令选项。 Power Apps CLI 定义的环境变量使用PA_CLI_前缀。

注释

环境变量是操作系统提供给应用程序的命名值。 Power Apps CLI 可识别此引用中所述的变量。 若要了解环境变量的工作原理以及如何管理它们,请参阅 有关环境变量的信息

本参考介绍了配置 Power Apps CLI 的操作系统环境变量。 这些变量不同于 Power Platform 解决方案环境变量,后者存储应用使用的配置值。

对于命令选项,CLI 按以下顺序解析值:

  1. 命令行选项
  2. 环境变量
  3. 默认值(如果选项有一个)
  4. 支持时交互式提示

命令行上提供的选项优先于其相应的环境变量。

Important

环境变量可以向其他进程、日志或 shell 历史记录公开机密。 存储在 PA_CLI_SP_CLIENT_SECRET CI/CD 平台的机密存储中,将其从日志中屏蔽,并且不会将机密提交到源代码管理。

设置环境变量。

以下示例在运行 Power Apps CLI 命令之前设置PA_CLI_ENVIRONMENT_ID

$env:PA_CLI_ENVIRONMENT_ID = "<environment-id>"
pa app list

环境变量仍可用于从同一终端会话启动的命令。 使用 shell 的标准命令在不再需要时将其删除。

身份验证

环境变量 Description
PA_CLI_ACCOUNT 指定或pa auth loginpa auth switch指定帐户。
PA_CLI_SP_CLIENT_ID 指定服务主体身份验证的Microsoft Entra应用程序(客户端)ID。
PA_CLI_SP_CLIENT_SECRET 指定服务主体身份验证的客户端机密。
PA_CLI_SP_TENANT_ID 指定服务主体身份验证的Microsoft Entra目录(租户)ID。
PA_CLI_USE_SP_AUTH 将值设置为 true (小写)以使用服务主体身份验证。

选择服务主体身份验证时,需要三 PA_CLI_SP_个 * 凭据变量。 尽管 CI=true 还选择服务主体身份验证以保持兼容性,但用于 PA_CLI_USE_SP_AUTH=true 使身份验证模式显式。

有关设置说明,请参阅使用服务主体发布Power Apps代码应用

全局命令选项

这些变量对应于跨 Power Apps CLI 命令可用的选项。

环境变量 相应的选项 Description
PA_CLI_CLOUD --cloud 选择目标云。 有效值为:
- public (默认)
- usgov
- usgovhigh
- usgovdod
- china
值不区分大小写。
PA_CLI_ENVIRONMENT_ID --environment-id 指定目标 Power Platform 环境 ID。

应用初始化

这些变量向 pa app init.

环境变量 相应的选项 Description
PA_CLI_APP_BUILD_PATH --build-path 指定生成输出目录。 默认值为 ./dist
PA_CLI_APP_DESCRIPTION --description 指定应用说明。
PA_CLI_APP_DISPLAY_NAME --display-name 指定应用显示名称。
PA_CLI_APP_FILE_ENTRY_POINT --file-entry-point 指定生成输出中的 HTML 入口点。 默认值为 index.html
PA_CLI_APP_TYPE --app-type 指定应用类型。 有效值为:
- CodeApp (默认)
- MobileApp
该值在发布应用时保存并 power.config.json 用作应用类型。
PA_CLI_APP_URL --app-url 指定本地应用 URL。pa app init 该值保存为 localAppUrl in power.config.json ,并成为将来 pa app run 命令的默认 URL。 默认值为 http://localhost:3000

运行应用

这些变量向 pa app run.

环境变量 相应的选项 Description
PA_CLI_LOCAL_APP_URL --local-app-url localAppUrl重写当前命令的值power.config.json,而无需更改保存的配置。 如果未设置两个值,则默认值为 http://localhost:3000
PA_CLI_PORT --port 指定Power Apps本地主机的端口。 默认值为 8080

共享应用

这些变量向 pa app share.

环境变量 相应的选项 Description
PA_CLI_SHARE_ACCESS --access 指定访问级别。 有效值为:
- play (默认)
- edit
PA_CLI_SHARE_PRINCIPAL --principal 指定一个或多个逗号分隔的电子邮件地址或Microsoft Entra对象 ID。

解决方案、连接器和数据源

环境变量 相应的选项 Description
PA_CLI_CONNECTION_DISPLAY_NAME --display-name 指定创建连接时的显示名称。
PA_CLI_CONNECTION_ID --connection-id 指定连接器连接实例 ID。
PA_CLI_CONNECTION_REF --connection-ref 指定连接引用逻辑名称。
PA_CLI_CONNECTION_SEARCH --search 筛选来自 pa connection list. 的结果。
PA_CLI_CONNECTOR --connector 指定连接器 ID,例如 shared_office365users
PA_CLI_CONNECTOR_SEARCH --search 筛选来自 pa connector list. 的结果。
PA_CLI_DATASET --dataset 指定数据集,例如SharePoint站点或 SQL 数据库。
PA_CLI_DATA_SOURCE_NAME --name 指定要刷新或删除的数据源。
PA_CLI_ORG_URL --org-url 重写用于在添加数据源时检索元数据的 Dataverse 组织 URL。
PA_CLI_PROCEDURE --procedure 指定 SQL 存储过程。
PA_CLI_SOLUTION_ID --solution-id 指定或 pa app pushpa app add data-sourcepa connection list-references.
PA_CLI_SOLUTION_SEARCH --search 筛选来自 pa solution list. 的结果。
PA_CLI_TABLE --table 指定表或连接器资源名称。

有关接受每个选项的命令,请参阅 Power Apps CLI 命令参考

Dataverse API 和Power Automate流

环境变量 相应的选项 Description
PA_CLI_DATAVERSE_API_NAME --api-name 指定要与 pa 应用一起添加 dataverse-api 的 Dataverse 操作或函数。
PA_CLI_DATAVERSE_API_SEARCH_TERM --search 使用 pa app find-dataverse-api.. 按名称筛选 Dataverse 操作和函数。
PA_CLI_FLOW_DATA_SOURCE_NAME --flow-name 指定要从应用中删除的流数据源 pa app remove flow
PA_CLI_FLOW_ID --flow-id 指定要添加pa app add flow的Power Automate流。
PA_CLI_FLOW_SEARCH --search 使用 按名称筛选可用的Power Automate流pa app list-flows
PA_CLI_REMOVE_FLOW_ID --flow-id 指定要删除的Power Automate流pa app remove flow

遥测和控制台输出

环境变量 相应的选项 Description
PA_CLI_CONSOLE_ONLY --console-only 将值设置为 true (小写), pa telemetry enablepa telemetry disable 仅将遥测数据写入控制台,而不将其远程发送。
PA_CLI_OUTPUT_TO_CONSOLE --output-to-console 将值设置为 true (小写), pa telemetry enable 或者 pa telemetry disable 将遥测事件远程发送到控制台。
PA_CLI_TELEMETRY 没有 设置以下值之一以禁用当前进程的遥测:
- 0
- false
- no
- off
值不区分大小写,并且忽略周围空格。

有关持久性遥测设置,请参阅管理 Power Apps CLI 的遥测设置

标准环境变量

CLI 还观察此标准环境变量:

环境变量 Description
NO_COLOR 将此变量设置为非空值以禁用 ANSI 颜色输出。 也可以使用该 --no-color 选项。