HttpRedirectSection クラス

HTTP リダイレクトを構成します。

構文

class HttpRedirectSection : ConfigurationSectionWithCollection  

メソッド

次の表に、HttpRedirectSection クラスによって公開されるメソッドの一覧を示します。

名前 説明
[追加] (ConfigurationSectionWithCollection から継承。)
Clear (ConfigurationSectionWithCollection から継承。)
Get (ConfigurationSectionWithCollection から継承。)
GetAllowDefinition (ConfigurationSection から継承。)
GetAllowLocation (ConfigurationSection から継承。)
削除 (ConfigurationSectionWithCollection から継承。)
RevertToParent (ConfigurationSection から継承。)
SetAllowDefinition (ConfigurationSection から継承。)
SetAllowLocation (ConfigurationSection から継承。)

プロパティ

次の表は、HttpRedirectSection クラスによって公開されるプロパティの一覧です。

名前 説明
ChildOnly 読み取り/書き込みの boolean 値。 リダイレクト先が元の URL のサブディレクトリにある場合は true。それ以外の場合は false。 既定値は、false です。 この設定は、リダイレクトを 1 回だけ行う必要があることを IIS に警告し、置換エンジンでの無限ループを防ぎます。
Destination ユーザーがリダイレクトされるファイル名、ディレクトリ パス、または URL を含む、必須の空でない読み取り/書き込みの string 値。 文字列にリダイレクト変数を含めて、元の URL の一部を宛先 URL と共に渡すことができます。 文字列には複数の変数を使用できます。
Enabled 読み取り/書き込みの boolean 値。 HTTP リダイレクトを有効にする場合は true。それ以外の場合は false。 既定値は、false です。
ExactDestination 読み取り/書き込みの boolean 値。 URL を絶対パスと見なす必要がある場合は true。それ以外の場合は falsetrue に設定すると、置換エンジンによって元の要求されたリソースがリダイレクト URL に追加されなくなります。
HttpRedirect WildcardRedirectElement 値の配列。一致条件を使って、ファイル名、ディレクトリ パス、または URL の要求を指定した宛先にリダイレクトします。
HttpResponseStatus HTTP 応答の状態を含む読み取り/書き込みの sint32 列挙型。 使用できる値の一覧は、後述の「注釈」セクションに示します。
Location (ConfigurationSection から継承。)キー プロパティ。
Path (ConfigurationSection から継承。)キー プロパティ。
SectionInformation (ConfigurationSection から継承。)

サブクラス

このクラスにはサブクラスが含まれていません。

解説

次の表に、HttpResponseStatus プロパティとして使用できる値の一覧を示します。 既定値は 302 (Found) です。

Value キーワード 説明
301 Permanent IIS は、要求されたリソースの場所が恒久的に変更されたことを Web クライアントに通知します。 新しい場所は Location HTTP ヘッダーで指定されます。 この設定により、HTTP URL リンクを記録する Web クライアントは、保存されている URL を新しい場所で更新できます。
302 Found IIS は、Location HTTP ヘッダーで指定された場所に新しい要求を発行するように Web クライアントに指示します。
307 Temporary IIS は、元のデータを含む POST 要求を新しい場所に再発行するように Web ブラウザーに指示します。 通常、Web ブラウザーが POST 要求を発行し、Web サーバーから 302 リダイレクト メッセージを受信した場合、ブラウザーは新しい場所に対して GET 要求を発行します。 これにより、元の POST 要求のデータは失われます。 ブラウザーが 307 リダイレクトを受信した場合は、元のデータをそのまま含む POST を再発行できます。

最初の例では、埋め込みの SectionInformation プロパティと HttpRedirect プロパティを含む、HttpRedirectSection クラスのすべてのプロパティを表示します。

2 番目の例では、4 つのワイルドカード リダイレクト要素を作成し、それらを既定の Web サイトの <httpRedirect> セクションに追加しようとします。 重複するエントリが存在する場合、コードはそのことを報告します。それ以外の場合は、新しいエントリが追加されます。 最後に、すべてのエントリの新しいカウントと、それぞれのワイルドカードと宛先を表示します。

' 1) First example: Display the httpRedirect properties  
' for the default Web site.  
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = _  
    GetObject("winmgmts:root\WebAdministration")  
  
' Get the httpRedirect section for the default Web site.  
Set oSite = oWebAdmin.Get("Site.Name='Default Web Site'")  
oSite.GetSection "HttpRedirectSection", oSection  
  
