Get command powershell: Get command in PowerShell | Parameters of Get Command with Examples

Get-Help — команда PowerShell | PDQ

  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] -Detailed* [-Functionality ] [-Path ] [-Role ][] 
  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] -Examples* [-Functionality ] [-Path ] [-Role ][] 
  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] [-Full] [-Functionality ] [-Path ] [-Role ][] 
  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] [-Functionality ] -Online* [-Path ] [-Role ][] 
  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] [-Functionality ] -Parameter*  [-Path ] [-Role] [] 
  Get-Help  [[-Name] ] [-Category {Псевдоним | Командлет | Провайдер | Общие | Часто задаваемые вопросы | Глоссарий | Файл справки |Команда-скрипт | Функция | Фильтр | Внешний скрипт | Все | Справка по умолчанию | Рабочий процесс | ДскРесурс | Class |Configuration}] [-Component ] [-Functionality ] [-Path ] [-Role ]-ShowWindow* [] 

Командлет Get-Help отображает информацию о концепциях и командах Windows PowerShell, включая командлеты, функции, команды CIM, рабочие процессы, поставщиков, псевдонимы и сценарии.

Чтобы получить справку по команде Windows PowerShell, введите `Get-Help`, а затем имя команды, например: `Get-Help Get-Process`. Чтобы получить список всех разделов справки по вашей системе, введите `Get-Help *`. Вы можете отобразить весь раздел справки или использовать параметры командлета Get-Help, чтобы получить выбранные части раздела, такие как синтаксис, параметры или примеры.

Концептуальные разделы справки в Windows PowerShell начинаются с «about_», например «about_Comparison_Operators». Чтобы просмотреть все разделы «about_», введите «Get-Help about_*». Чтобы просмотреть конкретную тему, введите «Get-Help about_», например «Get-Help about_Comparison_Operators».

Чтобы получить справку для поставщика Windows PowerShell, введите Get-Help, а затем имя поставщика. Например, чтобы получить справку для поставщика сертификатов, введите «Get-Help Certificate».

В дополнение к `Get-Help`, вы также можете ввести `help` или `man`, что отображает один экран текста за раз, или `-?`, что идентично Get-Help, но работает только для команды. Командлет Get-Help получает отображаемое содержимое справки из файлов справки на вашем компьютере. Без файлов справки Get-Help отображает только основную информацию о командах. Некоторые модули Windows PowerShell поставляются с файлами справки. Однако, начиная с Windows PowerShell 3.0, модули, поставляемые с операционной системой Windows, не включают файлы справки. Чтобы загрузить или обновить файлы справки для модуля в Windows PowerShell 3.0, используйте командлет Update-Help.

Вы также можете просмотреть разделы справки по Windows PowerShell в Интернете в библиотеке TechNet. Чтобы получить онлайн-версию раздела справки, используйте параметр Online, например: `Get-Help Get-Process -Online`. Чтобы прочитать все разделы справки, см. раздел Создание сценариев с помощью Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116) в библиотеке TechNet. .

Если ввести `Get-Help`, за которым следует точное название раздела справки или слово, уникальное для раздела справки, Get-Help отобразит содержимое раздела. Если вы введете слово или шаблон слова, которые появляются в нескольких заголовках разделов справки, Get-Help отобразит список совпадающих заголовков. Если вы введете слово, которого нет ни в одном из заголовков разделов справки, командлет Get-Help отобразит список разделов, в содержание которых входит это слово. Get-Help может получить разделы справки для всех поддерживаемых языков и локалей. Get-Help сначала ищет файлы справки в языковом стандарте, установленном для Windows, затем в родительском языковом стандарте, таком как «pt» для «pt-BR», а затем в резервном языковом стандарте. Начиная с Windows PowerShell 3.0, если командлет Get-Help не находит справку в резервном языковом стандарте, он ищет разделы справки на английском языке «en-US», прежде чем вернуть сообщение об ошибке или отобразить автоматически созданную справку.

Сведения о символах, отображаемых командлетом Get-Help на диаграмме синтаксиса команды, см. в разделе about_Command_Syntax. Сведения об атрибутах параметров, таких как Required и Position , см. в разделе about_Parameters. ПОИСК И УСТРАНЕНИЕ НЕИСПРАВНОСТЕЙ ПРИМЕЧАНИЕ. В Windows PowerShell 3.0 и Windows PowerShell 4.0 командлет Get-Help не может найти темы About в модулях, если модуль не импортирован в текущий сеанс. Это известная проблема. Чтобы получить разделы About в модуле, импортируйте модуль либо с помощью командлета Import-Module, либо запустив командлет в модуле.

