命名对象的限制和约定 - Azure DevOps

一般注意事项

本文中的长度限制由允许的 Unicode 字符数来衡量。代理项字符由两个 Unicode 字符组成，根据长度限制，这两个字符计为两个字符。有关详细信息，请参阅关于 Unicode 和字符集。

与其他操作系统文件一样，还禁止 ASCII 控制字符 (ASCII 1-31) 和代理项的组合形式。有关应用于文件名的操作系统限制的一般信息，请参阅命名文件、路径和命名空间。

系统保留名称

避免使用系统保留名称，如以下示例所示：

COM1、COM2、COM3、COM4、COM5、COM6、COM7、COM8、COM9、COM10

DefaultCollection

LPT1、LPT2、LPT3、LPT4、LPT5、LPT6、LPT7、LPT8、LPT9

SERVER、SignalR

Web 或 WEB

有关保留名称的详细信息，请参阅文件名、路径和命名空间。

Azure Artifacts

通用包必须符合以下限制。

使用工作项捕获信息来规划和跟踪软件开发项目。借助工作项，你可以描述要完成的工作、分配工作、跟踪状态以及协调团队内的工作量。不同类型的工作项（如用户情景、任务、bug 和问题）跟踪不同类型的信息。有关详细信息，请参阅 Azure Boards文档。

所有工作项跟踪对象都与一个或多个名称相关联。大多数都有友好的显示名称，工作项类型和全局列表除外，它们与引用名称相关联。友好名称是字段的唯一的、用户可见的标识符。使用友好名称可确保项目集合中项目和工作项类型之间的一致性。系统在内部使用引用名称，定义后无法对其进行更改。

与工作项关联的多个元素存在限制，包括引用和友好名称、字段名称和附件大小。

区域和迭代路径

两个工作项字段 （“区域路径” 和“ 迭代路径” ）提供用于对工作进行分组的树结构层次结构。区域路径按产品、功能或功能区域对工作项进行分组。迭代路径将工作项分组为冲刺、里程碑或时间段，用于处理这些工作项。

这些多节点字段使用反斜杠 \ 字符来表示树结构中节点的层次结构。

分配给这些字段的子节点的名称必须符合以下限制。

- 不得仅包含一个或两个

句点

..

。
- 不得为系统保留名称，例如 PRN、COM1、COM2、COM3、COM4、COM5、COM6、COM7、COM8、COM9、COM10、LPT1、LPT2、LPT3、LPT4、LPT5、LPT6、LPT7、LPT8、LPT9、NUL、CON 或 AUX。有关保留名称的详细信息，请参阅文件名、路径和命名空间。节点的特殊字符 - 不得包含 Unicode 控制字符。
- 不得包含以下任何一个字符：


   \ / : * ? " < > | ; # $ * { } , + = [ ]

。
- 不得包含本地文件系统禁止的字符。有关 Windows 字符限制的详细信息，请参阅命名文件、路径和命名空间。不能包含超过 4，000 个 Unicode 字符。路径层次深度深度必须少于 14 层。

板栏和泳道名称

看板将积压工作转换为交互式招牌，提供可视工作流。随着工作从创意阶段进行到完成，你将更新面板上的项。每一列代表一个工作阶段，每张卡片代表该工作阶段的一个用户故事（蓝色卡片）或 bug（红色卡片）。

通过添加、删除或重命名列和泳道来自定义看板。列支持全面工作流。泳道允许将不同类别的工作作为棋盘上的水平车道进行管理。

列和泳道名称必须符合以下限制。

每个工作项类型包含一个或多个工作项字段。这些字段根据工作项类型定义为工作项存储的信息。每个工作项字段都有一个关联的字段引用名称。字段引用名称唯一标识每个字段，在分配字段后无法更改。有关现成的工作项字段的详细信息，请参阅工作项字段索引。

工作项字段名称必须符合以下限制。