' Display the nonembedded properties.  
WScript.Echo "=============================="  
WScript.Echo "HttpRedirectSection Properties"  
WScript.Echo "=============================="  
For Each vProp In oSection.Properties_  
    If (vProp.Name <> "HttpRedirect") And _  
    (vProp.Name <> "SectionInformation") Then  
        WScript.Echo vProp.Name & ": " & vProp.Value  
    End If  
Next  
  
' Display the contents of the SectionInformation property.  
WScript.Echo   
WScript.Echo "--------------------------------------"  
WScript.Echo "HttpRedirectSection.SectionInformation"  
WScript.Echo "--------------------------------------"  
For Each vProp In oSection.SectionInformation.Properties_  
    WScript.Echo vProp.Name & ": " & vProp.Value  
Next  
WScript.Echo   
  
' Display the WildcardRedirectElement instances in the  
' HttpRedirect array property.  
WScript.Echo "--------------------------------"  
WScript.Echo "HttpRedirectSection.HttpRedirect"  
WScript.Echo "--------------------------------"  
For Each oWildcardRedirectElement In oSection.HttpRedirect  
    For Each vProp In oWildcardRedirectElement.Properties_  
        WScript.Echo vProp.Name & ": " & vProp.Value  
    Next  
    WScript.Echo  
Next  
  
' 2) Second example: Add four WildcardRedirectElement  
' instances to the default Web site and display the result.  
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = _  
    GetObject("winmgmts:root\WebAdministration")  
  
' Get the httpRedirect section for the default Web site.  
Set oSite = oWebAdmin.Get("Site.Name='Default Web Site'")  
oSite.GetSection "HttpRedirectSection", oSection  
  
' Set up a loop to add four new redirects.  
For Counter = 1 To 4  
    ' Create a new instance of WildcardRedirectElement.  
    ' Note that you do not need to use SpawnInstance_.  
    Set oWildcardRedirect = _  
        oWebAdmin.Get("WildcardRedirectElement")  
  
    ' Specify the page to be redirected.  
    oWildcardRedirect.Wildcard = _  
        "Adatum.com/Page" & Counter & ".htm"  
  
    ' Specify the destination for the redirected page.  
    oWildcardRedirect.Destination = _  
        "Contoso.com/Page" & Counter & ".htm"  
  
    ' Prepare to catch duplicate entries.  
    On Error Resume Next  
  
    ' Attempt to add the wildcard entry to the collection.   
    ' (You do not need to use Put_ to save the change.)  
    oSection.Add "HttpRedirect", oWildcardRedirect  
  
    ' Catch duplicate entries.  
    If Err.Number = -2147024713 Then  
        WScript.Echo "Redirect entry for """ & _  
        oWildcardRedirect.Wildcard & """ already exists."  
        WScript.Echo  
    End If  
Next  
  
' Update the contents of the oSection variable.  
oSection.Refresh_  
  
' Display a header and the new number of entries.  
WScript.Echo "--------------------------------"  
WScript.Echo "HttpRedirectSection.HttpRedirect"  
WScript.Echo "--------------------------------"  
WScript.Echo "The number of redirect entries is now " & _  
    UBound(oSection.HttpRedirect) + 1 & "."  
WScript.Echo   
  
' Display the new set of wildcard redirect elements.  
For Each oWildcardRedirectElement In oSection.HttpRedirect  
    WScript.Echo "Wildcard: " & _  
        oWildcardRedirectElement.Wildcard & vbTab & _  
        "Destination: " & _  
        oWildcardRedirectElement.Destination  
    WScript.Echo  
Next  
  

継承階層

ConfigurationSection

ConfigurationSectionWithCollection

HttpRedirectSection

要件

説明
クライアント - Windows Vista 上の IIS 7.0
- Windows 7 上の IIS 7.5
- Windows 8 上の IIS 8.0
- Windows 10 上の IIS 10.0
[サーバー] - Windows Server 2008 上の IIS 7.0
- Windows Server 2008 R2 上の IIS 7.5
- Windows Server 2012 上の IIS 8.0
- Windows Server 2012 R2 上の IIS 8.5
- Windows Server 2016 上の IIS 10.0
Product - IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0
MOF ファイル WebAdministration.mof

参照

ConfigurationSectionWithCollection クラス
SectionInformation クラス
WildcardRedirectElement クラス