Register-ObjectEvent

Microsoft .NET Framework 개체에서 생성된 이벤트를 구독합니다.

구문

Register-ObjectEvent
        [-InputObject] <PSObject>
        [-EventName] <String>
        [[-SourceIdentifier] <String>]
        [[-Action] <ScriptBlock>]
        [-MessageData <PSObject>]
        [-SupportEvent]
        [-Forward]
        [-MaxTriggerCount <Int32>]
        [<CommonParameters>]

Description

cmdlet은 Register-ObjectEvent 로컬 컴퓨터 또는 원격 컴퓨터에서 .NET 개체에 의해 생성되는 이벤트를 구독합니다.

구독된 이벤트가 발생하면 세션의 이벤트 큐에 추가됩니다. 이벤트 큐에서 이벤트를 얻으려면 cmdlet을 Get-Event 사용합니다.

매개 변수를 사용하여 큐에서 Register-ObjectEvent 이벤트를 식별하는 데 도움이 될 수 있는 이벤트의 속성 값을 지정할 수 있습니다. Action 매개 변수를 사용하여 구독 이벤트가 발생할 때 수행할 작업과 로컬 세션의 이벤트 큐에 원격 이벤트를 보내는 Forward 매개 변수를 지정할 수도 있습니다.

이벤트를 구독하면 이벤트 구독자가 세션에 추가됩니다. 세션에서 이벤트 구독자를 얻으려면 cmdlet을 Get-EventSubscriber 사용합니다. 구독을 취소하려면 세션에서 이벤트 구독자를 삭제하는 cmdlet을 사용합니다 Unregister-Event .

예제

예제 1: 새 프로세스가 시작될 때 이벤트 구독

이 예제에서는 새 프로세스가 시작될 때 생성된 이벤트를 구독합니다.

이 명령은 ManagementEventWatcher 개체를 사용하여 EventArrived 이벤트를 가져옵니다. 쿼리 개체는 이벤트가 Win32_Process 클래스에 대한 인스턴스 생성 이벤트임을 지정합니다.

$queryParameters = '__InstanceCreationEvent', (New-Object TimeSpan 0,0,1),
    "TargetInstance isa 'Win32_Process'"
$Query = New-Object System.Management.WqlEventQuery -ArgumentList $queryParameters
$ProcessWatcher = New-Object System.Management.ManagementEventWatcher $Query
Register-ObjectEvent -InputObject $ProcessWatcher -EventName "EventArrived"

예제 2: 이벤트에 응답하는 작업 지정

작업을 지정하면 발생한 이벤트가 이벤트 큐에 추가되지 않습니다. 대신 동작이 이벤트에 응답합니다. 이 예제에서는 새 프로세스가 시작되었음을 나타내는 인스턴스 만들기 이벤트가 발생하면 새 ProcessCreated 이벤트가 발생합니다.

$queryParameters = '__InstanceCreationEvent', (New-Object TimeSpan 0,0,1),
    "TargetInstance isa 'Win32_Process'"
$Query = New-Object System.Management.WqlEventQuery -ArgumentList $queryParameters
$ProcessWatcher = New-Object System.Management.ManagementEventWatcher $query
$newEventArgs = @{
    SourceIdentifier = 'PowerShell.ProcessCreated'
    Sender = $Sender
    EventArguments = $EventArgs.NewEvent.TargetInstance
}
$Action = { New-Event @newEventArgs }
Register-ObjectEvent -InputObject $ProcessWatcher -EventName "EventArrived" -Action $Action

Id   Name               PSJobTypeName   State       HasMoreData   Location   Command
--   ----               -------------   -----       -----------   --------   -------
 5   3db2d67a-efff-...                 NotStarted   False                    New-Event @newEventArgs

이 작업은 이벤트 동작에 $Sender 대해서만 채워진 자동 변수와 $EventArgs 자동 변수를 사용합니다.

Register-ObjectEvent 명령은 백그라운드 작업으로 실행되는 작업을 나타내는 작업 개체를 반환합니다. 작업 cmdlet(예: Get-JobReceive-Job)을 사용하여 백그라운드 작업을 관리할 수 있습니다. 자세한 내용은 about_Jobs 참조하세요.

