安装扩展

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

安装、分配、禁用和卸载扩展,为 Azure DevOps 添加新特性和功能。

有关扩展的详细信息,请参阅开发和发布概述。

先决条件

类别 要求
权限 “项目集合管理员”组的成员。 组织所有者自动是此组的成员。 如果没有权限,可以改为请求扩展查找项目集合管理员
扩展共享 与组织共享的专用扩展。
类别 要求
权限 项目集合管理员组的成员或拥有编辑集合级别信息权限。 组织所有者自动是此组的成员。 如果没有权限,可以改为请求扩展查找项目集合管理员
扩展共享 与组织共享的专用扩展。

注意

若要使用现有的 Azure 订阅进行计费,请至少具有该订阅的共同管理员权限。 如果没有权限,Azure 帐户管理员或服务管理员可以 将你作为共同管理员添加到 Azure 门户中的 Azure 订阅。

项目集合可重复使用你的 Azure 订阅,以便将来在市场购买。 在哪里可以找到有关 Azure 计费的详细信息?

安装扩展

执行以下步骤,将扩展安装到组织。

  1. 登录到您的组织 (https://dev.azure.com/{Your_Organization})。

  2. 选择购物袋图标,然后选择“ 浏览市场”。

    显示了高亮显示的购物袋图标和“浏览市场”按钮选择的屏幕截图。

  3. 找到要安装的扩展,然后选择“ 免费获取”。

    屏幕截图显示红色正方形突出“免费获取”按钮。

  4. 从下拉菜单中选择组织,然后选择“安装以安装扩展。

    为此扩展选择组织

扩展现已安装! 现在可以前往组织以使用扩展。 此外,请告知团队此扩展,以便他们可以开始使用其功能。

安装的扩展

高特权、管道装饰器和未发布的扩展

具有高特权作用域、管道修饰器或未发布的状态的扩展可能会在未正确审查的情况下带来潜在的安全风险。 高特权范围允许广泛访问组织的资源,而管道装饰器可以修改组织中的所有管道。 未发布的扩展可能不再由其发布者维护。 有关管理这些类型的扩展的详细信息,请参阅 管理高特权范围、管道修饰器和未发布的扩展

卸载或禁用扩展

  1. 登录到您的组织 (https://dev.azure.com/{Your_Organization})。

  2. 选择 齿轮图标组织设置

    显示“Open Organization”设置的屏幕截图。

  3. 选择“扩展,然后选择要卸载或禁用的扩展。

    显示选择卸载或禁用扩展的屏幕截图。

  4. 选择“ 卸载 ”或选择省略号(...),然后选择“ 禁用”。

    显示禁用或卸载扩展操作的屏幕截图。


若要卸载集合中的扩展,请执行以下步骤:

  1. 转到本地画廊管理门户(http://{server}:8080/tfs/_gallery/manage)。

  2. 对于所需的扩展,请选择省略号(...),然后选择“ 删除”。

    显示“删除扩展”操作的屏幕截图。

通过命令行启用或列出扩展

使用 az devops extension enable 命令启用扩展。 要开始,请参阅 Azure DevOps CLI 入门

az devops extension enable --extension-name
                           --publisher-name
                           [--org]

参数 - 启用扩展

  • extension-name:要启用的扩展的名称。
  • publisher-name:扩展发布者的名称。
  • org:Azure DevOps 组织 URL。 使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或使用 选取 git config,则为必需。 示例:--org https://dev.azure.com/MyOrganizationName/

示例 - 启用扩展

以下命令启用 Timetracker 扩展,并按表格式显示结果。

az devops extension enable --extension-name Timetracker --publisher-name 7pace --output table

Publisher Id    Extension Id    Name         Version      Last Updated     States
--------------  --------------  -----------  -----------  ---------------  --------
7pace           Timetracker     Timetracker  5.0.1.34507  2019-11-13       none

列表扩展

可以使用 az devops extension list 命令列出组织中安装的扩展。 要开始,请参阅 Azure DevOps CLI 入门

az devops extension list [--include-built-in {false, true}]
                         [--include-disabled {false, true}]
                         [--org]

可选参数 - 列表扩展

  • include-built-in:包括内置扩展。 接受的值为 true (默认值)和 false
  • include-disabled:包含被禁用的扩展功能。 接受的值为 true (默认值)和 false
  • org:Azure DevOps 组织 URL。 可以使用az devops configure -d organization=ORG_URL配置默认组织。 如果未配置为默认或使用 选取 git config,则为必需。 示例:--org https://dev.azure.com/MyOrganizationName/

示例 - 列表扩展

以下命令列出了组织中的扩展。 它排除已禁用和内置扩展,并按表格式显示结果。

az devops extension list --include-built-in false --include-disabled false -output table

Publisher Id    Extension Id             Name                     Version              Last Updated     States         		 Flags
--------------  -----------------------  -----------------------  -------------------  ---------------  -----------------------  -------
ms              vss-analytics            Analytics                18.160.0.2130149925  2019-11-22       multiVersion, truste...  trusted
ms              vss-code-search          Code Search              18.160.0.1640944814  2019-11-22       multiVersion, truste...  trusted
ms              vss-plans                Delivery Plans           18.160.0.1266795967  2019-11-25       multiVersion, truste...  trusted
ms-eswm         dependencytracker        Dependency Tracker       2.1910.12801         2019-10-28       none
ms-devlabs      workitem-feature-tim...  Feature timeline and...  0.0.357              2019-10-14       none
AgileParts      gantt                    GANTT chart              1.0.79               2019-10-25       none
gordon-bee...   github                   GitHub Widget            0.10.0               2016-03-16       none
ms-devlabs      vsts-extensions-mult...  Multivalue control       2.2.26               2019-11-15       none
agile-exte...   product-vision           Product Vision           2.0.6                2019-06-04       none
mohitbagra      related-workitems        Related Work items       2.0.4                2017-11-12       none
YodLabs         TagsManager2             Tags Manager             0.9.31               2019-02-04       none
ms-devlabs      team-calendar            Team Calendar            2.0.15               2019-11-01       none
ms              vss-testmanager-web      Test Manager for TFS...  18.160.0.2130893445  2019-11-25       multiVersion, truste...  trusted
mmanela         vsts-workitem-recent...  Who recently viewed ...  1.0.4                2019-03-22       none
ottostreif...   wiql-editor              Wiql Editor              2.0.90               2019-06-21       none
mohitbagra      workitem-checklist       Work item checklist      3.2.4                2019-06-24       none
mohitbagra      witoneclickactions       Work item form one c...  2.3.2                2018-04-03       none
ms-devlabs      WorkItemVisualizatio...  Work Item Visualizat...  1.4.64               2018-04-03       none

列表扩展信息

您可以使用 az devops extension show 命令列出有关扩展的详细信息。 要开始,请参阅 Azure DevOps CLI 入门

az devops extension show --extension-name
                         --publisher-name
                         [--org]

参数 - 列出扩展信息

  • extension-name:扩展的名称。
  • publisher-name:扩展发布者的名称。
  • org:Azure DevOps 组织 URL。 可以使用az devops configure -d organization=ORG_URL配置默认组织。 如果未配置为默认或使用 选取 git config,则为必需。 示例:--org https://dev.azure.com/MyOrganizationName/

示例 - 列出扩展信息

以下命令以表格式显示有关 Timetracker 扩展的信息。

az devops extension show --extension-name Timetracker --publisher-name 7pace --output table

Publisher Id    Extension Id    Name         Version      Last Updated     States
--------------  --------------  -----------  -----------  ---------------  --------
7pace           Timetracker     Timetracker  5.0.1.34507  2019-11-13       disabled

排查扩展安装问题

若要解决常见问题,请按照以下故障排除步骤作:

  • 扩展安装失败:

    • 检查权限: 若要安装扩展,请确保你是项目集合管理员,或者具有管理员授予的必要权限。
    • 验证扩展兼容性: 确保该扩展与 Azure DevOps 版本兼容。 检查扩展的详细信息页以了解兼容性信息。
    • 网络问题: 验证网络连接是否稳定,并且没有防火墙或代理设置阻止安装过程。
  • 扩展崩溃或导致错误:

    • 收集诊断信息: 如果扩展崩溃或导致错误,请收集诊断信息以帮助识别问题。 此信息包括问题的错误消息、日志和屏幕截图。
    • 检查扩展日志: 某些扩展提供可帮助诊断问题的日志。 请查看扩展的文档,了解有关如何访问和解释这些日志的信息。
    • 联系支持人员:如果无法解决问题,请与扩展的支持团队联系并告知收集的诊断信息。 尽可能多地提供详细信息,帮助他们解决问题。
  • 安装后无法看到扩展:

    • 刷新页面: 有时,扩展可能不会在安装后立即显示。
    • 检查权限: 确保你具有查看和使用扩展所需的权限。 某些扩展可能需要特定权限才能显示。
    • 重新安装该扩展: 如果扩展仍然不可见,请尝试卸载并重新安装它。

常见问题 (FAQ)

问:为什么在“Marketplace 安装页面”中看不到我的组织?

答:如果在从 Azure DevOps 市场购买时看不到您的组织,请尝试以下步骤:

  1. 检查用于登录 Visual Studio 市场的身份。 在右上角,选择用户名以查看个人资料。
  2. 确保电子邮件地址和目录正确。
  3. 关闭所有浏览器窗口。
  4. 打开专用或隐身浏览会话。
  5. 登录到 Visual Studio Marketplace。 使用想要的组织内用户的身份。

提示

Azure DevOps 可能会要求你在“工作或学校帐户”或“个人帐户”之间进行选择。如果是这样,则你使用了一个电子邮件地址,该电子邮件地址与 Microsoft 帐户和组织在 Microsoft Entra ID 中管理的“工作或学校帐户”相同。 尽管这些标识具有相同的电子邮件地址,但它们仍然是具有不同配置文件、安全设置和权限的单独标识。 选择要选择的组织中的用户的标识。

问:为什么无法安装扩展?

答:由于以下原因之一,无法安装扩展。

问:为什么用户无法访问扩展功能?

答:由于以下原因之一,用户无法访问扩展。

  • 大多数扩展要求用户至少具有基本访问权限,而不是干系人权限。 例如,可以安装免费的 代码搜索扩展,但每个用户必须至少具有基本访问权限才能搜索代码。 为了帮助团队提高应用质量,可以安装免费的 测试和反馈扩展。 根据您的访问级别以及您是以脱机方式工作还是连接到 Azure DevOps Services 或本地 Azure DevOps Server,您将体验到不同的功能。 有关详细信息,请参阅 Visual Studio Marketplace Azure DevOps 选项卡中的扩展说明

  • 如果你使用的是组织账户,并且启动了免费扩展试用版,则你的试用版可能已过期。 检查试用版是否已过期。

    1. 在组织工具栏上,选择“ 用户”。
    2. 转到扩展窗格。
    3. 检查是否有过期信息,以确定扩展是否过期或何时过期。
  • 如果您使用的是您所在的组织,并为此扩展付费,请确保已为用户分配此扩展。

    1. 在组织工具栏上,转到 “用户”。
    2. 转到扩展窗格。
    3. 检查扩展是否分配给用户。 如果不是,请将扩展分配给用户。

有关详细信息,请参阅 向用户分配扩展。

问:我的预览扩展怎么了?

答:您的扩展可能已经不是预览版了。 预览期过后,延长扩展通常作为付费扩展提供。 在必须购买扩展之前,可能会有一个宽限期。 在购买该扩展之前,所有预览版扩展会自动转换为 免费试用版

问:为什么无法为 Azure DevOps Server 安装扩展?

答:由于以下原因之一,无法为 Azure DevOps Server 安装扩展:

  • 项目集合管理员组的成员,或者在要安装扩展的项目集合中,将编辑集合级别信息权限设置为允许。 如果没有权限,您可以 请求扩展
  • 你可能会收到一个错误,指出你已安装或请求了扩展。 如果是这样,请与项目集合管理员组的成员联系,并要求他们为你分配扩展。 有关详细信息,请参阅 请求增加权限级别

问:为什么看不到我想要的项目集合(本地)?

答:先成为项目集合的成员。 按照以下步骤检查您用于登录市场的身份信息。

  1. 在 Azure DevOps Server Web 门户主页(https://{server}:8080/tfs/)上,转到页面右上角,然后选择用户名以查看个人资料。
  2. 在您的个人资料左侧,请确认您的电子邮件地址和目录是否正确。
  3. 关闭所有浏览器窗口。
  4. 打开专用或隐身浏览会话。
  5. 使用要在其中安装扩展的项目集合中的用户的标识登录到 Azure DevOps Server 主页(https://{server}:8080/tfs/)。
    Azure DevOps 可能会提示你选择“工作或学校账户”或“个人账户”。这条消息表示你在 Microsoft Entra ID 中使用了相同的电子邮件地址,该地址既用于 Microsoft 帐户,又用于由组织管理的“工作或学校帐户”。 尽管这些标识具有相同的电子邮件地址,但它们仍然是具有不同配置文件、安全设置和权限的单独标识。 选择项目集合中的用户身份。
  6. 从你的项目集合进入市场。

问:为什么我想要的扩展在本地不显示下载按钮?

答:某些扩展仅适用于 Azure DevOps Services,原因如下:

  • 该扩展使用尚未针对 Azure DevOps Server 发布的 Azure DevOps 功能。
  • 扩展 清单 指示该扩展仅适用于 Azure DevOps Services(目标 = Microsoft.Visualstudio.Services.Cloud)。
  • 扩展清单指示扩展是一个集成(targets = Microsoft.Visualstudio.Services.Integration)。

问:为什么无法将扩展上传到 Azure DevOps Server?

答:是 Team Foundation 管理员组的成员。 对于你想要上传扩展的 Azure DevOps Server,你还必须拥有编辑实例级别信息权限

后续步骤