Директива Clean-param — Вебмастер. Справка

1. Обучающее видео
2. Как использовать директиву Clean-param
3. Синтаксис директивы
4. Дополнительные примеры
5. Disallow и Clean-param

Примечание. Иногда для закрытия таких страниц используется директива Disallow. Рекомендуем использовать Clean-param, так как эта директива позволяет передавать основному URL или сайту некоторые накопленные показатели.

Как использовать директиву Clean-param. Посмотреть видео

Заполняйте директиву Clean-param максимально полно и поддерживайте ее актуальность. Новый параметр, не влияющий на контент страницы, может привести к появлению страниц-дублей, которые не должны попасть в поиск.

Из-за большого количества таких страниц робот медленнее обходит сайт. А значит, важные изменения дольше не попадут в результаты поиска.

Робот Яндекса, используя эту директиву, не будет многократно перезагружать дублирующуюся информацию. Таким образом, увеличится эффективность обхода вашего сайта, снизится нагрузка на сервер.

Например, на сайте есть страницы:

www.example.com/some_dir/get_book.pl?ref=site_1&book_id=123
www.example.com/some_dir/get_book.pl?ref=site_2&book_id=123
www.example.com/some_dir/get_book.pl?ref=site_3&book_id=123

Параметр ref используется только для того, чтобы отследить с какого ресурса был сделан запрос и не меняет содержимое, по всем трем адресам будет показана одна и та же страница с книгой book_id=123. Тогда, если указать директиву следующим образом:

User-agent: Yandex
Clean-param: ref /some_dir/get_book.pl

Робот Яндекса сведет все адреса страницы к одному:

www. example.com/some_dir/get_book.pl?book_id=123

Если на сайте доступна такая страница, именно она будет участвовать в результатах поиска.

Чтобы директива применялась к параметрам на страницах по любому адресу, не указывайте адрес:

User-agent: Yandex
Clean-param: utm

Совет. Директива Clean-Param является межсекционной, поэтому может быть указана в любом месте файла. Если вы указываете другие директивы именно для робота Яндекса, перечислите все предназначенные для него правила в одной секции. При этом строка User-agent: * будет проигнорирована.

Clean-param: p0[&p1&p2&..&pn] [path]

В первом поле через символ & перечисляются параметры, которые роботу не нужно учитывать. Во втором поле указывается префикс пути страниц, для которых нужно применить правило.

Префикс может содержать регулярное выражение в формате, аналогичном файлу robots. txt, но с некоторыми ограничениями: можно использовать только символы A-Za-z0-9.-/*_. При этом символ * трактуется так же, как в файле robots.txt: в конец префикса всегда неявно дописывается символ *. Например:

Clean-param: s /forum/showthread.php

означает, что параметр s будет считаться незначащим для всех URL, которые начинаются с /forum/showthread.php. Второе поле указывать необязательно, в этом случае правило будет применяться для всех страниц сайта.

Регистр учитывается. Действует ограничение на длину правила — 500 символов. Например:

Clean-param: abc /forum/showthread.php
Clean-param: sid&sort /forum/*.php
Clean-param: someTrash&otherTrash

#для адресов вида:
www.example1.com/forum/showthread.php?s=681498b9648949605&t=8243
www.example1.com/forum/showthread.php?s=1e71c4427317a117a&t=8243
#robots.txt будет содержать:
User-agent: Yandex
Clean-param: s /forum/showthread. php

 #для адресов  вида:
www.example2.com/index.php?page=1&sid=2564126ebdec301c607e5df
www.example2.com/index.php?page=1&sid=974017dcd170d6c4a5d76ae
#robots.txt будет содержать:
User-agent: Yandex
Clean-param: sid /index.php

#если таких параметров несколько:
www.example1.com/forum_old/showthread.php?s=681498605&t=8243&ref=1311
www.example1.com/forum_new/showthread.php?s=1e71c417a&t=8243&ref=9896
#robots.txt будет содержать:
User-agent: Yandex
Clean-param: s&ref /forum*/showthread.php

