Добавление пользовательских заголовков <add>

Статья
07/19/2023

Общие сведения

Элемент <add><customHeaders> элемента задает пользовательский заголовок HTTP, который службы IIS 7 будут возвращать в HTTP-ответах от веб-сервера.

Примечание

Заголовки HTTP — это пары имен и значений, возвращаемые в ответах от веб-сервера. Пользовательские заголовки ответа отправляются клиенту вместе с заголовком HTTP по умолчанию. В отличие от заголовков ответов перенаправления, которые возвращаются в ответах только при перенаправлении, пользовательские заголовки ответов возвращаются в каждом ответе.

Совместимость

Версия	Примечания
IIS 10.0	Элемент `<add>` не был изменен в IIS 10.0.
IIS 8,5	Элемент `<add>` не был изменен в IIS 8.5.
IIS 8,0	Элемент `<add>` не был изменен в IIS 8.0.
IIS 7,5	Элемент `<add>` не был изменен в IIS 7.5.
IIS 7.0	Элемент `<add>` элемента появился `<customHeaders>` в IIS 7.0.
IIS 6,0	Элемент `<customHeaders>` заменяет объект метабазы HttpCustomHeaders IIS 6.0.

Настройка

Элемент <add><customHeaders> элемента включен в установку IIS 7 по умолчанию.

Инструкции

Настройка настраиваемых заголовков HTTP для веб-сайта или приложения

Откройте диспетчер служб 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.
В области Подключения перейдите к сайту, приложению или каталогу, для которых требуется задать пользовательский заголовок HTTP.
На панели Главная дважды щелкните заголовки http-ответов.
В области Заголовки HTTP-ответа нажмите кнопку Добавить... в области Действия .
В диалоговом окне Добавление пользовательского заголовка ответа HTTP задайте имя и значение пользовательского заголовка, а затем нажмите кнопку ОК.

Конфигурация

Атрибуты

Атрибут	Описание
`name`	Обязательный строковый атрибут. Задает имя поля для заголовка настраиваемого ответа. В ответе имя поля предшествует значению связанного поля.
`Value`	Необязательный строковый атрибут. Задает значение поля для заголовка настраиваемого ответа. В ответе значение поля следует за именем связанного поля.

Дочерние элементы

Отсутствует.

Образец конфигурации

В следующем примере конфигурации задается пользовательский заголовок и значение HTTP.

<configuration>
   <system.webServer>
      <httpProtocol>
         <customHeaders>
            <add name="X-Custom-Name" value="MyCustomValue" />
         </customHeaders>
      </httpProtocol>
   </system.webServer>
</configuration>

Примечание

Следующий элемент по умолчанию <httpProtocol> настраивается в файле ApplicationHost.config в IIS 7.

<httpProtocol>
   <customHeaders>
      <clear />
      <add name="X-Powered-By" value="ASP.NET" />
   </customHeaders>
   <redirectHeaders>
      <clear />
   </redirectHeaders>
</httpProtocol>

Пример кода

В следующих примерах кода задаются пользовательский заголовок и значение HTTP.

AppCmd.exe

appcmd.exe set config "Default Web Site" -section:system.webServer/httpProtocol /+"customHeaders.[name='X-Custom-Name',value='MyCustomValue']"

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("Default Web Site");
         ConfigurationSection httpProtocolSection = config.GetSection("system.webServer/httpProtocol");
         ConfigurationElementCollection customHeadersCollection = httpProtocolSection.GetCollection("customHeaders");

         ConfigurationElement addElement = customHeadersCollection.CreateElement("add");
         addElement["name"] = @"X-Custom-Name";
         addElement["value"] = @"MyCustomValue";
         customHeadersCollection.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("Default Web Site")
      Dim httpProtocolSection As ConfigurationSection = config.GetSection("system.webServer/httpProtocol")
      Dim customHeadersCollection As ConfigurationElementCollection = httpProtocolSection.GetCollection("customHeaders")

      Dim addElement As ConfigurationElement = customHeadersCollection.CreateElement("add")
      addElement("name") = "X-Custom-Name"
      addElement("value") = "MyCustomValue"
      customHeadersCollection.Add(addElement)

      serverManager.CommitChanges()
   End Sub

End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Default Web Site";
var httpProtocolSection = adminManager.GetAdminSection("system.webServer/httpProtocol", "MACHINE/WEBROOT/APPHOST/Default Web Site");
var customHeadersCollection = httpProtocolSection.ChildElements.Item("customHeaders").Collection;

var addElement = customHeadersCollection.CreateNewElement("add");
addElement.Properties.Item("name").Value = "X-Custom-Name";
addElement.Properties.Item("value").Value = "MyCustomValue";
customHeadersCollection.AddElement(addElement);

adminManager.CommitChanges();

VBScript

Set adminManager = WScript.CreateObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Default Web Site"
Set httpProtocolSection = adminManager.GetAdminSection("system.webServer/httpProtocol", "MACHINE/WEBROOT/APPHOST/Default Web Site")
Set customHeadersCollection = httpProtocolSection.ChildElements.Item("customHeaders").Collection

Set addElement = customHeadersCollection.CreateNewElement("add")
addElement.Properties.Item("name").Value = "X-Custom-Name"
addElement.Properties.Item("value").Value = "MyCustomValue"
customHeadersCollection.AddElement(addElement)

adminManager.CommitChanges()

Поделиться через