Skip to content

Commit 8406b38

Browse files
committed
Added last two troubleshooting cases
1 parent 6fa59c2 commit 8406b38

File tree

3 files changed

+30
-48
lines changed

3 files changed

+30
-48
lines changed

articles/sentinel/automate-incident-handling-with-automation-rules.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,15 @@ You can [create and manage automation rules](create-manage-use-automation-rules.
351351

352352
You'll notice that when you create an automation rule from here, the **Create new automation rule** panel has populated all the fields with values from the incident. It names the rule the same name as the incident, applies it to the analytics rule that generated the incident, and uses all the available entities in the incident as conditions of the rule. It also suggests a suppression (closing) action by default, and suggests an expiration date for the rule. You can add or remove conditions and actions, and change the expiration date, as you wish.
353353

354+
### Export and import automation rules (Preview)
355+
356+
Export your automation rules to Azure Resource Manager (ARM) template files, and import rules from these files, as part of managing and controlling your Microsoft Sentinel deployments as code. The export action will create a JSON file in your browser's downloads location, that you can then rename, move, and otherwise handle like any other file.
357+
358+
The exported JSON file is workspace-independent, so it can be imported to other workspaces and even other tenants. As code, it can also be version-controlled, updated, and deployed in a managed CI/CD framework.
359+
360+
The file includes all the parameters defined in the automation rule. Rules of any trigger type can be exported to a JSON file.
361+
362+
For instructions on exporting and importing automation rules, see [Export and import Microsoft Sentinel automation rules](import-export-automation-rules.md).
354363

355364
## Next steps
356365

articles/sentinel/import-export-automation-rules.md

Lines changed: 10 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -53,43 +53,16 @@ The file includes all the parameters defined in the automation rule. Rules of an
5353
5454
## Troubleshooting
5555

56-
- **Analytics rule doesn't exist:** If you export an automation rule [based on a particular analytics rule](create-manage-use-automation-rules.md#define-conditions), and then import it to another workspace that doesn't have that same analytics rule in it, the following things will happen:
57-
- The automation rule will successfully deploy in the second workspace.
58-
- The automation rule will be automatically disabled.
59-
- In the automation rule conditions, the analytics rule drop-down will display as "Unknown rule".
60-
61-
To allow this automation rule to run in the second workspace:
62-
1. Export the referenced analytics rule from the original workspace and import it to the second one.
63-
1. Edit the automation rule in the second workspace, choosing the now-present analytics rule from the drop-down.
64-
1. Enable the automation rule.
65-
66-
- **Custom details key doesn't exist:** If you export an automation rule with conditions that reference [custom details keys](create-manage-use-automation-rules.md#conditions-based-on-custom-details), and then import it to another workspace where no analytics rules [surface those custom details](surface-custom-details-in-alerts.md), the following things will happen:
67-
- The automation rule will successfully deploy in the second workspace.
68-
- The automation rule will be automatically disabled.
69-
- In the automation rule conditions, the custom details key drop-down will display as "Unknown custom details key".
70-
71-
To allow this automation rule to run in the second workspace:
72-
1. Import or create an analytics rule that will [surface the relevant custom details](surface-custom-details-in-alerts.md) in the second workspace.
73-
1. Edit the automation rule in the second workspace, choosing the now-present custom details from the drop-down.
74-
1. Enable the automation rule.
75-
76-
- **Playbook doesn't exist:** If you export an automation rule that calls a playbook, and then import it to another workspace that doesn't have access to the playbook, or if the playbook was moved or deleted, the automation rule deployment will fail, and you'll receive an error message with the specific reason.
77-
78-
To allow this automation rule to deploy properly when imported, make sure that the playbook exists and that the second workspace has access to the resource group that contains the playbook.
79-
80-
- **Expired automation rule:** If an automation rule is past its expiration date when imported, the automation rule deployment will fail and you'll receive an error message.
81-
82-
To allow this automation rule to deploy properly when imported, choose **one** of the following procedures, depending on the relevant circumstances:
83-
84-
- **If you don't mind the automation rule running in the original workspace:**
85-
1. Edit the automation rule in the original workspace and change its expiration date to a date in the future.
86-
1. Export the rule again from the original workspace.
87-
1. Import the newly exported version into the second workspace.
88-
89-
- **If you don't want the rule to run again in the original workspace:**
90-
1. Edit the JSON file that represents the exported automation rule.
91-
1. Find the expiration date (that appears immediately after the string `"expirationTimeUtc":`) and replace it with a date in the future.
92-
1. Save the file and re-import it into the second workspace.
56+
If you have any issues importing an exported automation rule, consult the following table.
57+
58+
| Behavior (with *error*) | Reason | Suggested action |
59+
| ----------------------- | ------ | ---------------- |
60+
| **Imported automation rule is disabled**<br>-*and*-<br>**The rule's *analytics rule* condition displays "Unknown rule"** | The rule contains a condition that refers to an analytics rule that doesn't exist in the target workspace. | <ol><li>Export the referenced analytics rule from the original workspace and import it to the target one.<li>Edit the automation rule in the target workspace, choosing the now-present analytics rule from the drop-down.<li>Enable the automation rule.</ol> |
61+
| **Imported automation rule is disabled**<br>-*and*-<br>**The rule's *custom details key* condition displays "Unknown custom details key"** | The rule contains a condition that refers to a [custom details key](surface-custom-details-in-alerts.md) that isn't defined in any analytics rules in the target workspace. | <ol><li>Export the referenced analytics rule from the original workspace and import it to the target one.<li>Edit the automation rule in the target workspace, choosing the now-present analytics rule from the drop-down.<li>Enable the automation rule. |
62+
| **Deployment failed in target workspace, with error message: "\<PLEASE SUPPLY>"** | The playbook was moved.<br>-*or*-<br>The playbook was deleted.<br>-*or*-<br>The target workspace doesn't have access to the playbook. | Make sure the playbook exists, and that the target workspace has the right access to the resource group that contains the playbook. |
63+
| **Deployment failed in target workspace, with error message: "\<PLEASE SUPPLY>"** | The automation rule was past its defined expiration date when you imported it. | **If you want the rule to remain expired in its original workspace:**<ol><li>Edit the JSON file that represents the exported automation rule.<li>Find the expiration date (that appears immediately after the string `"expirationTimeUtc":`) and replace it with a new expiration date (in the future).<li>Save the file and re-import it into the target workspace.</ol>**If you want the rule to return to active status in its original workspace:**<ol><li>Edit the automation rule in the original workspace and change its expiration date to a date in the future.<li>Export the rule again from the original workspace.<li>Import the newly exported version into the target workspace.</ol> |
64+
| **Deployment failed in target workspace, with error message: "The JSON file you attempted to import has an invalid format. Please check the file and try again."** | The imported file isn't a valid JSON file. | Check the file for problems and try again. For best results, export the original rule again to a new file, then try the import again. |
65+
| **Deployment failed in target workspace, with error message: "No resources found in the file. Please ensure the file contains deployment resources and try again."** | The list of resources under the "resources" key in the JSON file is empty. | Check the file for problems and try again. For best results, export the original rule again to a new file, then try the import again. |
9366

9467
## Next steps
9568

articles/sentinel/whats-new.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,20 @@ The listed features were released in the last three months. For information abou
2020

2121
## August 2024
2222

23+
- [Export and import automation rules (Preview)](#export-and-import-automation-rules-preview)
2324
- [New Auxiliary logs retention plan (Preview)](#new-auxiliary-logs-retention-plan-preview)
2425
- [Create summary rules for large sets of data (Preview)](#create-summary-rules-in-microsoft-sentinel-for-large-sets-of-data-preview)
2526

27+
### Export and import automation rules (Preview)
28+
29+
You can now export your automation rules to Azure Resource Manager (ARM) template files, and import rules from these files, as part of managing and controlling your Microsoft Sentinel deployments as code. The export action will create a JSON file in your browser's downloads location, that you can then rename, move, and otherwise handle like any other file.
30+
31+
The exported JSON file is workspace-independent, so it can be imported to other workspaces and even other tenants. As code, it can also be version-controlled, updated, and deployed in a managed CI/CD framework.
32+
33+
The file includes all the parameters defined in the automation rule. Rules of any trigger type can be exported to a JSON file.
34+
35+
Learn more about [exporting and importing automation rules](import-export-automation-rules.md).
36+
2637
### New Auxiliary logs retention plan (Preview)
2738

2839
The new **Auxiliary logs** retention plan for Log Analytics tables allows you to ingest large quantities of high-volume logs with supplemental value for security at a much lower cost. Auxiliary logs are available with interactive retention for 30 days, in which you can run simple, single-table queries on them, such as to summarize and aggregate the data. Following that 30-day period, auxiliary log data goes to long-term retention, which you can define for up to 12 years, at ultra-low cost. This plan also allows you to run search jobs on the data in long-term retention, extracting only the records you want to a new table that you can treat like a regular Log Analytics table, with full query capabilities.
@@ -83,20 +94,9 @@ Microsoft Sentinel is now generally available within the Microsoft unified secur
8394

8495
## June 2024
8596

86-
- [Export and import automation rules (Preview)](#export-and-import-automation-rules-preview)
8797
- [Codeless Connector Platform now generally available](#codeless-connector-platform-now-generally-available)
8898
- [Advanced threat indicator search capability available](#advanced-threat-indicator-search-capability-available)
8999

90-
### Export and import automation rules (Preview)
91-
92-
You can now export your automation rules to Azure Resource Manager (ARM) template files, and import rules from these files, as part of managing and controlling your Microsoft Sentinel deployments as code. The export action will create a JSON file in your browser's downloads location, that you can then rename, move, and otherwise handle like any other file.
93-
94-
The exported JSON file is workspace-independent, so it can be imported to other workspaces and even other tenants. As code, it can also be version-controlled, updated, and deployed in a managed CI/CD framework.
95-
96-
The file includes all the parameters defined in the automation rule. Rules of any trigger type can be exported to a JSON file.
97-
98-
Learn more about [exporting and importing automation rules](import-export-automation-rules.md).
99-
100100
### Codeless Connector Platform now generally available
101101

102102
The Codeless Connector Platform (CCP), is now generally available (GA). Check out the [announcement blog post](https://techcommunity.microsoft.com/t5/microsoft-sentinel-blog/what-s-new-create-your-own-codeless-data-connector/ba-p/4174439).

0 commit comments

Comments
 (0)