#если параметр используется в нескольких скриптах:
www.example1.com/forum/showthread.php?s=681498b9648949605&t=8243
www.example1.com/forum/index.php?s=1e71c4427317a117a&t=8243
#robots.txt будет содержать:
User-agent: Yandex
Clean-param: s /forum/index.php
Clean-param: s /forum/showthread.php

Директива Clean-param не требует обязательного сочетания с директивой Disallow.

User-agent: Yandex
Disallow:
Clean-param: s&ref /forum*/showthread.php
#идентично:
User-agent: Yandex
Clean-param: s&ref /forum*/showthread.php

Так как директива Clean-param межсекционная, ее можно указывать в любом месте файла, вне зависимости от расположения директив Disallow и Allow. Исполнение Disallow при этом имеет приоритет и, если адрес страницы запрещен к индексированию в Disallow и одновременно ограничен в Clean-param, страница проиндексирована не будет.

User-agent: Yandex
Disallow:/forum
Clean-param: s&ref /forum*/showthread.php

В этом случае страница https://example.com/forum?ref=page будет считаться запрещенной. Не указывайте директиву Disallow для страниц, если хотите только удалить из поиска варианты ссылок с GET-параметрами.

param — что это такое, и для чего используется

#Оптимизация сайта #Индексация

#111

Апрель’19

24

Апрель’19

24

Clean-param — это директива файла robots. txt, которую поддерживают роботы Яндекса. Она позволяет сообщить динамические параметры, которые присутствуют в url-адресе страницы, но не изменяют ее содержание. Это могут быть идентификаторы пользователя, сессии, параметры сортировки товаров и другие элементы.

Например, имеются страницы:

• site.ru/catalog/category/?sort_field=PRICE&order=asc
• site.ru/catalog/category/?sort_field=PRICE&order=desc
• site.ru/catalog/category/?sort_field=id&order=asc

Все они содержат одинаковый контент, но имеют в своих URL-адресах параметры sort_field и order, которые определяют сортировку товаров на этой странице, но формально не меняют ее содержание. В результате у нас получается 3 страницы-дубликата. Правильно настроить обработку таких страниц нам поможет директива Clean-param. Необходимо прописать её в файле robots.txt следующим образом:

User-Agent: Yandex … Clean-param: sort_field&order /catalog/category/

После этого индексироваться роботом Яндекса будет только одна страница: site.

ru/catalog/category/, параметры sort_field и order учитываться не будут.

Данная настройка позволит снизить нагрузку на сервер, т.к. робот не будет загружать страницы с указанными параметрами, повысится эффективность обхода сайта роботом, и убережет Вас от появления в индексе дубликатов страниц.

Синтаксис директивы

Clean-param: p0[&p1&p2&..&pn] [path]

Поле p — это динамические параметры, влияние которых на индексацию необходимо устранить. Если таких несколько, их нужно перечислить через амперсанд, например, sort&price.

Поле path — префикс, указывающий путь применения директивы. Если его не указывать, Clean-param применится для всего сайта.

Файл robots.txt не имеет ограничений на количество указываемых директив Clean-param. В любом месте файла и количестве они будут учтены. В написании директивы учитывается регистр, а также длина правила ограничена 500 символами.

Пример применения

Допустим у нас имеется страница с такими get-параметрами:

• https://orteka. ru/catalog/kompressionnyi-trikotazh/golfy/?sort=popularity&order=asc
• https://orteka.ru/catalog/kompressionnyi-trikotazh/golfy/?sort=price&order=asc
• https://orteka.ru/catalog/kompressionnyi-trikotazh/golfy/?sort=price&order=desc

Директива Clean-param должна иметь следующее содержание:

Clean-param: sort& order /catalog/kompressionnyi-trikotazh/golfy/

