ASP.NET Core の環境タグ ヘルパーEnvironment Tag Helper in ASP.NET Core

作成者: Peter KellnerHisham Bin AteyaLuke LathamBy Peter Kellner, Hisham Bin Ateya, and Luke Latham

環境タグ ヘルパーは、現在のホスティング環境に基づき、囲まれたコンテンツを条件付きで表示します。The Environment Tag Helper conditionally renders its enclosed content based on the current hosting environment. 環境タグ ヘルパーの 1 つの属性 names は、環境名のコンマ区切りリストです。The Environment Tag Helper's single attribute, names, is a comma-separated list of environment names. 指定された環境名のいずれかが現在の環境と一致する場合、囲まれたコンテンツが表示されます。If any of the provided environment names match the current environment, the enclosed content is rendered.

タグ ヘルパーの概要については、「ASP.NET Core のタグ ヘルパー」をご覧ください。For an overview of Tag Helpers, see ASP.NET Core のタグ ヘルパー.

環境タグ ヘルパーの属性Environment Tag Helper Attributes

名前names

names は、囲まれたコンテンツの表示をトリガーする単一のホスティング環境名またはホスティング環境名のコンマ区切りリストを受け入れます。names accepts a single hosting environment name or a comma-separated list of hosting environment names that trigger the rendering of the enclosed content.

環境値は、IHostingEnvironment.EnvironmentName によって返される現在の値と比較されます。Environment values are compared to the current value returned by IHostingEnvironment.EnvironmentName. 比較では大文字と小文字の区別は無視されます。The comparison ignores case.

環境タグ ヘルパーを使用する例を次に示します。The following example uses an Environment Tag Helper. ホスティング環境が Staging または Production の場合、コンテンツが表示されます。The content is rendered if the hosting environment is Staging or Production:

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

include および exclude 属性include and exclude attributes

include および exclude 属性は、含めるまたは除外するホスティング環境名に基づいて、囲まれたコンテンツの表示を制御します。include & exclude attributes control rendering the enclosed content based on the included or excluded hosting environment names.

includeinclude

include プロパティが示す動作は、names 属性と似ています。The include property exhibits similar behavior to the names attribute. <environment> タグの内容が表示されるためには、include 属性の値で列記されている環境が、アプリのホスティング環境 (IHostingEnvironment.EnvironmentName) と一致する必要があります。An environment listed in the include attribute value must match the app's hosting environment (IHostingEnvironment.EnvironmentName) to render the content of the <environment> tag.

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

excludeexclude

include 属性とは対照的に、<environment> タグの内容は、ホスティング環境が exclude 属性の値で列記されている環境と一致しない場合に表示されます。In contrast to the include attribute, the content of the <environment> tag is rendered when the hosting environment doesn't match an environment listed in the exclude attribute value.

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

その他の技術情報Additional resources