ASP.NET Core の環境タグ ヘルパー

ピーター・ケルナーとヒシャム・ビン・アテヤ

環境タグ ヘルパーは、現在の ホスティング環境に基づいて、囲まれたコンテンツを条件付きでレンダリングします。 環境タグ ヘルパーの単一属性 ( names) は、環境名のコンマ区切りのリストです。 指定された環境名のいずれかが現在の環境と一致する場合は、囲まれたコンテンツがレンダリングされます。

タグヘルパーの概要については、ASP.NET Core の「タグヘルパー」を参照してください。

環境タグヘルパーの属性

names

names は、囲まれたコンテンツのレンダリングをトリガーする単一のホスティング環境名またはホスト環境名のコンマ区切りのリストを受け入れます。

環境の値は、 IWebHostEnvironment.EnvironmentName によって返される現在の値と比較されます。 比較では大文字と小文字が無視されます。

次の例では、環境タグ ヘルパーを使用します。 ホスティング環境がステージング環境または運用環境の場合、コンテンツがレンダリングされます。

<environment names="Staging,Production">
    <strong>IWebHostEnvironment.EnvironmentName is Staging or Production</strong>
</environment>

属性を含める/除外する

include & exclude 属性は、包含または除外されたホスティング環境名に基づいて、囲まれたコンテンツのレンダリングを制御します。

含める

include プロパティは、names属性と同様の動作を示します。 include属性値にリストされている環境は、アプリのホスティング環境 (IWebHostEnvironment.EnvironmentName) と一致して、<environment> タグのコンテンツをレンダリングする必要があります。

<environment include="Staging,Production">
    <strong>IWebHostEnvironment.EnvironmentName is Staging or Production</strong>
</environment>

exclude

include属性とは異なり、ホスト環境が<environment>属性値に一覧表示されている環境と一致しない場合、exclude タグの内容がレンダリングされます。

<environment exclude="Development">
    <strong>IWebHostEnvironment.EnvironmentName is not Development</strong>
</environment>

その他のリソース

• ASP.NET コア ランタイム環境