예제 3: 원격 컴퓨터에서 개체 이벤트 구독

이 예제에서는 원격 컴퓨터의 개체 이벤트에 가입하는 방법을 보여 줍니다. 이 예제에서는 스크립트 파일에 정의된 함수를 ProcessCreationEvent.ps1 사용합니다Enable-ProcessCreationEvent. 이 스크립트는 예제의 모든 컴퓨터에서 사용할 수 있습니다.

# ProcessCreationEvent.ps1
function  Enable-ProcessCreationEvent {
    $queryParameters = "__InstanceCreationEvent", (New-Object TimeSpan 0,0,1),
        "TargetInstance isa 'Win32_Process'"
    $Query = New-Object System.Management.WqlEventQuery -ArgumentList $queryParameters

    $objectEventArgs = @{
        Input = New-Object System.Management.ManagementEventWatcher $Query
        EventName = 'EventArrived'
        SourceIdentifier = 'WMI.ProcessCreated'
        MessageData = 'Test'
        Forward = $True
    }
    Register-ObjectEvent @objectEventArgs
}

$S = New-PSSession -ComputerName "Server01, Server02"
Invoke-Command -Session $S -FilePath ProcessCreationEvent.ps1
Invoke-Command -Session $S { Enable-ProcessCreationEvent }

먼저 두 원격 컴퓨터에 PSSessions를 만들고 변수에 $S 저장합니다. 다음으로, cmdlet은 Invoke-Command 의 각 PSSessions에서 $S스크립트를 실행 ProcessCreationEvent.ps1 합니다. 이 작업은 원격 세션에서 함수를 만듭니다 Enable-ProcessCreationEvent . 마지막으로 원격 세션에서 함수를 실행 Enable-ProcessCreationEvent 합니다.

이 함수에는 ManagementEventWatcher 개체 및 EventArrived 이벤트를 통해 Win32_Process 개체의 인스턴스 생성 이벤트를 구독하는 명령이 포함 Register-ObjectEvent 됩니다.

예제 4: PSEventJob 개체에서 동적 모듈 사용

이 예제에서는 이벤트 등록에 Action을 포함할 때 생성되는 PSEventJob 개체에서 동적 모듈을 사용하는 방법을 보여 줍니다. 먼저 타이머 개체를 만들고 사용하도록 설정한 다음 타이머 간격을 500(밀리초)으로 설정합니다. cmdlet은 Register-ObjectEvent 타이머 개체의 경과된 이벤트를 등록합니다. PSEventJob 개체는 변수에 $Job 저장되며 이벤트 구독자의 Action 속성에서도 사용할 수 있습니다. 자세한 내용은 Get-EventSubscriber를 참조 하세요.

타이머 간격이 경과할 때마다 이벤트가 발생하고 작업이 실행됩니다. 이 경우 cmdlet은 Get-Random 0에서 100 사이의 난수를 생성하고 변수에 $Random 저장합니다.

$Timer = New-Object Timers.Timer
$Timer.Interval = 500
$Timer.Enabled = $True
$objectEventArgs = @{
    InputObject = $Timer
    EventName = 'Elapsed'
    SourceIdentifier = 'Timer.Random'
    Action = {$Random = Get-Random -Min 0 -Max 100}
}
$Job = Register-ObjectEvent @objectEventArgs
$Job | Format-List -Property *
& $Job.module {$Random}
& $Job.module {$Random}

State         : Running
Module        : __DynamicModule_53113769-31f2-42dc-830b-8749325e28d6
StatusMessage :
HasMoreData   : True
Location      :
Command       : $Random = Get-Random -Min 0 -Max 100
JobStateInfo  : Running
Finished      : System.Threading.ManualResetEvent
InstanceId    : 47b5ec9f-bfe3-4605-860a-4674e5d44ca8
Id            : 7
Name          : Timer.Random
ChildJobs     : {}
PSBeginTime   : 6/27/2019 10:19:06 AM
PSEndTime     :
PSJobTypeName :
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}
60
47