• sort& order — это динамическиt параметры, которые не нужно учитывать;
• /catalog/kompressionnyi-trikotazh/golfy/— префикс применения директивы, обозначает, что данные параметры не нужно учитывать только для страниц, начинающихся с /catalog/kompressionnyi-trikotazh/golfy/. Если необходимо, чтобы правило применялось ко всем страницам сайта, префикс указывать не нужно.

Похожее

Оптимизация сайта Индексация

Атрибут rel=canonical

Оптимизация сайта Индексация

Индексация ссылок

Оптимизация сайта Индексация

#133

Атрибут rel=canonical

Март’23

12590

23

Оптимизация сайта Индексация

#119

Индексация ссылок

Апрель’19

4731

30

Оптимизация сайта Индексация

#104

Как привлечь быстроробота Яндекс

Февраль’19

2318

21

Оптимизация сайта Индексация

#94

Проверка индекса сайта. Как найти мусорные или недостающие страницы

Декабрь’18

9958

28

Оптимизация сайта Индексация

#86

Как закрыть ссылки и текст от поисковых систем

Ноябрь’18

6212

22

Оптимизация сайта Индексация

#82

Почему Яндекс удаляет страницы из поиска

Ноябрь’18

3277

19

Оптимизация сайта Индексация

#60

Правильная индексация страниц пагинации

Февраль’18

8443

19

Оптимизация сайта Индексация

#47

Как узнать дату индексации страницы

Ноябрь’17

8039

18

Оптимизация сайта Индексация

#46

Какие страницы надо закрывать от индексации

Ноябрь’17

10982

18

Оптимизация сайта Индексация

#38

Как удалить страницу из индекса Яндекса и Google

Ноябрь’17

14498

20

Оптимизация сайта Индексация

#37

Как добавить страницу в поиск Яндекса и Google

Апрель’17

20298

19

Оптимизация сайта Индексация

#7

Как закрыть сайт от индексации

Ноябрь’17

10207

18

Оптимизация сайта Индексация

#2

Как проверить индексацию сайта в поисковых системах

Ноябрь’17

18014

27

Оптимизация сайта Индексация

#1

Как ускорить индексацию сайта

Ноябрь’17

5998

29

Директива Clean-param — Webmaster.

Справка

Используйте директиву Clean-param, если URL-адреса страниц сайта содержат параметры GET (например, идентификаторы сеансов, идентификаторы пользователей) или теги (например, UTM), которые не влияют на их содержимое.

Примечание. Иногда для закрытия этих страниц используется директива Disallow. Мы рекомендуем использовать Clean-param, так как эта директива позволяет перенести некоторые накопленные метрики на основной URL или сайт.

Как можно полнее укажите директиву Clean-param и поддерживайте ее в актуальном состоянии. Новый параметр, не влияющий на содержимое страницы, может привести к дублированию страниц, которые не следует включать в поиск. Из-за большого количества таких страниц робот медленнее сканирует сайт. Это означает, что для отображения важных изменений в результатах поиска потребуется больше времени.

Робот Яндекса использует эту директиву, чтобы избежать повторной загрузки дублирующейся информации. Это повышает эффективность работы робота и снижает нагрузку на сервер.

Например, ваш сайт содержит следующие страницы:

 www.example.com/some_dir/get_book.pl?ref=site_1&book_id=123
www.example.com/some_dir/get_book.pl?ref=site_2&book_id=123
www.example.com/some_dir/get_book.pl?ref=site_3&book_id=123 

Параметр ref используется только для отслеживания того, с какого ресурса был отправлен запрос. Это не меняет содержимое страницы. Все три URL будут отображать одну и ту же страницу с книгой book_id=123. Тогда, если указать директиву следующим образом:

 User-agent: Яндекс
Запретить:
Clean-param: ref /some_dir/get_book.pl 

робот Яндекса соберет все адреса страниц в один:

 www.example.com/some_dir/get_book.pl?book_id=123 

Если такая страница есть на сайт, он включается в результаты поиска.

 Clean-param: p0[&p1&p2&..&pn] [путь] 