- 字段名称必须至少包含一个字母字符。
- 不得包含以下任何一个字符：


   .,;':~\/\*|?"&%$!+=()[]{}<>-

。
- 不得包含前导空格或尾随空格。
- 不得包含两个或更多连续空格。在组织或项目集合中必须是唯一的。工作项字段名称的范围限定为项目集合。如果重命名字段名称，请更改集合中所有项目中定义的所有工作项和 WIT 的字段名称。

字段引用名称和可移植性

工作项类型定义语言包括 字段引用名称 的概念。字段引用名称有助于在 Team Foundation 项目集合之间移植定义，并允许第三方集成查找和引用特定字段。这些名称是全局唯一的，正如 .NET Framework 应用程序中的命名空间是全局唯一的一样。

System 命名空间仅用于定义 Team Foundation 系统函数必需的所有核心系统字段。无法创建自己的 System.X 字段，因为它可能会妨碍功能。

Microsoft 命名空间用于定义工作项跟踪字段。这些字段在流程模板的工作项类型定义中定义。

客户和合作伙伴可以为自定义工作项类型创建自己的字段命名空间。有关系统字段和默认流程模板中定义的字段的说明，请参阅工作项字段的索引。

无法重命名字段引用名称。例如，如果将字段名称“Title”更改为“Header”，则该字段的字段引用名称保持不变。字段的集成和内部表示形式应使用字段引用名称，而不是取决于字段名称本身。

虽然你可以创建自己的 Microsoft.X 字段，但我们不建议这样做，因为这可能会影响功能或配置功能向导在升级后成功更新项目的能力。

字段引用名称的示例

下面的示例演示各个命名空间中有效的字段引用名称。客户和合作伙伴也可以定义自己的命名空间，以支持他们的自定义工作项类型。

系统命名空间示例 Microsoft 命名空间示例其他命名空间示例 System.Id、System.Title、System.CreatedBy、System.CreatedDate、System.ChangedBy、System.ChangedDate、System.State、System.Reason Microsoft.VSTS.Build.FoundIn、Microsoft.VSTS.Common.Activity、Microsoft.VSTS.Common.Discipline、Microsoft.VSTS.Common.Priority、Microsoft.VSTS.CMMI.TaskType、Microsoft.VSTS.TCM.AutomationStatus、Microsoft.VSTS.TCM.TestSuiteType 虚构公司 Fabrikam Fiber 可能会定义以下自定义工作项字段：
FabrikamFiber.Common.Severity、FabrikamFiber.Common.Phase、FabrikamFiber.RiskManagement.RiskType、FabrikamFiber.RiskManagement.Resolution

虚构软件公司 Contoso Corporation 可能会定义以下工作项字段：
Contoso.Common.BusinessPriority、Contoso.Bug.FoundInPhase、Contoso.Bug.FixInPhase

字段帮助文本

系统会在运行时显示帮助文本，以帮助用户知道要输入到字段中的内容。帮助文本的范围限定为特定项目中的特定工作项类型。

对于继承过程，可以通过 “编辑 字段”对话框、“ 定义 ”选项卡、“ 说明 ”为字段指定帮助文本。请参阅将自定义字段添加到工作项类型。对于本地 XML 进程，可以使用元素指定帮助文本 HELPTEXT 。请参阅添加或修改字段以跟踪工作。

添加的帮助文本必须符合以下限制。

全局列表是一组列表项值，可跨本地Azure DevOps Server实例中的所有项目集合全局使用这些值。定义工作项类型时，可能会发现某些工作项字段共享相同的允许值或建议值集。全局列表使你能够一次性定义这些值，并跨多个工作项类型和项目共享这些值。有关详细信息，请参阅定义全局列表。

使用 GLOBALLIST 元素定义的全局列表包含一个或多个使用 LISTITEM 元素指定的列表项。

LISTITEM 名称必须符合以下限制。

- 不得与项目集合中的任何其他字段引用名称相同。
- 计算机处理这些名称以将所有句点

替换为下划线

后，不得与任何其他字段引用名称相同。例如，字段引用名称


   My.*Field*

和


   My.Field

都将作为同一名称进行处理：


   My__Field

- 不得包含连字符

。
- 必须至少包含一个句点

。
- 不得以句点

开头或结尾。
- 不得以数字开头不得以下划线

开头。

工作项标记

工作项标记对应于一两个关键字 (keyword) 短语，用于筛选工作跟踪工具（如积压工作、板和查询）或定义查询。有关详细信息，请参阅添加工作项标记以对列表和板进行分类和筛选。

标记名称必须符合以下限制。

有关详细信息，请参阅 Azure Pipelines 文档。

Azure Repos (Git)

每个 Azure DevOps 项目可以包含多个 Git 存储库。分配给 Git 存储库的名称必须符合以下限制。若要了解详细信息，请参阅 Azure Repos Git 文档。有关其他 Git 项（如分支和标记）的命名限制的详细信息，请参阅 git 检查-ref-format 。

尽管可以在存储库名称中包含空格，但我们不建议这样做。

Azure Repos (TFVC)

Team Foundation 版本控制 (TFVC) 为文件和跨团队管理这些文件所需的命令提供中央存储库。还提供可自定义的签入策略、分支、合并、搁置以及许多其他功能。若要了解详细信息，请参阅 Azure Repos TFVC 文档

版本控制路径必须符合以下限制。另请参阅优化工作区。

服务器源代码管理文件夹路径长度 - 单个文件夹或文件名的 Unicode 字符不能超过 259 个。
- 一个目录的 Unicode 字符不能超过 388 个。
- 对于组合的目录和文件名，不能包含超过 399 个 Unicode 字符。本地文件夹的路径长度 - 一个目录不能包含超过 248 个 Unicode 字符。
- 对于组合的目录和文件名，不能包含超过 260 个 Unicode 字符。 Web 门户和特定于 REST 的长度限制对于组合的项目名称、目录和文件名，不能包含超过 215 个 Unicode 字符。

在 Web 门户和 REST API 中，某些操作的路径长度比 Visual Studio 和 TF.exe 客户端更严格。这些操作包括“编辑”、“重命名”和“删除”，因为 Web 门户/REST 在等待更改时使用随机生成的工作区进行并发。

TFVC 文件

版本控制系统存储许多不同类型的文件。在开发计算机上设置 Team Foundation 版本控制提供了有关如何添加现有 Visual Studio 项目或解决方案的详细信息。

添加到 Team Foundation 版本控制的文件和文件夹必须符合以下限制。

TFVC 货架集

通过使用搁置集，你可以暂时保留一批挂起的更改，并可以选择在以后从你的工作区移除这些挂起的更改。你可以在以后将搁置集中的更改还原到你的工作区中或将这些更改放入其他用户的工作区。

搁置集名称必须符合以下限制。

TFVC 工作区

工作区是 Team Foundation 版本控制中的文件和文件夹的客户端副本， (TFVC) 。创建多个工作区时，客户端计算机上可以有同一版本控制文件夹的不同版本。创建和使用工作区提供了更多详细信息。

工作区名称必须符合以下限制。

项目集合标识一组项目以及与这些项目关联的资源。它提供了一个组织结构，可用于定义和控制为Azure DevOps Server定义的一组项目。

此外，集合名称是用于将团队成员连接到项目的连接字符串的一部分。分配的默认对应于 DefaultCollection 。管理项目集合提供了详细信息。

分配给项目集合的名称必须符合以下限制。

- 不得与本地部署中的其他任何集合名称相同。
- 如果部署包含 SharePoint 产品或SQL Server Reporting Services，则它们不能与现有 SharePoint 网站、报表服务器或Reporting Services网站的名称和完整路径相同。不得为系统保留名称。 - 不得包含任何 Unicode 控制字符或代理字符。
- 不得包含以下可打印字符：


   \ / : * ? " < > | ; # $ * { } , + = [ ]