Параметры

-Category

  • Значение по умолчанию: Нет
  • Принимает ввод конвейера Ложь 9 0051

Отображает справку только для элементов указанной категории и их псевдонимов. Допустимые значения для этого параметра:

— Псевдоним

— Командлет

— Поставщик

— Общие

— Часто задаваемые вопросы

— Глоссарий

— HelpFile

— ScriptCommand

— Функция

— Фильтр

— ExternalScript

— Все

— DefaultHelp

— Рабочий процесс

— Dsc Ресурс

— Класс

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

Концептуальные разделы находятся в категории HelpFile.

-Component

  • Значение по умолчанию: Нет
  • Принимает ввод конвейера False

Отображает команды с указанным значением компонента, например «Обмен». Введите имя компонента. Подстановочные знаки разрешены.

Этот параметр не влияет на отображение концептуальной («About_») справки.

-Detailed []

  • Это значение требуется
  • Значение по умолчанию False
  • 90 049 Принимает ввод конвейера False

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

Этот параметр действует, только если на компьютере установлены файлы справки для команды. Это не влияет на отображение концептуальной («About_») справки.

-Examples []

  • Это значение требуется
  • Значение по умолчанию False
  • 90 049 Принимает ввод конвейера False

Отображает только название, краткий обзор и примеры . Чтобы отобразить только примеры, введите `(Get-Help ).Examples`.

Этот параметр действует, только если на компьютере установлены файлы справки для команды. Это не влияет на отображение концептуальной («About_») справки.

-Full []

  • Значение по умолчанию: False
  • Принимает ввод конвейера False

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

Этот параметр действует, только если на компьютере установлены файлы справки для команды. Это не влияет на отображение концептуальной («About_») справки.

