Unregister-Event
Отменяет подписку на событие.
Синтаксис
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. Отмена подписки на события по исходному идентификатору
PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"
Эта команда отменяет подписку на события с идентификатором источника ProcessStarted.
Чтобы найти идентификатор источника события, используйте Get-Event
командлет . Чтобы найти исходный идентификатор подписки на события, используйте Get-EventSubscriber
командлет .
Пример 2. Отмена подписки на события по идентификатору подписки
PS C:\> Unregister-Event -SubscriptionId 2
Эта команда отменяет подписку на событие с идентификатором подписки 2.
Чтобы найти идентификатор подписки на события, используйте Get-EventSubscriber
командлет .
Пример 3. Отмена всех подписок на события
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
Эта команда отменяет все подписки на события в рамках сеанса.
Команда использует Get-EventSubscriber
командлет для получения всех объектов подписчиков событий в сеансе, включая подписчиков, скрытых с помощью параметра SupportEvent командлетов регистрации событий.
Он использует оператор конвейера (|
) для отправки объектов подписчика в Unregister-Event
, который удаляет их из сеанса. Для выполнения задачи также требуется параметр Force в Unregister-Event
.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Отменяет все подписки на события, включая подписки, которые были скрыты с помощью параметра Register-ObjectEvent
SupportEvent , Register-WmiEvent
и Register-EngineEvent
.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
Указывает идентификатор источника, который этот командлет отменяет подписки на события.
Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
Указывает идентификатор исходного идентификатора, который этот командлет отменяет подписки на события.
Параметр SourceIdentifier или SubscriptionId должен быть включен в каждую команду.
Type: | Int32 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Вы можете передать выходные данные из Get-EventSubscriber
в Unregister-Event
.
Выходные данные
None
Этот командлет не возвращает никакие выходные данные.
Примечания
Нет источников событий, доступных на платформах Linux или macOS.
События, подписки на события и очередь событий существуют только в текущем сеансе. Если закрыть текущий сеанс, очередь событий удаляется, а подписка на событие отменяется.
Unregister-Event
невозможно удалить события, созданные с помощью командлета New-Event
, если вы не подписаны на событие с помощью командлета Register-EngineEvent
. Чтобы удалить из сеанса настраиваемое событие, используйте программный способ или закройте сеанс.