Create and customize Microsoft Sentinel playbooks from built-in templates

Note

Azure Sentinel is now called Microsoft Sentinel, and we’ll be updating these pages in the coming weeks. Learn more about recent Microsoft security enhancements.

Important

Playbook templates are currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

A playbook template is a pre-built, tested, and ready-to-use workflow that can be customized to meet your needs. Templates can also serve as a reference for best practices when developing playbooks from scratch, or as inspiration for new automation scenarios.

Playbook templates are not active playbooks themselves, until you create a playbook (an editable copy of the template) from them.

Many playbook templates have been developed by the Microsoft Sentinel community, independent software vendors (ISVs), and Microsoft's own experts, based on popular automation scenarios used by security operations centers around the world.

You can get playbook templates from the following sources:

  • The Playbook templates tab (under Automation) presents the leading scenarios contributed by the Microsoft Sentinel community. Multiple active playbooks can be created from the same template.

    When a new version of the template is published, the active playbooks created from that template (in the Playbooks tab) will be labeled with a notification that an update is available.

  • Playbook templates can also be obtained as part of a Microsoft Sentinel solution in the context of a specific product. The deployment of the solution produces active playbooks.

  • The Microsoft Sentinel GitHub repository contains many playbook templates. They can be deployed to an Azure subscription by selecting the Deploy to Azure button.

Technically, a playbook template is an Azure Resource Manager (ARM) template which consists of several resources: an Azure Logic Apps workflow and API connections for each connection involved.

This article focuses on deploying a playbook template from the Playbook templates tab under Automation.

This article helps you understand how to:

  • Explore out-of-the-box playbook templates
  • Deploy a playbook template

Explore playbook templates

From the Microsoft Sentinel navigation menu, select Automation and then the Playbooks templates tab.

The playbook templates displayed here demonstrate leading automation scenarios that SOCs tend to use or get ideas from. Most of these playbooks were contributed by the Microsoft Sentinel community, and were originally located in Microsoft Sentinel GitHub repository. Some of these have been integrated into Microsoft Sentinel Solutions.

Screenshot of the playbooks gallery.

To find a playbook template that fits your requirements, you can filter the list by the following criteria:

  • Trigger indicates the playbook is triggered by incident creation (and can therefore be attached to an automation rule), by alert creation (and can therefore be attached to an analytics rule), or by something else. Learn more

  • Logic Apps connectors shows the external services this playbook will interact with. During the deployment process, each connector will need to assume an identity to authenticate to the external service.

  • Entities shows the entity types explicitly filtered and parsed by a playbook that expects to find those entity types in the incident. For example, a playbook that tells a firewall to block an IP address will expect to operate on incidents created by analytics rules that generate alerts containing IP addresses, such as a Brute Force attack detection rule.

  • Tags show labels applied to the playbook to relate it to a specific scenario, or to indicate a special characteristic.

    Examples:

    • Enrichment - The playbook fetches information from another service to add information to an incident. This information is usually added as a comment to the incident or sent to the SOC.

    • Remediation - The playbook takes an action on the affected entities to eliminate a potential threat.

    • Sync - The playbook helps to keep an external service, such as an incident management service, updated with the incident's properties.

    • Notification - The playbook sends an email or message.

    • Response from Teams - The playbook allows the analysts to take a manual action from Teams using interactive cards.

Filter the list of playbook templates

Customize a playbook from a template

This procedure describes how to deploy playbook templates.

You can repeat this process to create multiple playbooks on the same template.

  1. Select a playbook name from the Playbook templates tab.

  2. If the playbook has any prerequisites, make sure to follow the instructions.

    • Some playbooks will call other playbooks as actions. This second playbook is referred to as a nested playbook. In such a case, one of the prerequisites will be to first deploy the nested playbook.

    • Some playbooks will require deploying a custom Logic Apps connector or an Azure Function. In such cases, there will be a Deploy to Azure link that will take you to the general ARM template deployment process.

  3. Select Create playbook to open the playbook creation wizard based on the selected template. The wizard has four tabs:

    • Basics: Locate your new playbook (Logic Apps resource) and give it a name (can use default). Playbook creation wizard, basics tab

    • Parameters: Enter customer-specific values that playbook will use. For example, if this playbook will send an email to the SOC, you can define the recipient address here. This tab will be shown only if the playbook has parameters.

      Note

      If this playbook has a custom connector in use, it should be deployed in the same resource group, and you will be able to insert its name in this tab.

      Playbook creation wizard, parameters tab

    • Connections: Expand each action to see the existing connections you created for previous playbooks. Learn more about creating connections for playbooks.

      Note

      For custom connectors, connections will be displayed by the name of the custom connector entered in the Parameters tab.

      Playbook creation wizard. connections tab

      If there aren't any, or if you want to create new ones, choose Create new connection after deployment. This will take you to the Logic Apps designer after the deployment process is completed.

      For connectors that support connecting with managed identity, such as Microsoft Sentinel, this will be the connection method selected by default.

    • Review and Create: View a summary of the process and await validation of your input before creating the playbook.

  4. After following the steps in the playbook creation wizard to the end, you will be taken to the new playbook's workflow design in the Logic Apps designer.

    See playbook in Logic Apps designer

  5. For each connector you chose to create a new connection for after deployment:

    1. From the navigation menu, select API connections.
    2. Select the connection name.
    3. Select Edit API connection from the navigation menu.
    4. Fill in the required parameters and click Save. Screenshot showing how to edit A P I connections.

    Alternatively, you can create a new connection from within the relevant steps in the Logic Apps designer:

    1. For each step which appears with an error sign, select it to expand.
    2. Select Add new.
    3. Authenticate according to the relevant instructions.
    4. If there are other steps using this same connector, expand their boxes. From the list of connections that appears, select the connection you just created.
  6. If you have chosen to use a managed identity connection for Microsoft Sentinel (or for other supported connections), grant permissions to the new playbook on the Microsoft Sentinel workspace (or on the relevant target resources for other connectors).

  7. Save the playbook. You'll now be able to see it in the Active Playbooks tab.

  8. To run this playbook, set an automated response or run manually (alert trigger only).

  9. Most of the templates can be used as is, but we recommend making any adjustments required to fit the new playbook to your SOC needs.

Troubleshooting

Issue: Found a bug in the playbook

To report a bug or request an improvement for a playbook, select the Supported by link in the playbook's details pane. If this is a community-supported playbook, the link will take you to open a GitHub issue. Otherwise, you will be directed to the supporter's page.

Next steps

In this article, you learned how to work with playbook templates, creating and customizing playbooks to fit your needs. Learn more about playbooks and automation in Microsoft Sentinel: