名前付けの制限と規則

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

Azure DevOps のほとんどのコンポーネントは、名前付けの制限と規則に従う必要があります。 制限は、一貫性のあるユーザー エクスペリエンスを保証し、他のアプリケーションとの互換性を提供するのに役立ちます。

一般的な制限には、名前の文字長を超えない、特殊文字を含まない、オブジェクト セット内の名前の一意性の維持などがあります。

重要

ユーザー インターフェイス (UI) ではなく API を使用する場合、API では、UI で制限される可能性がある文字を含む名前を直接指定できます。

ベスト プラクティス:

• UI の制限に従って一貫性を維持し、意図しない問題を防ぎます。
• プログラムで名前を検証し、特殊文字を適切に処理します。

一般的な考慮事項

この記事の長さの制限は、許可されている Unicode 文字の数によって測定されます。 サロゲート文字は、長さの制限に対して 2 文字としてカウントされる 2 つの Unicode 文字で構成されます。 詳細については、「 Unicode および文字セットについてを参照してください。

他のオペレーティング システム ファイルと同様に、ASCII 制御文字 (ASCII 1 から 31) とサロゲートの組み合わせも使用できません。 ファイル名に適用されるオペレーティング システムの制限に関する一般的な情報については、「 ファイル、パス、名前空間の名前付けを参照してください。

Note

• 定義できる項目数の制限については、「 作業の追跡、プロセス、およびプロジェクトの制限」を参照してください。

システム予約名

次の例のように、システム予約名を使用しないでください。

• AUX
• COM1、COM2、COM3、COM4、COM5、COM6、COM7、COM8、COM9、COM10
• CON
• DefaultCollection
• LPT1、LPT2、LPT3、LPT4、LPT5、LPT6、LPT7、LPT8、LPT9
• NUL
• PRN
• SERVER、SignalR
• Web または WEB

予約名の詳細については、「 File の名前、パス、および名前空間を参照してください。

Azure Artifacts

ユニバーサル パッケージは、次の制限に準拠している必要があります。

制限の種類	Restriction
パッケージ名	- 小文字にする必要があります。 - 文字または数字で始まり、終わる必要があります。 - 文字、数字、および非連続ダッシュ、アンダースコア、またはピリオドのみを含める必要があります。
パッケージのバージョン	ビルド メタデータなしでは小文字にする必要があります。

Azure Boards

作業項目を使用して情報をキャプチャし、ソフトウェア開発プロジェクトを計画および追跡します。 作業項目を使用すると、実行する作業の説明、作業の割り当て、状態の追跡、チーム内の作業の調整を行うことができます。 ユーザー ストーリー、タスク、バグ、問題など、さまざまな種類の作業項目によって、さまざまな種類の情報が追跡されます。 詳細については、 Azure Boards のドキュメントを参照してください。

すべての作業項目追跡オブジェクトは、1 つ以上の名前に関連付けられます。 作業項目の種類と、参照名に関連付けられているグローバル リストを除き、ほとんどのユーザーにはわかりやすい表示名があります。 フレンドリ名は、フィールドの一意のユーザーに表示される識別子です。 フレンドリ名を使用すると、プロジェクト コレクション内のプロジェクトと作業項目の種類間で一貫性が確保されます。 システムは内部的に参照名を使用し、一度定義した参照名を変更することはできません。

参照名、フレンドリ名、フィールド名、添付ファイル サイズなど、作業項目に関連付けられている複数の要素には制限があります。

区分パスとイテレーション パス

作業項目フィールド Area Path と Iteration Path の 2 つの作業項目フィールドは、作業をグループ化するためのツリー構造階層を提供します。 エリア パスは、製品、機能、または機能領域ごとに作業項目をグループ化します。 イテレーション パスは、作業項目をスプリント、マイルストーン、または期間にグループ化して、それらの作業項目に対処します。

これらのマルチノード フィールドでは、円記号 \ 文字を使用して、ツリー構造内のノードの階層を示します。

これらのフィールドに子ノードに割り当てる名前は、次の制限に準拠している必要があります。

制限の種類	Restriction
ノード名の長さ	255 文字を超えてはなりません。
予約済みの名前	- 1 つまたは 2 つの期間...のみで構成することはできません。 - 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 レベル未満である必要があります。

Attachments

作業項目に添付されたファイルは、次の制限に準拠している必要があります。

制限の種類	Restriction
ファイル サイズ	最大サイズを超えてはなりません。 - 既定の最大サイズ: 4,096 KB。 - 絶対最大サイズ: 2 ギガバイト。

ボード列とスイムレーン名

ボードはバックログを対話型の看板に変換し、視覚的な作業フローを提供します。 作業が構想から完了まで進むにつれて、ボード上の項目を更新します。 各列は作業段階を示し、各カードはその作業段階のユーザーのストーリー (青いカード) またはバグ (赤いカード) を表します。

columns、swimlanesを追加、削除、または名前変更して、ボードをカスタマイズします。 列は、ボード全体の作業フローをサポートします。 スイムレーンを使用すると、ボード上の水平レーンとしてさまざまなクラスの作業を管理できます。

列名とスイムレーン名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	256 文字を超える Unicode 文字を含めてはなりません。
一意性	- 列名は、ボード上の他の列名と同じにすることはできません。 - スイムレーン名は、ボード上の他のスイムレーン名と同じにすることはできません。
特殊文字	Unicode 制御文字またはサロゲート文字を含めてはなりません。

フィールド名

各作業項目の種類には、1 つ以上の作業項目フィールドが含まれています。 これらのフィールドは、作業項目の種類に基づいて作業項目に格納される情報を定義します。 各作業項目フィールドには、フィールド参照名が関連付けられています。 フィールド参照名は各フィールドを一意に識別し、割り当てられた後は変更できません。 既定の作業項目フィールドの詳細については、「 作業項目フィールドのインデックスを参照してください。

作業項目フィールド名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	128 文字を超える Unicode 文字を含めてはなりません。
一意性	- フィールド名には、少なくとも 1 つの英字が含まれている必要があります。 - 次のいずれかの文字を含めてはなりません: . , ; ' : ~ \ / \ * ? " & % $ ! + = () [] {} <> - |。 - 先頭または末尾のスペースを含めることはできません。 - 連続するスペースを 2 つ以上含めることはできません。
特殊文字	組織内またはプロジェクト コレクション内で一意である必要があります。 作業項目フィールド名のスコープはプロジェクト コレクションです。 フィールド名の名前を変更すると、コレクション内のすべてのプロジェクト内で定義されているすべての作業項目と WIT に対してフィールド名を変更します。

フィールド参照名と移植性

作業項目タイプ定義言語には、 フィールド参照名の概念が含まれます。 フィールド参照名は、Team Foundation プロジェクト コレクション間で定義を移植したり、Microsoft 以外の統合で特定のフィールドを検索して参照したりするのに役立ちます。 .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

作業項目のタグ

作業項目タグは、バックログ、ボード、クエリなどの作業追跡ツールをフィルター処理したり、クエリを定義したりするための 1 つまたは 2 つのキーワード フレーズに対応します。 詳細については、「 作業項目タグを追加してリストとボードを分類およびフィルター処理するを参照してください。

タグ名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	- 400 文字を超える Unicode 文字を含めてはなりません。 - null または空にすることはできません。
特殊文字	- 区切り文字 ( , または ;) を含めてはなりません。 - Unicode コントロールまたは書式文字 (改行、段落区切り、復帰、その他の不一致のサロゲート文字など) を含めてはなりません。
範囲	グローバル リストはすべてのプロジェクトで使用できるため、プロジェクト固有のグループ アカウント定義など、プロジェクト レベルで定義された要素を含めてはなりません。

Azure Pipelines

Azure Pipeline の定義は、次の制限に準拠している必要があります。

