Unregister-Event (Microsoft.PowerShell.Utility)

Unregister-Event

Модуль:: Microsoft.PowerShell.Utility

Отменяет подписку на событие.

Синтаксис

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Unregister-Event
          [-SubscriptionId] <Int32>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Описание

Командлет Unregister-Event отменяет подписку на событие, созданную с помощью Register-EngineEvent, Register-ObjectEvent или Register- Командлет WmiEvent.

При отмене подписки на событие подписчик событий удаляется из сеанса, а подписанные события больше не добавляются в очередь событий. При отмене подписки на событие, созданное с помощью командлета New-Event, новое событие также удаляется из сеанса.

Unregister-Event не удаляет события из очереди событий. Чтобы удалить события, используйте командлет Remove-Event.

Примеры

Пример 1. Отмена подписки на событие по идентификатору источника

Эта команда отменяет подписку на события с идентификатором источника ProcessStarted.

Unregister-Event -SourceIdentifier "ProcessStarted"

Чтобы найти идентификатор источника события, используйте командлет Get-Event. Чтобы найти идентификатор источника подписки на событие, используйте командлет Get-EventSubscriber.

Пример 2. Отмена подписки на событие по идентификатору подписки

Эта команда отменяет подписку на события с идентификатором подписки 2.

Unregister-Event -SubscriptionId 2

Чтобы найти идентификатор подписки на событие, используйте командлет Get-EventSubscriber.

Пример 3. Отмена всех подписок на мероприятия

В этом примере отменяются все подписки на события в сеансе.

Get-EventSubscriber -Force | Unregister-Event -Force

Использование параметра Force с Get-EventSubscriber позволяет получить все объекты подписчиков событий в сеансе, включая скрытых подписчиков. Вывод передается в Unregister-Event, который удаляет подписчиков из сеанса. Параметр Force необходим для Unregister-Event, чтобы удалить всех скрытых подписчиков.

Параметры

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип :: SwitchParameter
Псевдонимы:: cf
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Force

Отменяет все подписки на события, включая подписки, которые были скрыты с помощью параметра SupportEvent в Register-ObjectEvent, Register-WmiEvent и Register. -EngineEvent.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-SourceIdentifier

Указывает идентификатор источника, по которому этот командлет отменяет подписки на события.

Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.

Тип :: String
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-SubscriptionId

Указывает идентификатор идентификатора источника, по которому этот командлет отменяет подписки на события.

Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.

Тип :: Int32
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-WhatIf

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

Тип :: SwitchParameter
Псевдонимы:: wi
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

PSEventSubscriber

Вы можете передать выходные данные Get-EventSubscriber в этот командлет.

Выходы

Нет

Этот командлет не возвращает никаких результатов.

Примечания

На платформах Linux или macOS нет источников событий.

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

Unregister-Event не может удалять события, созданные с помощью командлета New-Event, если вы не подписались на событие с помощью командлета Register-EngineEvent. Чтобы удалить пользовательское событие из сеанса, необходимо удалить его программным способом или закрыть сеанс.