本文介绍了每个 Copilot 托管运行时 CLI 命令(包含语法和参数),可帮助你从命令行生成、部署和共享应用。 Copilot 托管运行时 CLI 发布为 @microsoft/cmr-cli 和调用为 ms.
大多数命令对当前目录中的应用执行操作,并从其本地配置 (应用名称、环境、存储库绑定) 读取默认值。 从包含应用的目录运行命令,除非某个标志明确允许你定位另一个应用。
此参考按典型的开发人员工作流任务对每个命令进行分组:
命令索引
下表按字母顺序列出了这些命令:
全局标志
每个命令都接受以下标志。
| Flag | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--json |
否 | 将结果输出为单个 JSON 对象 (或用于流式命令的 NDJSON) 。 在脚本和 CI 中使用此标志。 | |
--non-interactive |
否 | 在没有提示的情况下运行。 通过标志或环境变量提供所有必需的值。 在脚本和 CI 中使用此标志。 | |
--no-color |
否 | 禁用彩色输出。 | |
--cloud <cloud> |
否 | 目标云环境。 有效值 (默认值为 public) 、 usgov、 usgovhigh、 usgovdod和 china。 |
|
--version |
-v |
否 | 打印 CLI 版本。 |
--help |
-h |
否 | 显示命令的帮助,包括所有可用标志。 |
提示
在 ms 不带分组顶级帮助、 ms app 应用子命令和 ms app <verb> --help 谓词标志的参数的情况下运行。 钻取时,功能将逐渐浮出水面。
身份验证
每台计算机登录一次。 所有其他命令假定针对启用了 Copilot 托管运行时的租户进行经过身份验证的会话。
ms auth login
通过浏览器登录到 Microsoft Entra ID。 将新帐户添加到缓存并使其处于活动状态。
ms auth login [--account <email>]
ms auth login
account 参数
尝试以所选帐户登录,这对于多帐户方案非常有用。 若要在已缓存的帐户中进行选取,请改用 ms auth switch 。
ms auth logout
清除所有缓存的凭据并删除活动帐户指针。
ms auth logout
若要更改不注销的情况下处于活动状态的帐户,请使用 ms auth switch。
ms auth status
列出缓存的帐户。 缓存多个帐户时,活动帐户 () 其他命令使用的帐户标记为 *.
ms auth status
ms auth switch
为后续命令激活其他缓存帐户。
ms auth switch [--account <email>]
ms auth switch
account 参数
要激活的帐户。 在具有多个缓存帐户的交互模式下,如果省略此标志,CLI 将提示你进行选择。 在非交互模式下和使用 --json.
Git 身份验证
某些命令需要验证 Microsoft Entra 标识是否已映射到有权访问绑定存储库的 GitHub 用户。 首次需要ms app createms app build映射时,内ms app deploy联运行 GitHub 设备代码流 - 首次设置无需主动刷新。 用于 ms git auth refresh 显式重新身份验证 (例如,在将 GitHub 帐户切换) 时。
ms git auth refresh
为 GitHub Enterprise Cloud 组织拥有的存储库刷新或建立 Microsoft Entra ↔ GitHub 标识映射。
ms git auth refresh --repo <url> [--open-browser]
该命令打印验证 URL 和用户代码,供你粘贴到浏览器中。 成功后,它将打印经过身份验证的 GitHub 登录名和映射的到期时间戳。 按下可 Ctrl+C 干净地取消轮询循环。
ms git auth refresh parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--repo |
-r |
是 | GitHub Enterprise Cloud 组织拥有的存储库的完整 URL。 例如,https://contoso.ghe.com/contoso/my-app 或 https://github.com/contoso/my-app。 CLI 仅执行最低限度的检查,检查 URL 是否具有用于派生登录终结点) 的主机 (,而不强制实施主机或方案规则本身。 平台是支持主机和提供商的机构。 如果未设置此值,CLI 将在交互模式下提示。 |
--open-browser |
否 | 最好:除了打印验证 URL 外,还可以启动系统浏览器。 默认为仅打印。 |
创建应用
使用这些命令创建新的 Copilot Runtime 应用或注册现有项目。
在 GitHub Enterprise Cloud 中配置存储库可见性和其他存储库管理策略。 有关详细信息,请参阅在 企业中实施存储库管理策略。
ms app create
创建新应用,将项目模板基架到目录中,并设置源代码管理。
ms app create --display-name <name> [directory] [options]
ms app create parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--display-name <name> |
-n | 是 | 应用的显示名称。 |
[directory] |
否 | 目标目录。 它必须是空的。 如果省略,CLI 将创建一个以应用显示名称命名的目录。 显式传递 . 以使用当前目录。 |
|
--environment-id <id> |
-e | 否 | 目标环境。 如果省略,CLI 将使用开发人员环境,在首次运行时预配一个环境。 |
--description <text> |
-d | 否 | 存储在应用记录上的自由文本说明。 |
--template <name> |
-t | 否 | GitHub 存储库或子路径,以从 (基架应用,例如, github:owner/repo/subdir) 。 默认为内置 Vite 模板。 适用于所有 --repo 模式。 |
--repo <url> |
否 | 源代码管理绑定。 省略平台托管的 (GRS) Git (默认) 。 传递 GitHub Enterprise Cloud 组织拥有的存储库的完整 https:// URL(例如, https://contoso.ghe.com/contoso/my-app 或 https://github.com/contoso/my-app )以克隆和绑定现有的空外部 GitHub 存储库。 传递 none 以跳过所有 Git 绑定 (基架模板并仅写入 ms.config.json ,没有本地存储库或远程) 。 不能与 --repository-id组合使用。 |
|
--repository-id <id> |
-r | 否 | 要与应用关联以进行源代码管理的存储库 ID。 不能与 --repo组合使用。 |
--build-path <path> |
-b | 否 | 生成输出目录。 默认为 ./dist。 |
--build-command <cmd> |
-S | 否 | 用于生成应用的完整 shell 命令。 默认为 npm run build。 |
--build-entry-point <file> |
否 | 入口点 HTML 文件。 默认为 index.html。 |
|
--open-browser |
否 | 最好:如果需要重新对设备代码流进行身份验证,请启动系统浏览器。 对 无效。--json |
|
--force-reauth |
否 | 绕过存储的 GitHub 映射并强制设备代码流,就像映射已过期一样。 仅影响绑定到外部 GitHub 存储库的应用。 |
注意
- 对于
--repo <url>,CLI 将外部 GitHub 存储库克隆到目录中并覆盖模板。 存储库必须存在并且为空。 - 对于
--repo none,CLI 将基架模板并写入ms.config.json,但不会初始化本地 Git 存储库或绑定远程存储库。 这将创建一个应用,供你自己生成和部署的外部工件部署。 有关示例,请参阅 使用 GitHub Actions 部署 Microsoft Copilot 托管运行时应用。 - 如果 GitHub 映射缺失或已过期,
ms app create则在带内运行设备代码流并重试一次。
ms app init
将现有 Web 项目注册为应用,而无需基架文件。
ms app init --display-name <name> [options]
ms app init parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--display-name <name> |
-n | 是 | 应用的显示名称。 |
--environment-id <id> |
-e | 否 | 目标环境。 默认为用户的开发人员环境。 |
--description <text> |
-d | 否 | 自由文本说明。 |
--build-path <path> |
-b | 否 | 生成输出目录。 默认为 ./dist。 |
--build-command <cmd> |
-S | 否 | 用于生成应用的完整 shell 命令。 默认为 npm run build。 |
--build-entry-point <file> |
否 | 入口点 HTML 文件。 默认为 index.html。 |
|
--repo <value> |
否 | 存储库行为。 省略以自动检测当前的 Git 设置 (并在交互模式) 中提示。 传递 native 以强制平台管理的 (GRS) 存储库, none 用于外部项目部署 (没有平台管理的存储库) ,或要绑定到已克隆到当前目录的现有 GitHub 存储库的存储库 URL。 |
|
--icon-path <path> |
否 | 或应用图标的.png.jpg可选路径,写入为 ms.config.jsoniconPath. |
|
--local-app-url <url> |
否 | 可选本地开发 URL,写入 ms.config.json 为 localAppUrl. |
|
--open-browser |
否 | 尽力在设备代码流期间启动系统浏览器。 对 无效。--json |
|
--force-reauth |
否 | 绕过存储的 GitHub 映射,并在第一次尝试时强制使用设备代码流。 可用于恢复损坏的映射。 |
注意
- 如果当前目录已经是应用,则失败。
- 不搭建模板文件。 源代码管理行为依赖于
--repo省略) 时从当前目录自动检测到的 (。 - 对于外部 GitHub 分支,与 相同的内联设备代码流重新身份验证适用于
ms app create。
ms app clone
克隆现有应用的平台管理的 Git 存储库,并为将来的提取和推送操作配置 Git 身份验证。
ms app clone --app <app-id> [directory]
ms app clone parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <app-id> |
是 | 你有权编辑访问的应用的应用 ID。 用于 ms app list --permission edit 查找应用 ID。 |
|
[directory] |
否 | 目标目录。 它必须是空的。 如果省略,CLI 将创建一个以应用显示名称命名的目录。 显式传递 . 以使用当前目录。 |
注意
ms app clone 支持平台管理的 Git 存储库。 对于使用外部 GitHub 或 GitHub Enterprise Cloud 存储库的应用,请改用 git clone <repository-url> 。 无法克隆没有源代码管理绑定的应用。
发现连接器
在将连接器添加到应用之前,请使用这些命令查找可用的连接器并检查其操作。
ms connector list
列出环境中可用的连接器。
ms connector list [--environment-id <id>] [--search <term>] [--only-allowed]
除非你通过 --only-allowed,否则发现包括策略阻止的连接器。 文本表包括连接器 ID、表格支持标志,以及基于数据丢失防护 (DLP) 和高级连接器策略 (ACP) 的统一策略状态。 JSON 输出包括更详细的连接器和策略字段。
ms connector list parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--environment-id <id> |
-e | 否 | 要查询的环境。 默认值从存在时开始 ms.config.json 。 |
--search <term> |
-s | 否 | 按连接器显示名称或 ID 上的子字符串匹配筛选 (不区分大小写的) 。 |
--only-allowed |
否 | 仅列出策略允许的连接器。 默认情况下,发现包括阻止的连接器。 |
ms connector list-actions
列出连接器公开的操作,包括每个操作的数据丢失防护 (DLP) 状态。
ms connector list-actions [--environment-id <id>] --connector <connector> [--search <term>]
ms connector list-actions parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--connector <connector> |
是 | 要检查的连接器,由 ID 指定。 | |
--environment-id <id> |
-e | 否 | 要查询的环境。 默认值从存在时开始 ms.config.json 。 |
--search <term> |
-s | 否 | 按子字符串筛选操作摘要或操作 ID 匹配 (不区分大小写的) 。 |
管理应用资源
使用这些命令添加、删除和刷新应用所依赖的数据源。
添加应用资源
从包含应用的目录运行所有 add 命令。 默认情况下, ms app add data-source 在 下生成 TypeScript 模型和服务 generated/。
ms app add backend
将 Fabric 数据库后端添加到应用。 在运行此命令之前,管理员必须为环境启用 Fabric 集成。
ms app add backend --provider fabric
ms app add backend parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--provider <provider> |
是 | 要添加的后端提供程序。 当前,唯一的有效值为 fabric。 |
有关数据库后端的先决条件和详细信息,请参阅 Fabric 与 Copilot 托管运行时集成。
ms app add data-source
将连接器添加到应用。 该命令会自动在表和操作数据源之间进行选择。
ms app add data-source --connector <connector> [options]
注意
- CLI 会自动将非表格连接器添加为操作。
- 对于表格连接器,CLI 会在交互模式下提示使用表与操作。 必须在非交互模式下指定
--as。 - DLP 和 ACP 预检在命令添加任何操作或表之前运行。 CLI 会筛选出阻止的操作并报告跳过的计数。
ms app add data-source parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--connector <connector> |
是 | 要按 ID (例如, shared_office365) 或显示名称添加的连接器。ms connector list |
|
--as <mode> |
条件 | 强制 table 或 action 派遣。 当连接器支持表时,在非交互模式下是必需的。 |
|
--connection-id <id> |
-c | 否 | 要使用的现有连接。 省略时,CLI 会提示。 |
--dataset <name> |
-d | 否 | 数据集 (与) 一起使用 --as table 。 |
--table <name> |
-t | 否 | 用于添加) (--as table 的表。 对于 Dataverse (shared_commondataserviceforapps) ,表逻辑名称。 |
--dataverse-environment-id <guid> |
否 | Dataverse 环境 ID。 仅用于 --connector shared_commondataserviceforapps 绑定到特定表。 |
|
--use-sso |
否 | 首选单一登录 (Entra ID) 连接:重用第一个现有 SSO 连接,或无提示创建一个。 如果连接器不支持 SSO,则会出错。 在提供时 --connection-id 忽略。 |
删除应用资源
在交互模式下,删除命令会提示确认,除非你通过 --force。 在非交互模式下,即使省略 --force,删除也会在不确认的情况下继续进行。
ms app remove data-source
从应用中删除之前添加的数据源 (表或操作) 。
ms app remove data-source [--name <name>] [--force]
ms app remove data-source parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--name <name> |
-n | 否 | 要删除的数据源的名称。 省略时,CLI 会提示您从应用的数据源中进行选择。 |
--force |
-f | 否 | 跳过确认提示。 |
刷新应用资源
使用此命令将生成的应用类型与最新的源架构更改同步。
ms app refresh data-source
重新提取架构并为绑定数据源重新生成 TypeScript。
ms app refresh data-source [--name <name>]
在基础架构更改后运行此命令 (例如,) SharePoint 列表中的新列来保持生成的 TypeScript 同步。
ms app refresh data-source parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--name <name> |
-n | 否 | 刷新特定数据源。 省略以刷新所有绑定源。 |
在本地开发
使用这些命令通过配置服务器在本地运行应用以进行迭代开发。
ms app dev
启动完整的本地开发循环。
ms app dev [--port <n>] [--local-app-url <url>] [--config-only]
CLI 与本地配置服务器一起启动项目的开发过程。 一旦两者都可访问,就会打印播放 URL。 按下 Ctrl+C 可以干净地停止它们。
ms app dev parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--port <n> |
-p | 否 | 配置服务器的端口。 默认为 8080。 |
--local-app-url <url> |
-l | 否 | 可访问开发服务器的 URL。 默认为 http://localhost:3000。 |
--config-only |
-C | 否 | 仅启动配置服务器,因为当你单独运行开发服务器时 (例如,在进程管理器) 下。 |
生成和部署
使用这些命令在本地打包、运行远程生成和部署经过验证的提交。
ms app pack
在本地生成应用并暂存输出以供检查,而无需将其上传到任何地方。
ms app pack
在触发远程生成之前,使用此命令验证干净的本地生成是否成功。
ms app build
为 Git 支持的应用上的特定提交触发平台生成。
ms app build --app <name> --commit <sha> [--no-wait] [--open-browser] [--force-reauth]
ms app build parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 应用名称。 默认值从存在时开始 ms.config.json 。 |
|
--commit <sha> |
-c | 否 | 提交到生成。 默认为当前 HEAD. |
--no-wait |
否 | 提交后立即返回并打印提示以跟进。ms app build-status 默认情况下,该命令等待生成达到终端状态。 |
|
--open-browser |
否 | 如果需要对外部 GitHub 存储库进行设备代码流重新身份验证,请尽力启动系统浏览器。 对 无效。--json |
|
--force-reauth |
否 | 绕过存储的 GitHub 映射并强制设备代码流。 仅影响绑定到外部 GitHub 存储库的应用。 |
ms app build-status
检查内部版本的状态。
ms app build-status --app <name> --commit <sha> [--show-log]
如果构建失败,则输出会包含原因,以便您可以修复代码并再次推送。
ms app build-status parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要检查的应用。 默认值从存在时开始 ms.config.json 。 |
|
--commit <sha> |
-c | 否 | 提交以检查生成状态。 默认为当前 HEAD. |
--show-log |
否 | 提取并打印生成日志(如果可用)。 |
ms app deploy
将绿色生成推广到实时应用。
ms app deploy [--app <name>] [--commit <sha>] [--artifact <path>] [--force] [--open-browser] [--force-reauth]
注意
- 该命令将部署到与应用关联的环境。 它不选择部署环境。
- 对于 Git 支持的应用,CLI 将提交解析 (默认本地 Git
HEAD) ,将远程版本排队或为该提交重用缓存版本,等待完成,然后部署相同的提交。 生成失败或取消会停止部署;CLI 不会选择较旧的成功生成。 - 如果签出在远程之前有未提交的更改或本地提交,则预检将在交互模式下询问“仍然部署? 在非交互式或 JSON 模式下,除非你传递
--force,否则它将停止并显示使用错误 。 在部署之前提交并推送预期更改。--force绕过飞行前;它不会上传未提交或未推送的源。 - 对于没有源代码管理 (
repoType: none) 的应用,CLI 会打包并上传本地版本,或者在提供预生成.zip时--artifact上传。
ms app deploy parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要部署的应用。 默认值为 ms.config.json. |
|
--commit <sha> |
-c | 否 | 承诺仅) 部署 (Git 支持的应用。 默认为当前 HEAD. 与 --artifact互斥。 |
--artifact <path> |
否 | 要上传和部署的本地 .zip 生成工件的路径。 仅对创建时没有源代码管理 (repoType: none) 的应用有效;在 Git 支持的应用上被拒绝。 与 --commit互斥。 |
|
--force |
否 | 绕过 Git 预检确认或拒绝未提交的更改或在远程之前进行本地提交。 不上传这些更改。 | |
--open-browser |
否 | 最好:如果需要重新对设备代码流进行身份验证,请启动系统浏览器。 对 无效。--json |
|
--force-reauth |
否 | 绕过存储的 GitHub 映射并强制设备代码流。 仅影响绑定到外部 GitHub 存储库的应用。 |
在部署完成之前,现有部署保持不变且可用。 部署完成后,最终用户会看到一条通知,提示有新版本可用,其中包含用于刷新应用的链接。
ms app deploy --artifact <path> 上传和部署工件,但没有平台管理的生成。 默认情况下不允许外部项目部署。 请参阅 外部项目部署。 组织负责验证外部生成的项目,并在部署之前保护生成管道。
Play
使用此命令以实时或预览模式打开应用。
ms app play
在浏览器中打开应用并打印其启动 URL。
ms app play [--app <name>] [--mode live | preview] [--commit <sha> | --branch <name>] [--no-browser]
ms app play parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要打开的应用。 默认值为 ms.config.json. |
|
--mode <mode> |
-m | 否 |
live 打开部署的应用。
preview 默认打开当前 Git 分支,或者你指定的分支或提交。 默认为 live。 |
--commit <sha> |
-c | 否 | 在特定提交时打开预览。 仅对 有效。--mode preview 与 --branch互斥。 |
--branch <name> |
否 | 打开特定分支的预览。 仅对 有效。--mode preview 默认为当前 Git 分支;如果 CLI 无法识别它,它会发出警告并回退到 main. 与 --commit互斥。 |
|
--no-browser |
否 | 打印启动 URL,而无需打开默认浏览器。 适用于 SSH 会话、CI 和脚本。 |
注意
--mode live 警告实时版本是快照,不会自动更新。 重新运行 ms app deploy 以刷新它。 如果没有可用的播放 URL,则命令失败。 如果 URL 存在,但目标没有部署的提交,则该命令会发出警告,并且仍会打印并打开 URL。
预览版本行为
在 --mode preview中,启动 URL 基于当前分支头的提交或所选提交 SHA。 在浏览器中看到的该 URL 取决于该提交的内部版本状态:
| 生成状态 | 预览行为 |
|---|---|
| 最新提交具有成功的构建 | 呈现生成。 |
| 最新提交仍在构建中 | 使用正在进行的横幅呈现之前成功的构建:“ 最新版本正在进行中。” |
| 最新提交无法生成 | 使用失败横幅呈现上一个成功的构建:“ 最新版本失败。显示上次成功的生成。” |
| 尚未成功生成应用 | 呈现专用的“从未部署”体验。 |
共享
使用这些命令授予、撤销和管理应用访问权限以及共享链接。
ms app share
向用户或组授予访问权限。
ms app share <principals> [--app <name>] [--access play | edit]
该命令会自动查找电子邮件地址。 它会报告未解析的条目警告,但会继续处理解析的条目。 如果没有条目解析,则命令失败。
ms app share parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
<principals> |
是 | 电子邮件地址或 Microsoft Entra 对象 ID 的逗号分隔列表。 | |
--app <name> |
否 | 要共享的应用。 默认值为 ms.config.json. |
|
--access <level> |
否 | 授予运行时访问权限 (play、默认) 或参与者访问权限 (edit) 。 编辑访问权限包括平台管理的 Git 的存储库权限;必须在 GitHub 中单独授予外部 GitHub 存储库访问权限。 |
ms app unshare
撤销以前授予的访问权限。
ms app unshare <principals> [--app <name>] [--access play | edit]
该 unshare 命令仅影响请求的访问级别。 例如, unshare --access editplay 使访问权限保持不变。 在请求的级别没有现有角色分配的主体是无操作的。
对于 GitHub 支持的应用,请在 GitHub 中单独撤销外部存储库访问权限。 取消共享应用不会删除独立授予的 GitHub 权限。
ms app unshare parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
<principals> |
是 | 电子邮件地址或 Microsoft Entra 对象 ID 的逗号分隔列表。 | |
--app <name> |
否 | 要取消共享的应用。 默认值为 ms.config.json. |
|
--access <level> |
否 | 撤销运行时访问权限 (play, () edit 的默认) 或参与者访问权限。 编辑访问权限包括平台托管 Git 的存储库权限,但不包括外部 GitHub 存储库权限。 |
ms app share list
列出在给定访问级别与应用共享的用户和组。
ms app share list --access <level> [--app <name>] [--environment-id <id>]
ms app share list parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--access <level> |
是 | 列表的访问级别。
play (运行应用) 或 edit (参与应用) 。 对于 GitHub 支持的应用,此列表不建立外部存储库访问权限。 |
|
--app <name> |
否 | 要检查的应用。 默认值为 ms.config.json. |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 默认值从存在时开始 ms.config.json 。 |
ms app share link create
为应用创建租户范围的共享链接。
ms app share link create [--app <name>] [--environment-id <id>]
ms app share link create parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要共享的应用。 默认值为 ms.config.json. |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 默认值从存在时开始 ms.config.json 。 |
ms app share link list
列出为应用颁发的共享链接。
ms app share link list [--app <name>] [--environment-id <id>]
ms app share link list parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要检查的应用。 默认值为 ms.config.json. |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 默认值从存在时开始 ms.config.json 。 |
ms app share link revoke
按 ID 撤销共享链接。 此命令会在卸除链接记录之前删除每个先前兑换者的角色。
ms app share link revoke --link-id <id> [--app <name>] [--environment-id <id>] [--force]
ms app share link revoke parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--link-id <id> |
-l | 是 | 从 ms app share link create返回的链接 ID。 |
--app <name> |
否 | 拥有链接的应用。 默认值为 ms.config.json. |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 默认值从存在时开始 ms.config.json 。 |
--force |
-f | 否 | 跳过确认提示。 |
检查和管理
使用这些命令查看应用状态、更新设置并在需要时删除应用。
ms app list
列出可访问的所有应用。 默认情况下,该命令会列出租户中的所有应用。 用于 --environment-id 将列表范围限定为单个环境。
ms app list [--environment-id <id>] [--permission <level>]
返回应用详细信息,例如显示名称和应用 ID。
ms app list parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--environment-id <id> |
-e | 否 | 将列表范围限定为单个环境。 如果省略,该命令将返回可在整个租户中访问的所有应用。 |
--permission <level> |
-p | 否 | 权限筛选器。 使用 edit 您可以参与) 的 (应用或 play (您可以播放或查看) 的应用。 不区分大小写。 |
ms app info
显示应用的服务器端状态。
ms app info [--app <name>] [--environment-id <id>]
返回显示名称、可选说明、环境 ID、应用 ID、项目 ID、已部署提交(缩写为 7 个字符)、连接器和可选存储库详细信息。 它不会返回所有者或启动 URL。
若要在不打开浏览器的情况下获取启动 URL,请用于 ms app play --no-browser 实时模式或 ms app play --mode preview --no-browser 预览模式。 添加 --json 结构化输出。 要检查实际的本地配置,请打开 ms.config.json; ms app info 报告服务器状态。
ms app info parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要检查的应用的名称。 默认值为 ms.config.json. 传递显式名称以检查当前工作目录之外的应用。 |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 默认值 ms.config.jsonfrom ;如果两者都未设置,则根据应用名称自动解析环境。 |
ms app get-settings
显示所有应用设置及其当前值。
ms app get-settings
ms app set-setting
更新一个或多个应用设置。
ms app set-setting [--show-header <bool>] [other-settings...]
将设置作为命名标志传递。 仅更新指定的键。
ms app set-setting parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--show-header <bool> |
否 | 显示或隐藏应用标题栏。 | |
[other-settings...] |
否 | 要更新的一个或多个已命名设置标志。 仅更改提供的密钥。 |
ms app delete
从环境中删除应用。 此命令不会删除本地源代码或 Git 存储库。
ms app delete [--app <name>] [--environment-id <id>] [--force]
如果应用不存在,该命令将干净退出,而不会出现错误。
ms app delete parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--app <name> |
否 | 要删除的应用。 默认值为 ms.config.json. |
|
--environment-id <id> |
-e | 否 | 替代环境 ID。 如果省略,则会从应用中自动解析环境。 用于从基架目录之外删除应用。 |
--force |
-f | 否 | 跳过确认提示。 |
管理
使用这些命令添加或删除应用所有者。 有关分步过程,请参阅 重新分配应用所有者。
注意
这些命令需要平台管理的 Git 存储库和 Power Platform 管理员或全局管理员权限。
ms admin add owner
添加一个或多个应用所有者,而无需删除现有所有者或更改其他角色分配。
ms admin add owner <principals...> --app <app-id> [--force]
ms admin add owner parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
<principals...> |
是 | 一个或多个电子邮件地址或 Microsoft Entra 对象 ID,用空格或逗号分隔。 对于服务主体,使用其对象 ID。 最多接受 100 个唯一主体。 | |
--app <app-id> |
是 | GUID 格式的应用 ID。 必须显式提供;未从本地配置中读取。 CLI 会自动发现应用的环境。 | |
--force |
-f | 否 | 跳过确认提示。 在 JSON 或非交互模式下添加所有者时不需要。 |
在交互模式下,除非指定 --force,否则该命令会要求确认。 在 JSON 或非交互模式下,它运行时不提示。
例如,要添加其他所有者:
ms admin add owner newowner@contoso.com --app <app-id>
若要在不提示的情况下添加多个所有者:
ms admin add owner newowner@contoso.com backupowner@contoso.com --app <app-id> --force --json
ms admin remove owner
删除匹配的应用所有者分配,而不自动分配次要角色。 其他角色分配(例如参与者访问权限)保持不变,因此人员可以通过另一个角色保留访问权限。
ms admin remove owner <principals...> --app <app-id> [--force]
ms admin remove owner parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
<principals...> |
是 | 一个或多个电子邮件地址或 Microsoft Entra 对象 ID,用空格或逗号分隔。 对于服务主体,使用其对象 ID。 最多接受 100 个唯一主体。 | |
--app <app-id> |
是 | GUID 格式的应用 ID。 必须显式提供;未从本地配置中读取。 CLI 会自动发现应用的环境。 | |
--force |
-f | 条件 | 跳过确认提示。 对 OR 一起--non-interactive是必需的--json。 不会绕过授权或最后所有者保护。 |
在交互模式下,除非指定 --force,否则该命令会要求确认。 如果未找到匹配的所有者分配,则此命令将成功而不会删除任何内容。 如果通过电子邮件匹配找不到作业,请使用该人员的 Microsoft Entra 对象 ID 重试。
例如,要删除所有者:
ms admin remove owner formerowner@contoso.com --app <app-id>
若要在自动化中删除所有者,请执行以下操作:
ms admin remove owner <object-id> --app <app-id> --force --json
重要
在删除所有者之前,请确认其他所有者可以维护该应用。 重新分配所有权时,请先添加并验证替代所有者。 该平台阻止您删除应用程序的最后一个所有者; --force 仅跳过确认。
结果报告已删除的分配、不匹配的主体和跳过的分配。 查看结果,而不是假设每个请求的所有者都已删除。 如果请求失败,请在重试之前检查当前分配,因为某些更改可能已经生效。
遥测
默认情况下,CLI 发送匿名遥测。 使用这些命令控制集合。
ms telemetry enable
启用遥测收集。
ms telemetry enable [--remote] [--console]
ms telemetry enable parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--remote |
否 | 控制将遥测发送到远程服务。 未给出标志时,此选项为默认值。 | |
--console |
否 | 将遥测事件打印到本地控制台。 |
传递两个标志以同时切换两个目标。
ms telemetry disable
关闭遥测收集。
ms telemetry disable [--remote] [--console]
ms telemetry disable parameters
| 参数 | 别名 | 是否必需? | 说明 |
|---|---|---|---|
--remote |
否 | 停止向远程服务发送遥测数据。 未给出标志时,此选项为默认值。 | |
--console |
否 | 停止将遥测事件打印到本地控制台。 |
传递两个标志以同时禁用这两个目标。
ms telemetry status
显示当前遥测设置。
ms telemetry status