Modules 要素 <modules element>

[アーティクル]
03/22/2024

概要

<modules> 要素は、アプリケーションに登録されているネイティブコードモジュールとマネージドコードモジュールを定義します。インターネットインフォメーションサービス (IIS) 要求パイプライン処理の一環として、IIS は要求ごとに <modules> 要素に一覧表示されている各モジュールを呼び出します。モジュールを使用して、セキュリティ、統計、ログ記録などのカスタマイズされた機能や、カスタマイズされたヘッダーやフッターの追加などのカスタマイズされたコンテンツ処理を実装するのが一般的です。

<modules> 要素には、<add> 要素のコレクションが含まれます。各要素は、アプリケーションに対して有効なモジュールを定義します。モジュールを有効にすると、特定のアプリケーションに対してサービスを提供できるようになります。

ネイティブモジュールを有効にする場合は、最初にサーバーにインストールする必要があります。詳細については、<globalModules> 要素を参照してください。

マネージドモジュールをインストールする必要はありません。アプリケーションごとに直接有効にすることができます。これにより、アプリケーションは、アプリケーションの Web.config ファイルにマネージドモジュールを登録し、/BIN または /App_Code ディレクトリに実装を提供することによって、マネージドモジュールをアプリケーション内に直接含めることができます。

互換性

バージョン	メモ
IIS 10.0	`<modules>` 要素は、IIS 10.0 では変更されませんでした。
IIS 8.5	`<modules>` 要素は、IIS 8.5 では変更されませんでした。
IIS 8.0	`<modules>` 要素は IIS 8.0 では変更されませんでした。
IIS 7.5	`<modules>` 要素は、IIS 7.5 では変更されませんでした。
IIS 7.0	`<modules>` 要素が IIS 7.0 で導入されました。
IIS 6.0	該当なし

段取り

<modules> 要素は IIS 7 の既定のインストールに含まれています。

操作方法

マネージドモジュールをアプリケーションに追加する方法

インターネットインフォメーションサービス (IIS) マネージャーを開きます。
- Windows Server 2012 または Windows Server 2012 R2 を使用している場合:
  - タスクバーで、[サーバーマネージャー] をクリックし、[ツール]、[インターネットインフォメーションサービス (IIS) マネージャー] の順にクリックします。
- Windows 8 または Windows 8.1 を使用している場合:
  - Windows キーを押しながら文字 X を押し、[コントロールパネル] をクリックします。
  - [管理ツール] をクリックし、[インターネットインフォメーションサービス (IIS) マネージャー] をダブルクリックします。
- Windows Server 2008 または Windows Server 2008 R2 を使用している場合:
  - タスクバーで、[スタート] ボタンをクリックし、[管理ツール]、[インターネットインフォメーションサービス (IIS) マネージャー] の順にクリックします。
- Windows Vista または Windows 7 を使用している場合:
  - タスクバーで、[スタート]、[コントロールパネル] の順にクリックします。
  - [管理ツール] をダブルクリックし、[インターネットインフォメーションサービス (IIS) マネージャー] をダブルクリックします。
[接続] ウィンドウで、サーバー名を展開し、[サイト] を展開して、マネージドモジュールを追加する Web サイトまたはアプリケーションに移動します。
[ホーム] ウィンドウで、[モジュール] をダブルクリックします。
[操作] ウィンドウで、[マネージドモジュールの追加] をクリックします。
[マネージドモジュールの追加] ダイアログボックスで、[名前] ボックスにマネージドモジュールの名前を入力し、[種類] ボックスにモジュールの .NET Framework の完全修飾型を入力または選択します。
モジュールがマネージド要求にのみ応答するようにする場合は、[ASP.NET アプリケーションまたはマネージドハンドラーへの要求に対してのみ呼び出す] オプションを選択します。
OK をクリックします。

構成

<modules> 要素は、ApplicationHost.config ファイルのサーバーレベルと Web.config ファイルのアプリケーションレベルで構成します。

属性

属性説明

runAllManagedModulesForAllRequests 省略可能なブール値。

要求がマネージドコンテンツ用でなかった場合でも、すべてのマネージドモジュールがすべての要求を処理できる場合は true、それ以外の場合は false。

注: ASP.NET Web サイトでは、ルーティングをサポートするために以前は runAllManagedModulesForAllRequests の値を true に設定する必要がありました。ただし、IIS 7 をサービスパックで更新した後は、ASP.NET ルーティングを操作するときに runAllManagedModulesForAllRequests の値を false に設定するか、省略できます。詳細については、MSDN Web サイトの「ASP.NET ルーティング」を参照してください。

既定値は false です。

runManagedModulesForWebDavRequests 省略可能なブール値。

マネージドモジュールが WebDAV 要求を処理できる場合は true、それ以外の場合は false。

既定値は false です。