-Functionality

  • Значение по умолчанию: Нет 59

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

    Этот параметр не влияет на отображение концептуальной («About_») справки.

    -Name

    • Значение по умолчанию: Нет

      Получает справку об указанной команде или понятии. Введите имя командлета, функции, поставщика, скрипта или рабочего процесса, например Get-Member, концептуальное название раздела, например about_Objects, или псевдоним, например ls. Подстановочные знаки разрешены в именах командлетов и поставщиков, но вы не можете использовать подстановочные знаки для поиска имен разделов справки по функциям и сценариям.

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

      Если ввести точное название раздела справки, командлет Get-Help отобразит содержание раздела. Если вы введете слово или шаблон слова, которые появляются в нескольких заголовках разделов справки, Get-Help отобразит список совпадающих заголовков. Если вы введете слово, которое не соответствует ни одному из названий разделов справки, командлет Get-Help отобразит список разделов, в содержании которых есть это слово.

      Названия концептуальных разделов, таких как `about_Objects`, необходимо вводить на английском языке даже в версиях Windows PowerShell, отличных от английского.

      -Online []

      • Это значение является обязательным 49 Принимает входные данные конвейера False

      Отображает онлайн-версию раздела справки в Интернет-браузер по умолчанию. Этот параметр действителен только для разделов справки по командлетам, функциям, рабочим процессам и сценариям. Вы не можете использовать параметр Online в командах Get-Help в удаленном сеансе.

      Сведения о поддержке этой функции в разделах справки, которые вы пишете, см. в разделах about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309) и Supporting Online Help (http://go.microsoft.com). /fwlink/?LinkID=242132) и Как написать справку по командлетуhttp://go.microsoft.com/fwlink/?LinkID=123415 (http://go.microsoft.com/fwlink/?LinkID=123415) в Библиотека Microsoft Developer Network MSDN.

      -Parameter

      • Это значение равно требуется
      • Значение по умолчанию: Нет
      • Принимает ввод конвейера False

      Отображает только подробные описания указанных параметров. Подстановочные знаки разрешены.

      Этот параметр не влияет на отображение концептуальной («About_») справки.

      -Path

      • Значение по умолчанию: Нет
      • Принимает ввод конвейера False

      Получает справку, объясняющую, как работает командлет в указанном пути поставщика. Введите путь поставщика Windows PowerShell.

      Этот параметр получает настроенную версию раздела справки командлета, в котором объясняется, как работает командлет в указанном пути поставщика Windows PowerShell. Этот параметр действует только для справки о командлете поставщика и только в том случае, если поставщик включает пользовательскую версию раздела справки по командлету поставщика в свой файл справки. Чтобы использовать этот параметр, установите файл справки для модуля, в который входит поставщик.

      Чтобы просмотреть справку по пользовательскому командлету для пути поставщика, перейдите к расположению пути поставщика и введите команду Get-Help или из любого расположения пути используйте параметр Path команды Get-Help, чтобы указать путь поставщика. Вы также можете найти справку по пользовательским командлетам в Интернете в разделе справки поставщика в разделах справки. Например, справку по командлету New-Item можно найти по пути Wsman:\*\ClientCertificate (http://go.microsoft.com/fwlink/?LinkID=158676).

      -Роль <Строка[]>

      • Значение по умолчанию: Нет
      • Принимает ввод конвейера False

      Отображает справку, настроенную для указанной роли пользователя. Введите роль. Подстановочные знаки разрешены.

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

      -ShowWindow []

      • Это значение требуется
      • Значение по умолчанию Ложь
      • Принимает входной сигнал конвейера Ложь
      • 90 059

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

        Параметр ShowWindow поддерживает разделы справки для команд, включая командлеты, функции, команды CIM, рабочие процессы и сценарии, а также концептуальные разделы About. Он не поддерживает помощь провайдера.

        Этот параметр появился в Windows PowerShell 3.0.

        Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable и OutVariable.

        Входы

        Никто

        Вы не можете передать объекты этому командлету.

        Выходы

        РасширенныйCmdletHelpInfo

        Если командлет Get-Help запускается для команды, у которой нет файла справки, командлет Get-Help возвращает объект ExtendedCmdletHelpInfo, представляющий автоматически созданную справку. System.String Если вы получаете концептуальный раздел справки, командлет Get-Help возвращает его в виде строки. MamlCommandHelpInfo Если вы получаете команду с файлом справки, командлет Get-Help возвращает объект MamlCommandHelpInfo.

        Примеры
        1. Показать справку о справочной системе:
           PS C:\> Get-Help
           

          Эта команда отображает справку о справочной системе Windows PowerShell.

        2. Показать доступные разделы справки:
           PS C:\> Get-Help *
           

          Эта команда отображает список доступных разделов справки.

        3. Показать основную информацию о командлете:
           PS C:\> Get-Help Get-Alias
          PS C:\> Help Get-Alias
          PS C:\> Get-Alias ​​-?
           

          Эти команды отображают основную информацию о командлете Get-Alias. Get-Help и ? команды отображают информацию на одной странице. Команда Help отображает информацию по одной странице за раз.

        4. Показать список концептуальных тем:
           PS C:\> Get-Help about_*
           

          Эта команда отображает список концептуальных разделов, включенных в справку Windows PowerShell. Все эти темы начинаются с символов about_. Чтобы отобразить определенный файл справки, введите get-help, например, `Get-Help about_Signing`.

          Эта команда отображает концептуальные разделы только в том случае, если файлы справки для этих разделов установлены на компьютере. Сведения о загрузке и установке файлов справки в Windows PowerShell 3.0 см. в разделе Update-Help.

        5. Загрузка и установка файлов справки:
          1. Первая команда использует командлет **Get-Help** для получения справки по командлету Get-Command:
             PS C:\> Get-Help Get-Command
            ИМЯ
                   Get-команда
               СИНТАКСИС
                Get-Command [[-Name] ] [-CommandType {Псевдоним | Функция | Фильтр | Командлет | Внешний скрипт | Приложение
               |
                   Скрипт | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ]
               [<Общие параметры>]
                   Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax]
                   [-TotalCount ] []
               Псевдонимы
                   гсм
               ПРИМЕЧАНИЯ
                   Get-Help не может найти файлы справки для этого командлета на этом компьютере. 
                   Он отображает только частичную справку. Загрузка и установка файлов справки
                   для этого командлета используйте **Update-Help**. 

            Без файлов справки **Get-Help** отображает имя командлета, синтаксис и псевдоним **Get-Command** и предлагает использовать командлет **Update-Help** для получения новейших файлов справки .

          2. Вторая команда запускает командлет **Update-Help** без параметров:
             PS C:\> Update-Help
               Теперь, когда файлы справки загружены, мы можем повторить первую команду в последовательности. Эта команда получает помощь
               для командлета **Get-Command**. Командлет теперь получает более подробную справку по **Get-Command**, и вы можете использовать
               *Detailed*, *Full*, *Example* и *Parameter* параметры **Get-Help** для настройки дисплеев. Вы можете использовать 

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

          3. командлет **Get-Help** сразу после завершения команды **Update-Help**:
             PS C:\> Get-Help Get-Command
             

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

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

            Чтобы загрузить и установить файлы справки для команд, поставляемых с Windows PowerShell, и для любых модулей в каталоге $pshome\Modules, откройте Windows PowerShell с помощью параметра «Запуск от имени администратора». Если вы не являетесь членом группы администраторов на компьютере, вы не сможете загрузить справку по этим модулям. Однако вы можете использовать параметр Online, чтобы открыть онлайн-версию справки для команды, и вы можете прочитать справку по Windows PowerShell в библиотеке TechNet, начиная со страницы Сценарии с помощью Windows PowerShellhttp://go.microsoft.com/fwlink/? LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116).

        6. Показать подробную справку:
           PS C:\> Get-Help ls -Detailed
           

          Эта команда отображает подробную справку для командлета Get-ChildItem, указав один из его псевдонимов, ls. Параметр Detailed командлета Get-Help позволяет получить подробное представление раздела справки, которое включает описания параметров и примеры. Чтобы просмотреть полный раздел справки для командлета, используйте параметр Full.

          Параметры Полный и Подробный действуют только в том случае, если на компьютере установлены файлы справки для команды.

        7. Показать полную информацию для командлета:
           PS C:\> Get-Help Format-Table -Full
           

          Эта команда использует параметр Full команды Get-Help для отображения полной справки для командлета Format-Table. Полный вид справки включает описания параметров, примеры и таблицу технических сведений о параметрах.

          Параметр Полный действует, только если на компьютере установлены файлы справки для команды.

        8. Примеры отображения командлета:
           PS C:\> Get-Help Start-Service - Примеры
           

          Эта команда отображает примеры использования командлета Start-Service. Он использует параметр Examples командлета Get-Help, чтобы отобразить только раздел Examples разделов справки командлета.

          Параметр «Примеры» действует, только если на компьютере установлены файлы справки для команды.

        9. Показать справку по параметрам:
           PS C:\> Get-Help Format-List -Parameter GroupBy
           

          Эта команда использует параметр Parameter командлета Get-Help для отображения подробного описания параметра GroupBy командлета Format-List. Для подробного описания всех параметров командлета Format-List введите Get-Help Format-List -Parameter *.

        10. Поиск слова в справке командлета:
           PS C:\> Get-Help Add-Member -Full | Исходящая строка -поток | Select-String -Pattern Clixml
           

          В этом примере показано, как искать слово в определенном разделе справки командлета. Эта команда ищет слово Clixml в полной версии раздела справки для командлета Add-Member.

          Поскольку командлет Get-Help создает объект MamlCommandHelpInfo, а не строку, необходимо использовать командлет, преобразующий содержимое раздела справки в строку, например Out-String или Out-File.

        11. Показать интерактивную версию справки:
           PS C:\> Get-Help Get-Member -Online
           

          Эта команда отображает интерактивную версию раздела справки для командлета Get-Member.

        12. Показать список тем, содержащих слово:
           PS C:\> Get-Help Remoting
           

          Эта команда отображает список разделов, в которых есть слово удаленное взаимодействие.

          При вводе слова, которого нет ни в одном заголовке темы, Get-Help отображает список тем, в которых есть это слово. 9- Путь SQLSERVER:\DataCollection
          ИМЯ
          Get-Item
          СИНТАКСИС
          Получает коллекцию объектов Server для локального компьютера и любых компьютеров.
          к которому вы установили соединение SQL Server PowerShell.

          Эту команду можно ввести в любом месте пути.

        13. Вторая команда использует командлет Set-Location (псевдоним = «cd») для перехода к пути поставщика:
           PS C:\> cd SQLSERVER:\DataCollection
          SQLSERVER:\DataCollection> Get-Help Get-Item
             ИМЯ
                 Get-Item
             СИНТАКСИС
                 Получает коллекцию объектов Server для локального компьютера и любых компьютеров.
                 к которому вы установили соединение SQL Server PowerShell.
                 ... 

          Из этого расположения, даже без параметра *Path*, команда **Get-Help** получает справку конкретного поставщика для командлета **Get-Item**.

        14. Третья команда показывает, что команда **Get-Help** в пути к файловой системе и без параметра *Path* получает стандартную справку для командлета **Get-Item**:
           PS C:\> Получить-Элемент
             ИМЯ
                 Get-Item
             СИНТАКСИС
                 Получает элемент в указанном месте. 
                 ... 

          В этом примере показано, как получить справку, объясняющую, как использовать командлет Get-Item в узле DataCollection поставщика Windows PowerShellSQL Server. В примере показаны два способа получения справки Get-Item для конкретного поставщика.

          Вы также можете получить справку по командлетам для конкретного поставщика в Интернете в разделе, описывающем поставщика. Например, интерактивную справку для конкретного поставщика для командлета New-Item в каждом пути поставщика WSMan см. в статье New-Item for ClientCertificatehttp://go.microsoft.com/fwlink/?LinkID=158676 в библиотеке TechNet.

      • Показать справку по сценарию:
         PS C:\> Get-Help C:\PS-Test\MyScript.ps1
         

        Эта команда получает справку по сценарию MyScript.ps1. Для получения информации о том, как написать справку для ваших функций и сценариев, см. about_Comment_Based_Help.

      • Дополнительные примечания
         Если параметры не указаны, Get-Help * отображает информацию о справочной системе Windows PowerShell. 
         Windows PowerShell 3.0 не включает файлы справки. Чтобы загрузить и установить файлы справки, которые Get-Help
         читает, используйте командлет Update-Help. Вы можете использовать командлет Update-Help * для загрузки и установки файлов справки для
         основные команды, поставляемые с Windows PowerShell, и для любых устанавливаемых модулей. Вы также можете использовать его
         для обновления файлов справки, чтобы справка на вашем компьютере никогда не устарела.
         Вы также можете прочитать разделы справки о командах, поставляемых с Windows PowerShell, в Интернете, начиная с
         Создание сценариев с помощью Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116
         (http://go.microsoft.com/fwlink/?LinkID=107116). Get-Help отображает справку в языковом стандарте, установленном для Windows.
         операционной системы или на резервном языке для этой локали. Если у вас нет файлов справки для основного или
         резервная локаль Get-Help * ведет себя так, как будто на компьютере нет файлов справки. Чтобы получить помощь по другому
         locale, используйте регион и язык в панели управления, чтобы изменить настройки. 
         * Полный вид справки включает в себя таблицу информации о параметрах. Таблица включает в себя следующее
         поля:
         - Необходимый. Указывает, является ли параметр обязательным (true) или необязательным (false).
         - Позиция. Указывает, является ли параметр именованным или позиционным (нумерованным). Позиционные параметры должны
         появиться в указанном месте в команде.
         ---- «Именованный» означает, что имя параметра является обязательным, но параметр может появиться в любом месте
         команда.
         ---- указывает, что имя параметра является необязательным, но если имя опущено, параметр должен
         находиться в месте, указанном номером. Например, "2" означает, что если имя параметра опущено,
         параметр должен быть вторым (2) или единственным безымянным параметром в команде. Когда имя параметра
         используется, параметр может появиться в любом месте команды.
         - Значение по умолчанию. Значение параметра, используемое Windows PowerShell, если вы не включаете параметр в
         команда.
         - Принимает ввод конвейера. Указывает, можете ли вы (true) или не можете (false) отправлять объекты в параметр
         через трубопровод.  «По имени свойства» означает, что конвейерный объект должен иметь свойство, имеющее такое же значение.
         имя в качестве имени параметра.
         - Принимает подстановочные знаки. Указывает, может ли значение параметра содержать подстановочные знаки,
         такие как * и ?. 

        Эта работа находится под лицензией Creative Commons Attribution 4.0 International. Он приписывается корпорации Microsoft, и его можно найти здесь.

        PowerShell Get-Command с примерами

        Вы хотите найти команду в PowerShell, но не знаете, как это сделать? В этом руководстве показано, как найти другие командлеты с помощью командлета PowerShell Get-Command.

        Виктор Ашиэду | Обновлено 3 марта 2023 г. | 14 минут чтения | 377 чтений

        В первом разделе этого руководства вы получите обзор командлета Get-Command. После этого вы изучите синтаксис командлета Get-Command.

        Затем, в третьем разделе, я объясню параметры Get-Command.

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

        Раздел посвящен ответам на часто задаваемые вопросы о командлете Get-Command.

        • Командлет Connect-AzAccount с примерами
        • Описание глаголов PowerShell: обзор, принцип работы, категории

        Просмотр тем сообщений

        Переключение

        Обзор

        Вы используете Get-Command для возврата всех команд, установленных на вашем компьютере. Кроме того, Get-Command возвращает командлеты, псевдонимы, функции, фильтры, сценарии и приложения.

        Как и все командлеты в PowerShell, Get-Command имеет параметры (подробнее об этом в разделе 3 этого руководства). Если параметр не указан, командлет Get-Command возвращает все командлеты, функции и псевдонимы, установленные на компьютере.

        Еще одна важная информация об этой важной команде PowerShell заключается в том, что она получает не только команды PowerShell. Помимо возврата команд, связанных с PowerShell, Get-Command также получает файлы, не относящиеся к PowerShell.

        В частности, Get-Comand возвращает файлы, определенные в переменной среды Path ( $env:Path ).

        Синтаксис командлета Get-Command

        Командлет Get-Command имеет два синтаксиса. Вот они:

         Get-Command
           [-Глагол <Строка[]>]
           [-Существительное <Строка[]>]
           [-Модуль <Строка[]>]
           [-FullyQualifiedModule ]
           [-TotalCount ]
           [-Синтаксис]
           [-ShowCommandInfo]
           [[-Список_Аргументов] <Объект[]>]
           [-Все]
           [-СписокИмпортированных]
           [-ИмяПараметра <Строка[]>]
           [-ParameterType ]
           [<Общие параметры>] 
         Get-команда
           [[-Имя] <Строка[]>]
           [-Модуль <Строка[]>]
           [-FullyQualifiedModule ]
           [-CommandType <типы команд>]
           [-TotalCount ]
           [-Синтаксис]
           [-ShowCommandInfo]
           [[-Список_Аргументов] <Объект[]>]
           [-Все]
           [-СписокИмпортированных]
           [-ИмяПараметра <Строка[]>]
           [-ParameterType ]
           [-UseFuzzyMatching]
           [-UseAbbreviationExpansion]
           [] 

        Первый синтаксис позволяет вернуть командлет на основе существительного и/или глагола командлета.

        Если вы хотите узнать о глаголе, а теперь и о командлетах PowerShell, прочитайте мой учебник «Введение в командлеты».

        Однако, если вы хотите найти командлет PowerShell по его имени, используйте второй синтаксис.

        Параметры командлета PowerShell Get-Command

        В таблице ниже перечислены и поясняются параметры Get-Command.

        Имя параметра Get-Command PowerShell Get-Command Параметр Значение/Примечания
        Verb Используйте параметр Verb, чтобы указать саму команду, которую вы хотите получить с помощью Get-Command. С этим параметром можно использовать подстановочные знаки.
        Noun Используйте параметр Noun, чтобы указать саму команду, которую вы хотите получить с помощью Get-Command. С этим параметром можно использовать подстановочные знаки.
        Имя При использовании параметра Name можно указать имя командлета, которое требуется вернуть с помощью Get-Command. Вы можете использовать подстановочные знаки с параметром Name, как с параметрами Verb и Noun.
        Модуль Используйте параметр Module командлета PowerShell Get-Command, чтобы указать имя модуля, который должен получить командлет Get-Command. Вы не можете использовать параметры Module и FullyQualifiedModule в одной и той же команде.
        FullyQualifiedModule Когда вы запускаете команду Get-Command, вы можете указать хэш-таблицу, в которой вы определяете, например, имя и версию модуля. Вы можете использовать параметр FullyQualifiedModule, чтобы указать эту хеш-таблицу. Затем команда Get-Command вернет все команды, соответствующие требованиям, указанным в хэш-таблице.
        CommandType Когда вы запускаете команду PowerShell Get-Command, она автоматически возвращает все командлеты, функции и псевдонимы. Если вы хотите вернуть один тип команды, используйте параметр CommandType, чтобы указать тип команды, которую вы хотите вернуть. Параметр CommandType принимает следующие значения: Alias, Application, ExternalScript, Script или Workflow.
        TotalCount Командлет Get-Command может вернуть длинный список команд, установленных на вашем компьютере. Чтобы указать, сколько команд нужно вернуть, используйте параметр TotalCount. Затем укажите числовое значение.
        Синтаксис Если указать параметр Синтаксис команды PowerShell Get-Command, Get-Command возвращает следующую информацию:
        *cmdlet, возвращает синтаксис командлета
        *alias, возвращает стандартное имя командлет с псевдонимом
        *функции и фильтры, он возвращает определение функции.
        *скрипты и приложения или файлы, возвращает путь и имя файла скрипта приложения
        ShowCommandInfo При использовании параметра ShowCommandInfo командлет Get-Command отображает некоторую информацию о команде. В частности, Get-Command отображает имя командлета, имя модуля и CommandType. Не только это, но и Get-Command также вернет параметры и синтаксис команды.
        ArgumentList Если вы хотите, чтобы команда PowerShell Get-Command получала информацию о командлете или функции, когда они используются с указанными параметрами, используйте параметр ArgumentList. В этом случае вы указываете параметры командлета, который хотите вернуть, с помощью параметра ArgumentList командлета Get-Command.
        Все При указании параметра Все команда PowerShell Get-Command возвращает информацию обо всех командах. Использование параметра All заставляет командлет Get-Command включать команды одного типа с одинаковыми именами.
        ListImported Если вы хотите вывести список только командлетов в текущем сеансе PowerShell, укажите параметр ListImported.
        ParameterName Хотите получить командлеты с определенным параметром? Используйте параметр ParameterName команды Get-Command, чтобы указать параметр.
        ParameterType Если вы хотите вывести список всех командлетов с определенным типом параметра, используйте параметр ParameterType команды PowerShell Get-Command, чтобы указать параметр параметра. Некоторыми распространенными типами параметров являются String, Switch, Int, DateTime.
        *UseFuzzyMatching Этот параметр переключателя делает команду Get-Command значимой. Иногда вы не уверены в названии нужного вам командлета. Когда вы указываете параметр UseFuzzyMatching PowerShell Get-Command и вводите некоторые буквы искомого командлета, Get-Command возвращает командлеты, близкие к введенным вами буквам.
        *UseAbbreviationExpansion При указании этого параметра переключателя Get-Command сопоставляет символы в вашей команде, чтобы найти командлет, эквивалентный верхнему регистру. Например, «Get-Command r-i -UseAbbreviationExpansion» вернет Remove-Item и Rename-Item «r-i» соответствует «R» (верхний регистр) и «I» (верхний регистр) в R emove- I tem и R эмаль- I тем.
        Этот параметр полезен для поиска командлетов, части букв которых вы помните.

        *Эти параметры недоступны в PowerShell версии 5. Я не уверен, в какой версии Microsoft представил этот параметр. Но я могу подтвердить, что они доступны в PowerShell версии 7.2.4.

        Примеры Get-Command

        Итак, вы узнали о синтаксисе и параметрах командлета Get-Command. В этом разделе вы познакомитесь с различными примерами и приложениями этого крайне важного командлета.

        Как найти псевдоним PowerShell Get-Command

        Вы можете использовать команду Get-Alias, чтобы найти псевдоним любого командлета PowerShell.

        Итак, чтобы найти псевдоним PowerShell Get-Command, используйте приведенную ниже команду.

         Get-Alias ​​-Definition Get-Command 

        Вот результат выполнения команды в PowerShell. В соответствии с результатом приведенной выше команды псевдоним Get-Command — gcm.

        Как использовать Get-Command и Get-Help для изучения командлетов PowerShell

        Двумя наиболее важными командлетами PowerShell являются командлеты Get-Command и Get-Help. Эти два командлета важны, потому что вы используете их, чтобы узнать о других параметрах.

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

        На ум приходит слово «удалить». Имея это в виду, я буду использовать Get-Command, чтобы найти полный командлет.

        Вот команда, которая выполнит эту работу.

         Get-Command *Remove* 

        К сожалению, это возвращает длинный список командлетов. Однако при просмотре списка я вижу командлет под названием Remove-Item.

        Если я новичок в PowerShell и не уверен, что это правильный командлет, я могу использовать команду Get-Help для проверки. Вот основная команда, которая даст мне некоторую информацию о Remove-Item.

         Get-Help Remove-Item 

        Результат последней команды подтверждает, что Remove-Item «Удаляет указанные элементы». Итак, это определенно командлет, который я ищу.

        Хотя я знаю, что могу использовать Remove-Item для удаления файлов или папок. Но как мне использовать команду?

        Get-Help также предоставляет эту информацию.

        На последнем снимке экрана есть раздел «СИНТАКСИС». В этом разделе рассказывается, как использовать команду, в том числе как использовать ее параметры.

        Хотя раздел синтаксиса Get-Help содержит некоторую полезную информацию, он может сбить с толку новичков. Однако у Get-Help есть еще одна информация (из множества предлагаемых), которая может оказаться полезной.

        При запуске Get-Help с его 9Параметр 0050 Examples PowerShell отображает примеры использования командлета, о котором вы изучаете.

        Например, чтобы отобразить несколько примеров использования командлета Remove-Item, выполните приведенную ниже команду.

         Get-Help Remove-Item -Examples 

        Как использовать Get-Command для поиска командлетов по глаголу или существительному

        Как вы могли заметить в разделах о синтаксисе и параметрах этого руководства, командлет Get-Command имеет два параметра: Глагол и Существительное .

        Эти параметры можно использовать для поиска командлетов по глаголу или существительному. Например, чтобы получить список всех командлетов с глаголом «Получить», я выполню приведенную ниже команду.

         Get-Command -Verb Get 

        Как и следовало ожидать, последняя команда возвращает очень длинный список.

        Однако вы можете сократить список, указав существительное (или используя подстановочный знак для указания некоторых букв) нужного вам командлета.

        Вот пример, который возвращает все командлеты с глаголом «Get» и содержит буквы «dns» в существительном.

         Get-Command -Verb Get -Noun *dns* 

        Я также могу уменьшить количество командлетов, удалив звездочку перед «dns». Таким образом, PowerShell возвращает только командлеты, имя существительного которых начинается с «dns».

         Get-Command -Verb Get -Noun dns* 

        Как использовать Get-Command для получения информации о объекте Where-Object

        Чтобы получить список основных сведений о командлете с PowerShell Get-Command, запустите Get-Command без каких-либо параметров . Например, чтобы получить основную информацию о командлете Where-Object, я выполню следующую команду:

         Get-Command Where-Object 

        Последняя команда сообщает нам, что Where-Object — это командлет, и текущая версия командлета на моем компьютере — 3.0.0.0. В дополнение к этой информации команда также сообщает модулю Where-Object.

        Согласитесь, информация, предоставленная последней командой, не очень полезна. Например, поскольку он не показывает мне все возможные варианты синтаксиса команды Where-Object, я выполню следующую команду:

         Get-Command Where-Object -ShowCommandInfo 

        Дополнительные сведения о параметре ShowCommandInfo команды Get-Command см. в разделе параметров данного руководства.

        Самая важная информация, отображаемая последней командой, — это все возможные варианты синтаксиса команды Where-Object.

        Как фильтровать результаты PowerShell Get-Command по имени или источнику

        До сих пор я показывал вам, как использовать Get-Command для поиска командлетов с различными подходами. В одном из приведенных выше примеров используются параметры Verb и Noun командлета Get-Command для фильтрации командлетов.

        Помимо использования параметров Verb и Noun команды Get-Command для фильтрации командлетов, вы также можете использовать команду Where-Object для фильтрации командлетов по имени, источнику и другим свойствам.

        В моем первом примере я передам Get-Command в Where-Object. Затем я буду использовать Where-Object для возврата команды с определенным именем.

        В частности, приведенная ниже команда возвращает команду Get-ChildItem.

         Команда Get | Где-Объект -Имя свойства -EQ "Get-ChildItem" 

        В другом примере я сейчас покажу вам, как вы можете фильтровать команды по источнику, используя PowerShell Get-Command и Where-Object.

        Вот пример…

         Get-Command | Where-Object -Property Source -EQ "Dism" 

        Последняя команда отображает все командлеты в модуле Dism (источник).

        Часто задаваемые вопросы

        1. Как вы отображаете командлеты в PowerShell?

        Чтобы отобразить все командлеты в PowerShell, выполните команду Get-Command.

        2. Что делает команда Get-Alias?

        Команда Get-Alias ​​перечисляет доступные псевдонимы для командлетов PowerShell на вашем компьютере.

        3. Как запустить командлет?

        Чтобы запустить командлет, откройте PowerShell; затем, если вы знаете синтаксис командлета, введите командлет, а затем его параметры. Наконец, нажмите клавишу Enter на клавиатуре, чтобы запустить командлет.

        В качестве альтернативы, если вы знаете командлет, который хотите запустить, но не знаете его синтаксис, запустите «Get-Help cmdlet_name», чтобы получить его. Вы также можете запустить «Get-Help cmdlet_name -Examples», чтобы просмотреть список примеров использования командлета.

        4. Что такое Get-Member в PowerShell?

        Командлет Get-Member получает свойства и методы объектов в PowerShell.

        Если вы хотите изучить свойства и методы команды PowerShell, передайте выходные данные этой команды командлету Get-Member.

        5. Как запустить PowerShell?

        Чтобы запустить PowerShell, выполните поиск «PowerShell» (без кавычек). Затем откройте «Windows PowerShell» из результатов поиска.

        Мои последние мысли

        Командлет Get-Command, пожалуй, самый важный для изучения. Я говорю это, потому что вы можете использовать его для поиска командлетов, необходимых для выполнения задач с помощью PowerShell.

        В этом руководстве вы прочитали обзор PowerShell Get-Command. В руководстве также рассматриваются синтаксис, параметры и некоторые примеры этого крайне важного командлета PowerShell.

        Надеюсь, что благодаря знаниям, которые вы получили из этой статьи, мне удалось направить вас на правильный путь к изучению Windows PowerShell! Не могли бы вы уделить 2 минуты, чтобы поделиться своим путешествием по PowerShell в сообществе Itechguides?

        Помимо того, что вы можете поделиться своим мнением об этой статье, вы также можете задать вопрос о PowerShell Get-Command в сообществе Itechguides.