Change Auditor 7.5 - User Guide

Get-CASentinelEventSubscriptions

Get-CASentinelEventSubscriptions

Use this command to see the details of the current Microsoft Sentinel subscriptions.

Table 22. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command. See the Change Auditor PowerShell Command Guide for details.
-SubscriptionId (optional)	The ID of an existing Microsoft Sentinel subscription. If specified, the command will only return the Microsoft Sentinel subscription with that ID. If not specified, all Microsoft Sentinel subscriptions are returned.

Example: Get a list of all Microsoft Sentinel subscriptions

Get-CASentinelEventSubscriptions -Connection $connection

Command output

The command returns the following information.

Table 23. Available configuration information

Setting	Description
Id	The subscription ID.
WebhookSubscriptionId	The webhook subscription ID.
StartTimeUTC	Starting point in time for events being sent.
Subsystems	Subsystems that contain the event data being sent.
Enabled	Whether the subscription is enabled.
HeartbeatUrl	URL for heartbeat notifications.
LastEventTimeUTC	When the last event was sent.
LastEventResponse	Last event response.
LastHeartbeatTimeUTC	When the last heartbeat was sent.
LastHeartbeatResponse	The last heartbeat response. For example, statusCode = OK (200), statusCode = Bad Request (400), or statusCode = Internal Server Error (500).
EventsSent	Number of events sent.
BatchesSent	Number of batches sent.
HeartbeatsSent	Number of heartbeats sent.
NotificationInterval	How often how often (in milliseconds) notifications are sent.
HeartbeatInterval	How often (in milliseconds) heartbeat notifications are sent.
BatchSize	Batch size. (The maximum number of events that the active batch size can increase to.)
ActiveBatchSize	The current batch size. (The current number of events to include in a single notification message.) The batch size is automatically adjusted based on network throughput and system performance. Its value never exceeds the specified batch size.
AllowedCoordinators	List of coordinators permitted to send events or heartbeat notifications.
LastCoordinator	The last coordinator to send events or modify the subscription.
IncludeO365AADDetails	Identifies whether or not the additionalDetails field with the raw JSON string is included for Microsoft 365 and Microsoft Entra ID events. When set to true, the event will include fields prefixed with additionalDetails, containing the values from the raw JSON string for Microsoft 365 and Microsoft Entra ID events. When set to false, the additionalDetails field is not included.

Set-CASentinelEventSubscription

Set-CASentinelEventSubscription

Use this command to modify a Microsoft Sentinel subscription

 

Table 2. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command. See the Change Auditor PowerShell Command Guide for details.
-Subscription	The PSCASyslogEventSubscriptionStatus object that corresponds to the subscription to modify. This parameter is required if the SubscriptionId parameter is not specified.
-SubscriptionId	The ID of the subscription to modify. This parameter is required if the Subscription parameter is not specified. Use the Get-CASentinelEventSubscriptions command to find the ID.
-Subsystems (Optional)	Specifies an array of event subsystems from which to send events. This can be single or multiple subsystems. NOTE:   • To obtain an array of subsystems, use the Get-CAEventExportSubsystems command and filter the list to specify the required subsystems.
-WorkspaceID (Optional)	The unique identifier for the Log Analytics workspace that has been enabled for Microsoft Sentinel.
-SecretKey (Optional)	The primary or secondary key for the Log Analytics workspace that has been enabled for Microsoft Sentinel.
-BatchSize (Optional)	Specifies the maximum number of events to include in a single notification. The maximum is 6500 events.
-Enabled (Optional)	Specifies whether the subscription is enabled or disabled.
-NotificationInterval (Optional)	Specifies how often (in milliseconds) notifications are sent to Microsoft Sentinel. Setting to 0 results in a continuous stream of events.
-HeartbeatInterval (Optional)	Specifies how often (in milliseconds) heartbeat notifications are sent to the Heartbeat URL. Heartbeat notifications are sent to the Heartbeat_ChangeAuditor_CL log in Microsoft Sentinel where you can query and alert on them if required. Setting this to 0 disables the heartbeat message if enabled.
-AllowedCoordinators (Optional)	Specifies the DNS or NetBIOS name of the coordinators permitted to send events. If you specify a null or empty array, any coordinator can send the results. NOTE: The list order does not determine which coordinator is selected to send events.
-IncludeO365AADDetails (Optional)	Specifies whether to include the raw JSON event details provided by Microsoft. When set to true, the event will include fields prefixed with additionalDetails, containing the values from the raw JSON string for Microsoft 365 and Microsoft Entra ID events. When set to false, the additionalDetails field is not included.

Example: Set a new batch size value for a Microsoft Sentinel subscription

Set-CASentinelEventSubscription -Connection $connection -SubscriptionId $subscriptionId -BatchSize $newIntValue

Remove-CASentinelEventSubscription

Remove-CASentinelEventSubscription

Use this command to remove a subscription.

Table 24. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command. See the Change Auditor Command Guide for details.
-Subscription	The PSCASentinelEventSubscriptionStatus object obtained using Get-CASentinelEventSubscriptions that corresponds to the subscription to remove. This parameter is required if the SubscriptionId parameter is not specified.
-SubscriptionId	The ID of the subscription to remove. This parameter is required if the Subscription parameter is not specified. Use the Get-CASentinelEventSubscriptions command to find the ID.

Example: Remove a subscription

Remove-CASentinelEventSubscription -Subscription $subscription

Microsoft Sentinel event subscription wizard

Microsoft Sentinel event subscription wizard

From the Event Subscription Wizard you can add and edit a Microsoft Sentinel subscription.

NOTE:   • Optional subscription settings can be set through PowerShell, see Set-CASentinelEventSubscription. • The Workspace ID and the secret keys (Primary and Secondary) can be found in Settings on the Agents management page for the Log Analytics workspace configured for Microsoft Sentinel (Microsoft Entra admin center).

To create a subscription

1	Click Add | Microsoft Sentinel subscription to open the wizard.

2	Specify the Workspace ID for the Log Analytics workspace that has been enabled for Microsoft Sentinel.

3	Specify the secret key for the Log Analytics workspace that has been enabled for Microsoft Sentinel.

4	Click Next to select the events to forward based on subsystem and event date.

▪	By default, events start sending after the subscription is created. To change when to begin collecting and sending events, click Send events starting from and select the desired date and time.

▪	Select the subsystems to include in the subscription.

5	Click Finish.

To edit the subscription

1	Select the required subscription and click Edit.

2	If required, enter the new Workspace ID or secret key and click Next.

3	If required, add and remove the subsystems included in the subscription.

4	Click Finish.