Отменяет подписку на событие.
Синтаксис
Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Описание
Командлет Unregister-Event отменяет подписку на событие, созданную с помощью командлета Register-EngineEvent, Register-ObjectEvent или Register-WmiEvent.
При отмене подписки на событие подписчик удаляется из сеанса, а соответствующие события больше не добавляются в очередь событий. Если отменить подписку на событие, созданную с помощью командлета New-Event, новое событие также удаляется из сеанса.
Командлет Unregister-Event не удаляет события из очереди событий. Для удаления событий используется командлет Remove-Event.
Параметры
-Force
Отменяет все подписки, включая подписки, которые были скрыты с помощью параметра SupportEvent командлетов Register-ObjectEvent, Register-WmiEvent и Register-EngineEvent.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
|
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
-SourceIdentifier <string>
Отменяет подписки на события, имеющие заданный идентификатор источника.
В каждую команду необходимо включать параметр SourceIdentifier или SubscriptionId.
|
Обязательно? |
true |
|
Позиция? |
1 |
|
Значение по умолчанию |
|
|
Принимать входные данные из конвейера? |
true (ByPropertyName) |
|
Принимать подстановочные знаки? |
false |
-SubscriptionId <int>
Отменяет подписки на события, имеющие заданный идентификатор подписки.
В каждую команду необходимо включать параметр SourceIdentifier или SubscriptionId.
|
Обязательно? |
true |
|
Позиция? |
1 |
|
Значение по умолчанию |
|
|
Принимать входные данные из конвейера? |
true (ByPropertyName) |
|
Принимать подстановочные знаки? |
false |
-Confirm
Запрашивает подтверждение перед выполнением команды.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
|
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
-WhatIf
Описывает, что произойдет при выполнении команды, без ее фактического выполнения.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
|
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
<CommonParameters>
Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.
Ввод и вывод
Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.
|
Входные данные |
System.Management.Automation.PSEventSubscriber Выходные данные командлета Get-EventSubscriber можно передать командлету Unregister-Event по конвейеру. |
|
Выходные данные |
Нет Этот командлет не возвращает никаких выходных данных. |
Примечания
События, подписки на события и очередь событий существуют только в рамках текущего сеанса. Если завершить текущий сеанс, очередь событий будет очищена и подписка на события будет отменена.
Командлет Unregister-Event не позволяет удалять события, созданные с помощью командлета New-Event, если только подписка на событие не была создана с помощью командлета Register-EngineEvent. Чтобы удалить из сеанса пользовательское событие, необходимо удалить его программным путем или закрыть сеанс.
Пример 1
C:\PS>unregister-event -sourceIdentifier ProcessStarted Описание ----------- Эта команда отменяет подписку на событие, имеющее идентификатор источника "ProcessStarted". Чтобы определить идентификатор источника события, используйте командлет Get-Event. Чтобы определить идентификатор подписки на событие, используйте командлет Get-EventSubscriber.
Пример 2
C:\PS>unregister-event -subscriptionId 2 Описание ----------- Эта команда отменяет подписку на событие, имеющее идентификатор подписки, равный 2. Чтобы определить идентификатор подписки на событие, используйте командлет Get-EventSubscriber.
Пример 3
C:\PS>get-eventsubscriber -force | unregister-event -force Описание ----------- Эта команда отменяет все подписки в сеансе. Эта команда использует командлет Get-EventSubscriber, чтобы получить все объекты подписчиков на события в сеансе, включая подписчики, которые были скрыты с помощью параметра SupportEvent командлетов регистрации событий. С помощью оператора конвейера (|) объекты подписок передаются командлету Unregister-Event, который удаляет их из сеанса. Для завершения процедуры командлет Unregister-Event необходимо указывать с параметром Force.
См. также