В первом поле перечислите параметры, которые робот не должен учитывать, разделенные символом &. Во втором поле укажите префикс пути для страниц, к которым должно применяться правило.

Примечание. Директива Clean-Param является межсекционной, поэтому ее можно указывать в любом месте файла robots.txt. Если указано несколько директив, все они будут учтены роботом.

Префикс может содержать регулярное выражение в формате, аналогичном используемому в файле robots.txt, но с некоторыми ограничениями: можно использовать только символы A-Za-z0-9.-/*_. Однако символ * обрабатывается так же, как и в файле robots.txt: символ * всегда неявно добавляется в конец префикса. Примеры:

 Параметр очистки: s /forum/showthread.php 

означает, что параметр s игнорируется для всех URL-адресов, начинающихся с /forum/showthread.php. Второе поле является необязательным, и в этом случае правило будет применяться ко всем страницам сайта.

С учетом регистра. Максимальная длина правила составляет 500 символов. Примеры:

 Чистый параметр: abc /forum/showthread. php
Чистый параметр: sid&sort /forum/*.php
Clean-param: someTrash&otherTrash 

 # для таких URL-адресов, как:
www.example1.com/forum/showthread.php?s=681498b9648949605&t=8243
www.example1.com/forum/showthread.php?s=1e71c4427317a117a&t=8243
#robots.txt будет содержать:
User-agent: Яндекс
Запретить:
Чистый параметр: s /forum/showthread.php 

 # для таких URL-адресов, как:
www.example2.com/index.php?page=1&sid=2564126ebdec301c607e5df
www.example2.com/index.php?page=1&sid=974017dcd170d6c4a5d76ae
#robots.txt будет содержать:
User-agent: Яндекс
Запретить:
Clean-param: sid /index.php 

 #если таких параметров несколько:
www.example1.com/forum_old/showthread.php?s=681498605&t=8243&ref=1311
www.example1.com/forum_new/showthread.php?s=1e71c417a&t=8243&ref=9896
#robots.txt будет содержать:
User-agent: Яндекс
Запретить:
Clean-param: s&ref /forum*/showthread.php 

 #если параметр используется в нескольких скриптах:
www. example1.com/forum/showthread.php?s=681498b9648949605&t=8243
www.example1.com/forum/index.php?s=1e71c4427317a117a&t=8243
#robots.txt будет содержать:
User-agent: Яндекс
Запретить:
Чистый параметр: s /forum/index.php
Чистый параметр: s /forum/showthread.php 

о функциях — PowerShell | Microsoft Learn

• Статья
• 23.01.2023
• 13 минут на чтение

Краткое описание

Описывает создание и использование функций в PowerShell.

Подробное описание

Функция — это список операторов PowerShell, которым назначено имя. Когда вы запускаете функцию, вы вводите имя функции. Заявления в списке запустите, как если бы вы набрали их в командной строке.

Функции могут быть такими простыми, как:

 function Get-PowerShellProcess { Get-Process PowerShell }
 

Функция также может быть такой же сложной, как командлет или приложение.

Как и командлеты, функции могут иметь параметры. Параметры могут быть названы, позиционные, переключающие или динамические параметры. Функциональные параметры можно прочитать из командной строки или из конвейера.

Функции могут возвращать значения, которые можно отображать, назначать переменным или передается другим функциям или командлетам. Вы также можете указать возвращаемое значение, используя возвращает ключевое слово . Ключевое слово return не влияет и не подавляет другие вывод, возвращаемый вашей функцией. Однако ключевое слово return выходит из функция на этой линии. Дополнительные сведения см. в разделе about_Return.

Список операторов функции может содержать различные типы списков операторов с ключевыми словами begin , process , end и clean . Эти списки утверждений обрабатывать входные данные из конвейера по-разному.

Ключевое слово filter используется для создания типа функции, которая запускается на каждом объект в трубопроводе. Фильтр напоминает функцию со всеми ее утверждениями. в блоке процесса .

Функции также могут действовать как командлеты. Вы можете создать функцию, которая работает только как командлет без использования C# программирования. Для получения дополнительной информации см. about_Functions_Advanced.

Важно

В файлах скриптов и модулях на основе скриптов должны быть определены функции прежде чем их можно будет назвать.

Синтаксис

Ниже приведен синтаксис функции:

 function [] [([type]$parameter1[[type]$parameter2])]
{
  begin {<список операторов>}
  процесс {<список операторов>}
  конец {<список операторов>}
  очистить {<список операторов>}
}
 

 функция [<область:>]<имя>
{
  параметр([тип]$параметр1 [[тип]$параметр2])
  dynamicparam {<список операторов>}
  begin {<список операторов>}
  процесс {<список операторов>}
  конец {<список операторов>}
  очистить {<список операторов>}
}
 

Функция включает следующие элементы:

• Функция ключевое слово
• Прицел A (дополнительно)
• Имя, которое вы выбираете
• Любое количество именованных параметров (необязательно)
• Одна или несколько команд PowerShell, заключенных в фигурные скобки {}

Дополнительные сведения о ключевом слове Dynamicparam и динамических параметрах см. функций, см. about_Functions_Advanced_Parameters.

Простые функции

Функции не обязательно должны быть сложными, чтобы быть полезными. Самые простые функции иметь следующий формат:

 function <имя-функции> {операторы}
 

Например, следующая функция запускает PowerShell с параметром «Запуск от имени». Опция администратора .

 функция Start-PSAdmin {Start-Process PowerShell -Глагол RunAs}
 

Чтобы использовать функцию, введите: Start-PSAdmin

Чтобы добавить операторы в функцию, введите каждый оператор в отдельной строке или используйте точку с запятой ; для разделения операторов.

Например, следующая функция находит все .jpg файлов в текущем каталоги пользователя, которые были изменены после даты начала.

 функция Get-NewPix
{
  $start = Get-Date -Месяц 1 -День 1 -Год 2010
  $allpix = Get-ChildItem -Path $env:UserProfile\*.jpg -Recurse
  $allpix | Где-Объект {$_. LastWriteTime -gt $Start}
}
 

Вы можете создать набор полезных небольших функций. Добавьте эти функции в свой Профиль PowerShell, как описано в about_Profiles и далее в этом тема.

Имена функций

Вы можете присвоить любое имя функции, но функции, которыми вы делитесь с другими должны следовать правилам именования, установленным для всех PowerShell. команды.

Имена функций должны состоять из пары глагол-существительное, где глагол определяет действие, которое выполняет функция, а существительное определяет элемент, на котором командлет выполняет свое действие.

Функции должны использовать стандартные глаголы, одобренные для всех Команды PowerShell. Эти глаголы помогают нам поддерживать согласованность имен команд. и простой для понимания пользователями.

Дополнительные сведения о стандартных командах PowerShell см. Утвержденные глаголы.

Функции с параметрами

Вы можете использовать параметры с функциями, включая именованные параметры, позиционные параметры, параметры переключения и динамические параметры. Для дополнительной информации о динамических параметрах в функциях см. about_Functions_Advanced_Parameters.

Именованные параметры

Вы можете определить любое количество именованных параметров. Вы можете включить значение по умолчанию для именованных параметров, как описано далее в этом разделе.

Вы можете определить параметры внутри фигурных скобок, используя ключевое слово param , как показано в следующем образце синтаксиса:

 function <имя> {
  параметр ([тип]$параметр1 [[тип]$параметр2])
  <список операторов>
}
 

Вы также можете определить параметры вне фигурных скобок без ключевого слова Param , как показано в следующем образце синтаксиса:

 function  [([type]$parameter1[[type]$parameter2])] {
  <список операторов>
}
 

Ниже приведен пример этого альтернативного синтаксиса.

 function Add-Numbers([int]$one, [int]$two) {
    $ один + $ два
}
 

Хотя первый метод предпочтительнее, между этими двумя нет никакой разницы. методы.

Когда вы запускаете функцию, значение, которое вы указываете для параметра, присваивается переменная, содержащая имя параметра. Значение этой переменной может быть используется в функции.

В следующем примере показана функция с именем Get-SmallFiles . Эта функция имеет параметр $Size . Функция отображает все файлы, размер которых меньше значение параметра $Size , и он исключает каталоги:

 function Get-SmallFiles {
  Параметр($Размер)
  Get-ChildItem $HOME | Где-Объект {
    $_.Length -lt $Size -и !$_.PSIsContainer
  }
}
 

В функции можно использовать переменную $Size , имя которой определено для параметр.

Чтобы использовать эту функцию, введите следующую команду:

 Get-SmallFiles-Размер 50
 

Вы также можете ввести значение именованного параметра без имени параметра. Например, следующая команда дает тот же результат, что и команда, называет параметр Size :

 Get-SmallFiles 50
 

Чтобы определить значение по умолчанию для параметра, введите знак равенства и значение после имени параметра, как показано в следующем варианте Get-SmallFiles пример:

 функция Get-SmallFiles ($Size = 100) {
  Get-ChildItem $HOME | Где-Объект {
    $_. Length -lt $Size -и !$_.PSIsContainer
  }
}
 

Если ввести Get-SmallFiles без значения, функция присвоит 100 $размер . Если вы предоставляете значение, функция использует это значение.

При желании можно предоставить краткую справочную строку, описывающую настройки по умолчанию. значение вашего параметра, добавив атрибут PSDefaultValue в описание вашего параметра и указание свойства Help PSDefaultValue . Чтобы предоставить строку справки, описывающую значение по умолчанию (100) из Размер в функции Get-SmallFiles добавьте параметр Атрибут PSDefaultValue , как показано в следующем примере.

 функция Get-SmallFiles {
  параметр (
      [PSDefaultValue (Справка = '100')]
      Размер $ = 100
  )
}
 

Дополнительные сведения о классе атрибутов PSDefaultValue см. Члены атрибута PSDefaultValue.

Позиционные параметры

Позиционный параметр — это параметр без имени параметра. PowerShell использует порядок значений параметров, чтобы связать каждое значение параметра с параметром в функция.

При использовании позиционных параметров введите одно или несколько значений после функции имя. Значения позиционных параметров присваиваются переменной массива $args . Значение, следующее за именем функции, присваивается первой позиции в массив $args , $args[0] .

Следующая функция Get-Extension добавляет расширение имени файла .txt к имя файла, которое вы указываете:

 function Get-Extension {
  $имя = $args[0] + ".txt"
  $имя
}
 

 Get-Extension myTextFile
 

 myTextFile.txt
 

Параметры переключателя

Переключатель — это параметр, которому не требуется значение. Вместо этого вы вводите имя функции, за которым следует имя параметра переключателя.

Чтобы определить параметр переключателя, укажите тип [переключатель] перед параметром имя, как показано в следующем примере:

 function Switch-Item {
  параметр ([переключатель]$on)
  если ($on) { "Включить" }
  иначе { "Выключить" }
}
 

При вводе параметра переключателя On после имени функции функция отображает Включить . Без параметра переключения отображается Выключить .

 Элемент включения
 

 Включить
 

 Переключатель
 

 Выключить
 

Вы также можете назначить логическое значение переключателю при запуске функции, как показано в следующем примере:

 Switch-Item -on:$true
 

 Включить
 

 Элемент включения: $false
 

 Выключить
 

Использование разбрызгивания для представления параметров команды

Вы можете использовать разбрызгивание для представления параметров команды. Эта функция представлен в Windows PowerShell 3.0.

Используйте этот метод в функциях, которые вызывают команды в сеансе. Вы не нужно объявить или перечислить параметры команды, или изменить функцию при изменении параметров команды.