制限の種類	Restriction
ジョブ名	- 英数字と '_'のみを含める必要があります。 - 数値で始めてはなりません。 - 一意の名前が必要です。 - キーワード ("deployment" など) を含めてはなりません。
ステージ名	- 英数字と '_'のみを含める必要があります。 - 数値で始めてはなりません。 - キーワード ("deployment" など) を含めてはなりません。
式	a-Zまたは_ANDで始まり、その後にa-Z、0-9、または_が続く必要があります。

詳細については、「Azure Pipelines のドキュメント」を参照してください。

Azure Repos (Git)

各 Azure DevOps プロジェクトには、複数の Git リポジトリを含めることができます。 Git リポジトリに割り当てる名前は、次の制限に準拠している必要があります。 詳細については、 Azure Repos Git のドキュメントを参照してください。 ブランチやタグなどの他の Git 項目の名前付け制限の詳細については、「 git check-ref-formatを参照してください。

重要

リポジトリ名にはスペースを含めることができますが、そうすることはお勧めしません。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
一意性	プロジェクト内の他の Git リポジトリ名と同じにすることはできません。
特殊文字	- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 印刷可能な文字 \ / : * ? " < > ; # $ * { } , + = [ ] |を含めてはなりません。 - アンダースコア _で始めてはなりません。 - ピリオド .で開始または終了することはできません。 - システム予約名にすることはできません。

Azure Repos (TFVC)

Team Foundation バージョン管理 (TFVC) は、ファイルの中央リポジトリと、チーム全体でこれらのファイルを管理するために必要なコマンドを提供します。 また、カスタマイズ可能なチェックイン ポリシー、分岐、マージ、棚付け、およびその他の多くの機能も提供します。 詳細については、 Azure Repos TFVC のドキュメントを参照してください。

バージョン管理パスは、次の制限に従う必要があります。 ワークスペースの最適化 も参照してください。

制限の種類	Restriction
サーバー ソース管理フォルダーのパスの長さ	- 1 つのフォルダーまたはファイル名に 259 文字を超える Unicode 文字を含めてはなりません。 - ディレクトリに 388 文字を超える Unicode 文字を含めてはなりません。 - ディレクトリとファイル名を組み合わせた場合、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 のバージョン管理に追加するファイルとフォルダーは、次の制限に従う必要があります。

制限の種類	Restriction
ファイルとフォルダー	- 名前には、印刷可能な文字 ( \ / : * ? " < > ;) を含めてはなりません。 - フォルダーは、アクティブなワークスペースのマップされたディレクトリの外部にすることはできません。
ファイル名	- $で始めてはなりません。 - 印刷可能な文字 \ / : * ? " < > ; |を含めてはなりません。

TFVC ラベル

Team Foundation バージョン 管理 (TFVC) では、ラベルは特定のリビジョン セットに適用される名前です。 バージョン コントロール内の関連のない一連のファイルにラベルを添付できます。これにより、ファイルを取得したり、グループとして操作したりできます。 次の表では、ラベル名に適用される制限について説明します。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
特殊文字	- スペース ( ) またはピリオド .で終わることはありません。 - 印刷可能な文字 \ / : * ? " < > ; @ |を含めてはなりません。

TFVC シェルブセット

シェルブセットを使用すると、保留中の変更のバッチを一時的に確保し、オプションとして、ワークスペースから保留中の変更を削除できます。 後で、シェルブセット内の変更をワークスペースに復元したり、別のユーザーのワークスペースに配置したりできます。

シェルブセット名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
特殊文字	印刷可能な文字 \ / : * ? " < > & ; |を含めてはなりません。

TFVC ワークスペース

ワークスペースは、Team Foundation バージョン 管理 (TFVC) のファイルとフォルダーのクライアント側コピーです。 複数のワークスペースを作成する場合、クライアント コンピューター上の同じバージョン管理フォルダーの異なるバージョンを持つことができます。 ワークスペースの作成と操作 詳細を提供します。

ワークスペース名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
特殊文字	- スペース ( )で終わる必要があります。 - 印刷可能な文字 \ / : * ? " < > ; |を含めてはなりません。

組織の名前

重要

組織名を作成するときは、次のガイドラインに従います。

• 英語のアルファベットの文字のみを使用する
• 組織名を文字または数字で始める
• 最初の文字の後に文字、数字、またはハイフンを使用する
• 組織が 50 Unicode 文字を超えないようにする
• 文字または数字で終わる

許可されていない文字のいずれかを使用すると、次のエラー メッセージが表示されます: VS850015: 指定した名前は使用できません: {組織名}。

プロセス テンプレートとプロセス テンプレート

プロセスは、プロジェクトに接続した後にアクセスできる作業項目追跡システムおよびその他のサブシステムの構成要素を定義します。

Note

用語: "プロセス" と "プロセス テンプレート" の両方は、プロジェクトの作成に使用される相互に依存するファイルのセットを指します。 詳細については、「 プロセスとプロセス テンプレートに関するページを参照してください。このテンプレートでは、使用可能な 3 つの既定のプロセスの違いについて説明します。

定義またはカスタマイズするプロセスは、次の制限に準拠している必要があります。

制限の種類	Restriction
長さ	256 文字を超える Unicode 文字を含めてはなりません。
一意性	- Azure DevOps 全体で一意である必要があります。 - 既存のテンプレートと同じ名前のテンプレートをアップロードすると、既存のテンプレートが上書きされます。
プロセス テンプレート ファイルのサイズ	2 GB (ギガバイト) を超えてはなりません。

プロジェクト名

プロジェクトでは、ソース コード用のリポジトリと、チームが進捗状況を計画、追跡、共同作業するための場所を確立します。 プロジェクトの名前は、チーム メンバーをプロジェクトに接続するために使用される接続文字列の一部です。

作成するプロジェクトに割り当てる名前は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
一意性	プロジェクト コレクション内の他の名前、コレクションをサポートする SharePoint Web アプリケーション、またはコレクションをサポートする SQL Server Reporting Services のインスタンスと同じにすることはできません。
名前を予約します	- システム予約名にすることはできません。 - App_Browsers、App_code、App_Data、App_GlobalResources、App_LocalResources、App_Themes、App_WebResources、bin、web.config などの IIS 要求のフィルター処理に使用される非表示セグメントの 1 つでなければなりません。
特殊文字	- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 印刷可能な文字 \ / : * ? " < > ; # $ * { } , + = [ ] |を含めてはなりません。 - アンダースコア _で始めてはなりません。 - ピリオド .で開始または終了することはできません。

セキュリティ グループ

Azure DevOps セキュリティ グループを使用すると、特定の権限またはアクセス許可をユーザーのグループに適用できます。

オンプレミス グループは、Active Directory グループ アカウント、Azure DevOps セキュリティ グループ、Windows ユーザー アカウント、Windows グループ アカウント、またはこれらの種類の組み合わせで構成される場合があります。 詳細については、「 Active Directory/Microsoft Entra ユーザーまたはグループを組み込みのセキュリティ グループに追加するを参照してください。

セキュリティ グループは、次の制限に準拠している必要があります。

制限の種類	Restriction
セキュリティ グループ アカウント名の長さ	256 文字を超える Unicode 文字を含めてはなりません。
一意性	- プロジェクト レベルのグループ アカウントは、同じプロジェクト内の他のグループ名と一致してはなりません。 - コレクション レベルのグループ アカウントは、プロジェクト コレクション内のグループ アカウントの他の名前と一致してはなりません。
予約済みグループ名	プロジェクトレベルまたはサーバー レベルで$NAMESPACEで名前を付けてはなりません。
特殊文字	- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 印刷可能な文字 / \ [ ] : < > + = ; ? * |を含めてはなりません。 - ASCII 値の 1 から 31 の範囲に印刷できない文字を含めてはなりません。 - 期間 .で終わる必要があります。 - コンマ ,を含めてはなりません。

チーム名

チーム名は、プロジェクト内のチームとしてまとめて連携する個人またはグループのグループを識別します。 チーム メンバーは、この名前を使用してチームに接続するか、チームに対して定義されたメンバーに対してクエリを実行します。

チーム名は、有効な URL の一部としてレンダリングできる規則に準拠している必要があります。 各チーム名は、1 つのプロジェクト内で一意である必要があります。 ただし、プロジェクト コレクション内の異なるプロジェクトで同じチーム名を使用しても制限はありません。 詳細については、「 別のチームまたはチームの階層を追加するを参照してください。

チーム名は、次の制限に従う必要があります。

制限の種類	Restriction
長さ	64 文字を超える Unicode 文字を含めてはなりません。
一意性	プロジェクト内の他の名前と同じにすることはできません。
予約済みの名前	システム予約名にすることはできません。
特殊文字	- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 印刷可能な文字 \ / : * ? " < > ; # $ * { } , + = [ ] |を含めてはなりません。 - 省略記号 ... または二重ピリオド ..を含めてはなりません。 - アンダースコア _で始めてはなりません。 - ピリオド .で開始または終了することはできません。

ユーザー アカウント名

ユーザー アカウントは、プロジェクトまたはプロジェクト コレクションに追加されたユーザーを識別します。 ユーザー アカウントは、Active Directory、Microsoft Entra ID、Windows サーバー グループ内のエントリに対応している場合があります。

組織またはコレクションに追加するユーザー アカウントは、次の制限に準拠している必要があります。 ユーザー アカウントをプロジェクトに追加するには、「 プロジェクトまたはチームにユーザーを追加する」を参照してください。

制限の種類	Restriction
アカウント名の長さ	256 文字を超える Unicode 文字を含めてはなりません。
一意性	プロジェクト コレクションに追加された他のユーザー アカウントと一致してはなりません。
予約済みグループ名	プロジェクトレベルまたはサーバー レベルで $NAMESPACE で名前を付けてはなりません。
特殊文字	- 印刷可能な文字を含めてはなりません: "/ \ [ ] : < > + = ; ? * |. - ASCII 値の 1 から 31 の範囲に印刷できない文字を含めてはなりません。 - 期間 . またはドル記号 $で終わる必要があります。 - コンマ ,を含めてはなりません。 - LineSeparator、ParagraphSeparator、Control、Format、OtherNotAssigned の Unicode カテゴリを含めることはできません。

Wiki ページとファイル名

各 Wiki ページは、Wiki Git リポジトリ内のファイルに対応しています。 Wiki ページのタイトルに割り当てる名前は、次の制限に従う必要があります。

制限の種類	Restriction
ファイル名	完全修飾ページ パスは、235 文字を超えてはなりません。
一意性	ページ タイトルは大文字と小文字が区別され、Wiki 階層内で一意である必要があります。
特殊文字	- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 次の印刷可能な文字を含めてはいけません: / \ #。 - ピリオド .で開始または終了することはできません。
ファイル サイズ	最大 18 MB を超えてはなりません。
添付ファイルのサイズ	最大 19 MB を超えてはなりません。

Wiki ページ タイトルの特殊文字

これらの特殊文字の 1 つ以上を含むページ タイトルを : < > * ? | -指定できます。 たとえば、Markdown ファイルに "FAQ" または "セットアップ ガイド" という名前を付けることができます。 文字には、次の URI でエンコードされた文字列があります。

文字	エンコードされた文字列
:	%3A
<	%3C
>	%3E
*	%2A
?	%3F
|	%7C
-	%2D
"	%22

関連記事

• Azure Artifacts の数とサイズの制限
• 作業の追跡、処理、およびプロジェクトの制限
• チームのプロセスをサポートするように作業追跡オブジェクトをカスタマイズする
• プロセス テンプレートのカスタマイズ