属性	説明
`runAllManagedModulesForAllRequests`	省略可能なブール値。要求がマネージドコンテンツ用でなかった場合でも、すべてのマネージドモジュールがすべての要求を処理できる場合は true、それ以外の場合は false。注: ASP.NET Web サイトでは、ルーティングをサポートするために以前は `runAllManagedModulesForAllRequests` の値を `true` に設定する必要がありました。ただし、IIS 7 をサービスパックで更新した後は、ASP.NET ルーティングを操作するときに `runAllManagedModulesForAllRequests` の値を `false` に設定するか、省略できます。詳細については、MSDN Web サイトの「ASP.NET ルーティング」を参照してください。既定値は `false` です。
`runManagedModulesForWebDavRequests`	省略可能なブール値。マネージドモジュールが WebDAV 要求を処理できる場合は true、それ以外の場合は false。既定値は `false` です。

子要素

要素	説明
`add`	省略可能な要素です。モジュールのコレクションにモジュールを追加します。
`clear`	省略可能な要素です。モジュールコレクションからモジュールへのすべての参照を削除します。
`remove`	省略可能な要素です。モジュールコレクションからモジュールへの参照を削除します。

構成サンプル

この例では、IIS 7 統合モードで実行されている Web アプリケーションのモジュールを構成します。

<configuration>
   <system.webServer>
      <modules>
         <add name="Header" type="Contoso.ShoppingCart.Header"/>
      </modules>
   </system.webServer>
</configuration>

サンプルコード

Note

このドキュメントの例は、.NET グローバルアセンブリキャッシュ (GAC) に格納されているマネージドコードアセンブリを使用して示されています。これらの例のコードを使用して独自のアセンブリを展開する前に、GAC からアセンブリ情報を取得する必要があります。そのためには、次の手順を行ってください。

エクスプローラーで、C:\Windows\assembly パスを開きます。ここで、C: はオペレーティングシステムドライブです。
アセンブリを見つけます。
アセンブリを右クリックし、[プロパティ] をクリックします。
カルチャ値 (例: Neutral) をコピーします。
バージョン番号 (例: 1.0.0.0) をコピーします。
Public Key Token 値 (例: 426f62526f636b73) をコピーします。
[キャンセル] をクリックします。

次のコード例では、Contoso という名前の Web サイトのマネージドモジュールを有効にします。 name プロパティはモジュールの CartHeader という名前を定義し、type プロパティはモジュールのマネージド型を定義し、preCondition プロパティは IIS がマネージド要求に対してのみモジュールを呼び出すように定義します。

AppCmd.exe

appcmd.exe set config "Contoso" -section:system.webServer/modules /+"[name='CartHeader',type='Contoso.ShoppingCart.Header',preCondition='managedHandler']"

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetWebConfiguration("Contoso");
         ConfigurationSection modulesSection = config.GetSection("system.webServer/modules");
         ConfigurationElementCollection modulesCollection = modulesSection.GetCollection();

         ConfigurationElement addElement = modulesCollection.CreateElement("add");
         addElement["name"] = @"CartHeader";
         addElement["type"] = @"Contoso.ShoppingCart.Header";
         addElement["preCondition"] = @"managedHandler";
         modulesCollection.Add(addElement);

         serverManager.CommitChanges();
      }
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetWebConfiguration("Contoso")
      Dim modulesSection As ConfigurationSection = config.GetSection("system.webServer/modules")
      Dim modulesCollection As ConfigurationElementCollection = modulesSection.GetCollection

      Dim addElement As ConfigurationElement = modulesCollection.CreateElement("add")
      addElement("name") = "CartHeader"
      addElement("type") = "Contoso.ShoppingCart.Header"
      addElement("preCondition") = "managedHandler"
      modulesCollection.Add(addElement)

      serverManager.CommitChanges()
   End Sub
End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Contoso";
var modulesSection = adminManager.GetAdminSection("system.webServer/modules", "MACHINE/WEBROOT/APPHOST/Contoso");
var modulesCollection = modulesSection.Collection;

var addElement = modulesCollection.CreateNewElement("add");
addElement.Properties.Item("name").Value = "CartHeader";
addElement.Properties.Item("type").Value = "Contoso.ShoppingCart.Header";
addElement.Properties.Item("preCondition").Value = "managedHandler";
modulesCollection.AddElement(addElement);

adminManager.CommitChanges();

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Contoso"
Set modulesSection = adminManager.GetAdminSection("system.webServer/modules", "MACHINE/WEBROOT/APPHOST/Contoso")
Set modulesCollection = modulesSection.Collection

Set addElement = modulesCollection.CreateNewElement("add")
addElement.Properties.Item("name").Value = "CartHeader"
addElement.Properties.Item("type").Value = "Contoso.ShoppingCart.Header"
addElement.Properties.Item("preCondition").Value = "managedHandler"
modulesCollection.AddElement addElement

adminManager.CommitChanges()

次の方法で共有

Modules 要素 <modules element>

概要

互換性

段取り

操作方法

マネージドモジュールをアプリケーションに追加する方法

構成

属性

子要素

構成サンプル

サンプルコード

AppCmd.exe

C#

VB.NET

JavaScript

VBScript

フィードバック

その他のリソース

次の方法で共有

Modules 要素 <modules element>

概要

互換性

段取り

操作方法

マネージド モジュールをアプリケーションに追加する方法

構成

属性

子要素

構成サンプル

サンプル コード

AppCmd.exe

C#

VB.NET

JavaScript

VBScript

フィードバック

その他のリソース

マネージドモジュールをアプリケーションに追加する方法

サンプルコード