Следующий пример функции вызывает Командлет Get-Command . Команда использует @Args для представления параметров Get-Command .

 функция Get-MyCommand { Get-Command @Args }
 

Вы можете использовать все параметры Get-Command при вызове Функция Get-MyCommand . Параметры и значения параметров передаются в команда с использованием @Args .

 Get-MyCommand -Name Get-ChildItem
 

 Имя CommandType Имя модуля
----------- ---- ----------
Командлет Get-ChildItem Microsoft.PowerShell.Management
 

Функция @Args использует автоматический параметр $Args , который представляет необъявленные параметры командлета и значения из оставшихся аргументов.

Для получения дополнительной информации см. about_Splatting.

Конвейер объектов к функциям

Любая функция может получать входные данные из конвейера. Вы можете контролировать, как функция обрабатывает ввод из конвейера с использованием begin , process , end и clean ключевые слова. В следующем образце синтаксиса показаны эти ключевые слова:

 функция <имя> {
  begin {<список операторов>}
  процесс {<список операторов>}
  конец {<список операторов>}
  очистить {<список операторов>}
}
 

Важно

Если ваша функция определяет любой из этих именованных списков операторов, все ваши код должен находиться внутри одного из этих блоков. Любой код вне блоков не является признан. Если ваша функция не использует ни один из этих блоков, все операторы обрабатываются как список операторов и .

begin Список операторов запускается только один раз, в начале функция.

Список операторов процесса запускается один раз для каждого объекта в конвейере. Во время работы блока процесса каждый объект конвейера назначается $_ автоматическая переменная, по одному объекту конвейера за раз.

После того, как функция получит все объекты в конвейере, конец список операторов запускается один раз.

Следующая функция использует процесс ключевое слово. Функция отображает значения из конвейера:

 функция Get-Pipeline
{
  процесс {"Значение: $_"}
}
1,2,4 | Get-Pipeline
 

 Значение: 1
Значение: 2
Значение: 4
 

При использовании функции в конвейере объекты, переданные в функцию, присваивается автоматической переменной $input . Функция запускает операторы с ключевое слово begin до того, как какие-либо объекты поступят из конвейера. Функция запускает операторы с ключевое слово end после получения всех объектов из трубопровода.

В следующем примере показана автоматическая переменная $input с begin и конец ключевых слов.

 функция Get-PipelineBeginEnd
{
    begin {"Начало: ввод $input"}
    end {"Конец: ввод $input" }
}
 

Если эта функция запускается с использованием конвейера, она отображает следующее результаты:

 1,2,4 | Get-PipelineBeginEnd
 

 Начало: ввод
Конец: ввод 1 2 4
 

Когда запускается оператор begin , функция не получает входных данных из трубопровод. Оператор end запускается после того, как функция получит значения.

Если функция имеет ключевое слово process , каждый объект в $input удаляется из $ введите и присвойте $_ . В следующем примере есть процесс список операторов:

 функция Get-PipelineInput
{
    процесс {"Обработка: $_ " }
    end {"Конец: ввод: $input" }
}
 

В этом примере каждый объект, переданный функции, отправляется в обработать список операторов . Операторы процесса выполняются для каждого объекта, по одному объект за раз. Автоматическая переменная $input пуста, когда функция достигает ключевого слова end .

 1,2,4 | Get-PipelineInput
 

 Обработка: 1
Обработка: 2
Обработка: 4
Конец: Вход:
 

Дополнительные сведения см. в разделе Использование перечислителей

PowerShell 7.3 добавил очистить блок . Блок clean — это удобный способ для пользователей, чтобы очистить ресурсы, созданные и используемые в begin , процессе и конец блоков. Это семантически похоже на блок finally , который охватывает все другие именованные блоки функции скрипта или командлета скрипта. Очистка ресурсов применяется для следующих сценариев:

1. , когда выполнение конвейера завершается нормально без ошибки завершения
2. , когда выполнение конвейера прерывается из-за ошибки завершения
3. , когда конвейер остановлен Select-Object -First
4. , когда конвейер останавливается с помощью Ctrl+C или Остановить обработку()

