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

Unregister-Event

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

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

Синтаксис

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

Описание

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

При отмене подписки на событие подписчик удаляется из сеанса, а события, на которые была оформлена подписка, больше не добавляются в очередь событий. При отмене подписки на событие, созданное с помощью командлета 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
Aliases:cf
Position:Named
значение по умолчанию:False
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Тип:SwitchParameter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

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

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

Тип:String
Position:0
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

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

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

Тип:Int32
Position:0
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Тип:SwitchParameter
Aliases:wi
Position:Named
значение по умолчанию:False
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

PSEventSubscriber

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

Выходные данные

None

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

Примечания

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

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