Unregister-Event
Отменяет подписку на событие.
Синтаксис
BySource (по умолчанию)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
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
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Отменяет все подписки на события, включая те, которые были скрыты с помощью параметра SupportEvent в Register-ObjectEvent, Register-WmiEventи Register-EngineEvent.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SourceIdentifier
Указывает исходный идентификатор, с помощью которого этот командлет отменяет подписки на события.
Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
BySource
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-SubscriptionId
Указывает идентификатор источника, для которого этот командлет отменяет подписки на события.
Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.
Свойства параметра
| Тип: | Int32 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ById
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-WhatIf
Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
PSEventSubscriber
Выходные данные из Get-EventSubscriber можно передать в этот командлет.
Выходные данные
None
Этот командлет не возвращает выходные данные.
Примечания
На платформах Linux или macOS нет источников событий.
События, подписки на события и очередь событий существуют только в текущем сеансе. При закрытии текущего сеанса очередь событий удаляется, а подписка на события отменяется.
Unregister-Event не удается удалить события, созданные с помощью командлета New-Event, если вы не подписаны на событие с помощью командлета Register-EngineEvent. Чтобы удалить пользовательское событие из сеанса, необходимо удалить его программным способом или закрыть сеанс.