PSEventJob에는 작업을 구현하는 동적 스크립트 모듈이 포함된 Module 속성이 있습니다. 호출 연산자(&)를 사용하여 모듈에서 명령을 호출하여 변수 값을 $Random 표시합니다.

모듈에 대한 자세한 내용은 about_Modules 참조하세요.

매개 변수

-Action

이벤트를 처리할 명령을 지정합니다. 이벤트의 명령은 이벤트를 이벤트 큐로 보내는 대신 이벤트가 발생할 때 실행됩니다. 명령을 중괄호({ })로 묶어 스크립트 블록을 만듭니다.

Action 매개 변수의 값에는 , $EventSubscriber, $Sender$EventArgs$Args 자동 변수가 포함될 $Event수 있습니다. 이러한 변수는 동작 스크립트 블록에 이벤트에 대한 정보를 제공합니다. 자세한 내용은 about_Automatic_Variables를 참조하세요.

작업을 지정하면 해당 동작 Register-ObjectEvent 을 나타내는 이벤트 작업 개체를 반환합니다. 작업 cmdlet을 사용하여 이벤트 작업을 관리할 수 있습니다.

형식:ScriptBlock
Position:101
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-EventName

구독할 이벤트를 지정합니다.

이 매개 변수의 값은 .NET 개체가 노출하는 이벤트의 이름이어야 합니다. 예를 들어 ManagementEventWatcher 클래스에는 EventArrived 및 Stopped라는 이벤트가 있습니다. 이벤트의 이벤트 이름을 찾으려면 cmdlet을 Get-Member 사용합니다.

형식:String
Position:1
Default value:None
필수:True
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-Forward

cmdlet이 이 구독에 대한 이벤트를 원격 세션으로 보내도록 나타냅니다. 원격 컴퓨터 또는 원격 세션에서 이벤트를 등록할 때 이 매개 변수를 사용합니다.

형식:SwitchParameter
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-InputObject

이벤트를 생성하는 .NET 개체를 지정합니다. 개체가 포함된 변수를 입력하거나 개체를 가져오는 명령이나 식을 입력합니다.

형식:PSObject
Position:0
Default value:None
필수:True
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-MaxTriggerCount

이벤트를 트리거할 수 있는 최대 횟수를 지정합니다.

형식:Int32
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-MessageData

이 이벤트 구독에 연결할 추가 데이터를 지정합니다. 이 매개 변수의 값은 이 구독과 연결된 모든 이벤트의 MessageData 속성에 나타납니다.

형식:PSObject
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-SourceIdentifier

구독에 대해 선택한 이름을 지정합니다. 선택한 이름은 현재 세션에서 고유해야 합니다. 기본값은 PowerShell에서 할당하는 GUID입니다.

이 매개 변수의 값은 구독자 개체의 SourceIdentifier 속성 값과 이 구독과 연결된 모든 이벤트 개체에 나타납니다.

형식:String
Position:100
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-SupportEvent

cmdlet이 이벤트 구독을 숨기고 있음을 나타냅니다. 현재 구독이 더 복잡한 이벤트 등록 메커니즘의 일부이며 독립적으로 검색해서는 안 되는 경우 이 매개 변수를 사용합니다.

SupportEvent 매개 변수를 사용하여 만든 구독을 보거나 취소하려면 및 Unregister-Event cmdlet의 Force 매개 변수를 Get-EventSubscriber 사용합니다.

형식:SwitchParameter
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

입력

None

개체를 이 cmdlet으로 파이프할 수 없습니다.

출력

None

기본적으로 이 cmdlet은 출력을 반환하지 않습니다.

PSEventJob

Action 매개 변수를 사용하는 경우 이 cmdlet은 PSEventJob 개체를 반환합니다.

참고

이벤트, 이벤트 구독 및 이벤트 큐는 현재 세션에만 존재합니다. 현재 세션을 닫으면 이벤트 큐가 삭제되고 이벤트 구독이 취소됩니다.