Microsoft Sentinel Alert Rule Templates API

openapi: 3.2.0
info:
  title: Microsoft Sentinel Alert Rule Templates API
  version: '2025-09-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Alert Rule Templates across 2 of this provider''s published API definitions: microsoft-sentinel-securityinsights-2025-09-01.json, microsoft-sentinel-securityinsights-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Alert Rule Templates
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates
  : get:
      operationId: AlertRuleTemplates_List
      tags:
      - Alert Rule Templates
      description: Gets all alert rule templates.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRuleTemplatesList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Get all alert rule templates.:
          $ref: ./examples/alertRuleTemplates/GetAlertRuleTemplates.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Alert rule templates list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}
  : get:
      operationId: AlertRuleTemplates_Get
      tags:
      - Alert Rule Templates
      description: Gets the alert rule template.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      - name: alertRuleTemplateId
        in: path
        description: Alert rule template ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRuleTemplate'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Get alert rule template by Id.:
          $ref: ./examples/alertRuleTemplates/GetAlertRuleTemplateById.json
      summary: Alert rule templates get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    AlertRuleKind:
      type: string
      description: The kind of the alert rule
      enum:
      - Scheduled
      - MicrosoftSecurityIncidentCreation
      - Fusion
      x-ms-enum:
        name: AlertRuleKind
        modelAsString: true
        values:
        - name: Scheduled
          value: Scheduled
          description: Scheduled
        - name: MicrosoftSecurityIncidentCreation
          value: MicrosoftSecurityIncidentCreation
          description: MicrosoftSecurityIncidentCreation
        - name: Fusion
          value: Fusion
          description: Fusion
    CloudErrorBody:
      type: object
      description: Error details.
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          readOnly: true
        message:
          type: string
          description: A message describing the error, intended to be suitable for display in a user interface.
          readOnly: true
    AlertRuleTemplate:
      type: object
      description: Alert rule template.
      properties:
        kind:
          $ref: '#/components/schemas/AlertRuleKind'
          description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.
      discriminator:
        propertyName: kind
      required:
      - kind
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    AlertRuleTemplatesList:
      type: object
      description: List all the alert rule templates.
      properties:
        value:
          type: array
          description: The AlertRuleTemplate items on this page
          items:
            $ref: '#/components/schemas/AlertRuleTemplate'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
          readOnly: true
      required:
      - value
    CloudError:
      type: object
      description: Error response structure.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Error data
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-sentinel-securityinsights-2025-09-01.json
- microsoft-sentinel-securityinsights-openapi.yml