。
- 不得包含省略号

...

或双句点

..

。
- 不得以下划线

开头。
- 不得以句点

开头或结尾。
- 不得是系统保留名称。
- 不得是用于 IIS 请求筛选的隐藏段之一，例如App_Browsers、App_code、App_Data、App_GlobalResources、App_LocalResources、App_Themes、App_WebResources、bin 或web.config。 - 不得包含任何 Unicode 控制字符或代理字符。
- 不得包含以下可打印字符：


   \ / : * ? " < > | ; # $ * { } , + = [ ]

。
- 不得以下划线

开头。
- 不得以句点

开头或结尾。

使用 Azure DevOps 安全组，可以将某些权限或权限应用于一组用户。

本地组可能包含 Active Directory 组帐户、Azure DevOps 安全组、Windows 用户帐户、Windows 组帐户或这些类型的任意混合。有关详细信息，请参阅将 AD/Azure AD 用户或组添加到内置安全组。

安全组必须符合以下限制。

Team Foundation Build

Team Foundation Build 允许你在一台计算机上管理生成过程的所有方面。通过使用 Team Foundation Build，可以同步源、编译应用程序、运行关联的单元测试、执行代码分析、在文件服务器上发布生成，以及发布生成报告。

生成计算机

Team Foundation Build 是独立于 Azure DevOps Server 应用层、数据层或 Visual Studio 客户端的安装。可以选择单独的计算机。否则，可以在客户端计算机或服务器上并行安装生成。

本地生成计算机必须符合以下限制。

放置位置权限每个生成的版本都放在放置文件夹中的新目录中。
- Team Foundation Server 服务帐户 (例如，


   Domain\TFSSERVICE

) 必须具有对 UNC 放置位置的完全控制权限访问权限。
- UNC 放置位置必须是共享文件夹。 Team Foundation 生成服务帐户如果在初始安装后更改 TFS 服务帐户，必须确保满足以下条件：
- 帐户是生成服务组的成员。
- 帐户对临时文件夹和 ASP.NET 临时文件夹具有读/写权限。
- 帐户对生成目录和放置位置具有“完全控制”权限。防火墙问题如果生成计算机已启用防火墙，请确保程序 tfsbuildservice 位于例外列表中。

生成类型配置生成项目中单个解决方案或一组解决方案的条件。若要执行生成，必须创建新的生成类型或使用现有的生成类型。

生成类型名称必须符合以下限制。

生成质量允许向完成的生成附加质量级别或完成状态。 Team Foundation Build 还允许为生成质量类型创建新值。有关默认生成质量值的列表，请参阅对已完成生成的质量进行评分。

生成质量名称必须符合以下限制。

团队名称标识在项目中作为团队共同协作的一组个人或组。团队成员使用此名称连接到团队或针对为团队定义的成员进行查询。

团队名称必须符合允许它们作为有效 URL 的一部分呈现的约定。每个团队名称在单个项目中必须是唯一的。但是，在项目集合中的不同项目中使用相同的团队名称没有任何限制。有关详细信息，请参阅添加另一个团队或团队层次结构。

团队名称必须符合以下限制。

用户帐户名称

用户帐户标识添加到项目或项目集合的人员。用户帐户可能对应于 Active Directory、Azure Active Directory、Windows 服务器组中的条目。

添加到组织或集合的用户帐户必须符合以下限制。若要向项目添加用户帐户，请参阅将用户添加到项目或团队。

- 不得包含任何 Unicode 控制字符或代理字符。
- 不得包含以下可打印字符：


   / \ : < > * ? | - #

。
- 不得以句点

开头或结尾。
- 脱机添加的页面的标题不得包含空格。不得超过最大 18 MB。附件文件大小不得超过最大 19 MB。