Осторожно

Добавление блока clean является критическим изменением. Поскольку чистый анализируется как ключевое слово, оно не позволяет пользователям напрямую вызывать команду с именем clean как первый оператор в блоке скрипта. Однако вряд ли это будет проблема. Команду по-прежнему можно вызвать с помощью оператора вызова ( и чистый ).

Фильтры

Фильтр — это тип функции, которая выполняется для каждого объекта в конвейере. А filter напоминает функцию со всеми ее операторами в блоке процесса .

Синтаксис фильтра следующий:

 filter [<область:>]<имя> {<список операторов>}
 

Следующий фильтр берет записи журнала из конвейера, а затем отображает либо вся запись, либо только часть сообщения записи:

 фильтр Get-ErrorLog ([switch]$Message)
{
  if ($Message) { Out-Host -InputObject $_.Message}
  иначе {$_}
}
 

Его можно использовать следующим образом:

 Get-WinEvent -LogName System -MaxEvents 100 | Get-ErrorLog-Сообщение
 

Область действия функции

Функция существует в области действия, в которой она создана.

Если функция является частью скрипта, функция доступна для операторов внутри этого скрипта. По умолчанию функция в скрипте недоступна за пределами этого сценария.

Вы можете указать область действия функции. Например, функция добавлена ​​в глобальная область в следующем примере:

 function global:Get-DependentSvs {
  Получить-Сервис | Где-объект {$_.DependentServices}
}
 

Когда функция находится в глобальной области видимости, вы можете использовать эту функцию в сценариях, в функциях и в командной строке.

Функции создают новую область. Элементы, созданные в функции, например переменные существуют только в области видимости функции.

Дополнительные сведения см. в разделе about_Scopes.

Поиск функций и управление ими с помощью функции: Диск

Все функции и фильтры в PowerShell автоматически сохраняются в Функция: привод . Этот диск предоставляется функцией PowerShell . провайдер.

При обращении к диску Функция: введите двоеточие после Функция , просто как если бы вы ссылались на диск C или D компьютера.

Следующая команда отображает все функции в текущем сеансе PowerShell:

 Функция Get-ChildItem:
 

Команды в функции хранятся в виде блока сценария в определении свойство функции. Например, для отображения команд в справке функция, поставляемая с PowerShell, введите:

 (функция Get-ChildItem:help). Определение
 

Вы также можете использовать следующий синтаксис.

 $функция:помощь
 

Для получения дополнительной информации о Функция: привод , см. раздел справки для Функция провайдера. Введите Функция получения справки .

Повторное использование функций в новых сеансах

При вводе функции в командной строке PowerShell она становится часть текущего сеанса. Функция доступна до завершения сеанса.

Чтобы использовать функцию во всех сеансах PowerShell, добавьте ее в Профиль PowerShell. Дополнительные сведения о профилях см. about_Profiles.

Вы также можете сохранить свою функцию в файле сценария PowerShell. Введите свою функцию в текстовом файле, а затем сохраните файл с расширением имени файла .ps1 .

Написание справки для функций

Командлет Get-Help получает справку по функциям, а также по командлетам, провайдеры и скрипты. Чтобы получить справку по функции, введите Get-Help , а затем имя функции.

Например, чтобы получить справку по функции Get-MyDisks , введите:

 Get-Help Get-MyDisks
 

Вы можете написать справку для функции одним из двух следующих способов:

• Справка по функциям на основе комментариев

  Создайте раздел справки, используя специальные ключевые слова в комментариях. Создавать справка для функции на основе комментариев, комментарии должны быть размещены в начало или конец тела функции или строки, предшествующие функции ключевое слово. Дополнительные сведения о справке на основе комментариев см. about_Comment_Based_Help.

• XML-справка по функциям

  Создайте раздел справки на основе XML, такой как тип, который обычно создается для командлеты.