Microsoft Azure Action Groups API

swagger: '2.0'
info:
  title: Microsoft Azure Azure Action Groups API
  x-ms-code-generation-settings:
    name: MonitorManagementClient
  version: '2022-06-01'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}
  : put:
      description: Create a new action group or update an existing one.
      operationId: microsoftAzureActiongroupsCreateorupdate
      x-ms-examples:
        Create or update an action group:
          $ref: ./examples/createOrUpdateActionGroup.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - name: actionGroup
          in: body
          required: true
          schema:
            $ref: '#/definitions/ActionGroupResource'
          description: The action group to create or use for the update.
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: An existing action group was successfully updated.
          schema:
            $ref: '#/definitions/ActionGroupResource'
        '201':
          description: A new action group was successfully created.
          schema:
            $ref: '#/definitions/ActionGroupResource'
        default:
          description: >-
            An error occurred and the action group could not be created or
            updated.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname
      tags:
        - Subscriptions
    get:
      description: Get an action group.
      operationId: microsoftAzureActiongroupsGet
      x-ms-examples:
        Get an action group:
          $ref: ./examples/getActionGroup.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request succeeded.
          schema:
            $ref: '#/definitions/ActionGroupResource'
        default:
          description: >-
            An error occurred and the action group could not be retrieved. 404:
            The action group does not exist.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname
      tags:
        - Subscriptions
    delete:
      description: Delete an action group.
      operationId: microsoftAzureActiongroupsDelete
      x-ms-examples:
        Delete an action group:
          $ref: ./examples/deleteActionGroup.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The action group was successfully deleted.
        '204':
          description: The action group does not exist. It may have already been deleted.
        default:
          description: An error occurred and the action group could not be deleted.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname
      tags:
        - Subscriptions
    patch:
      description: >-
        Updates an existing action group's tags. To update other fields use the
        CreateOrUpdate method.
      operationId: microsoftAzureActiongroupsUpdate
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - name: actionGroupPatch
          in: body
          required: true
          schema:
            $ref: '#/definitions/ActionGroupPatchBody'
          description: Parameters supplied to the operation.
      responses:
        '200':
          description: An existing action group was successfully updated.
          schema:
            $ref: '#/definitions/ActionGroupResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Patch an action group:
          $ref: ./examples/patchActionGroup.json
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications:
    post:
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Send test notifications to a set of provided receivers
      operationId: microsoftAzureActiongroupsPosttestnotifications
      x-ms-examples:
        Create notifications at subscription level:
          $ref: ./examples/postTestNotifications.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - name: notificationRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/NotificationRequestBody'
          description: The notification request body which includes the contact details
      responses:
        '200':
          description: The notification succeeded
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        '202':
          description: The notification request accepted
          headers:
            location:
              type: string
              description: The location header that has the polling uri.
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Insights Createnotifications
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/createNotifications:
    post:
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Send test notifications to a set of provided receivers
      operationId: microsoftAzureActiongroupsCreatenotificationsatresourcegrouplevel
      x-ms-examples:
        Create notifications at resource group level:
          $ref: ./examples/postTestNotificationsAtResourceGroupLevel.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - name: notificationRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/NotificationRequestBody'
          description: The notification request body which includes the contact details
      responses:
        '200':
          description: The notification succeeded
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        '202':
          description: The notification request accepted
          headers:
            location:
              type: string
              description: The location header that has the polling uri.
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Createnotifications
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/createNotifications
  : post:
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Send test notifications to a set of provided receivers
      operationId: microsoftAzureActiongroupsCreatenotificationsatactiongroupresourcelevel
      x-ms-examples:
        Create notifications at resource group level:
          $ref: ./examples/postTestNotificationsAtActionGroupResourceLevel.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - name: notificationRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/NotificationRequestBody'
          description: The notification request body which includes the contact details
      responses:
        '200':
          description: The notification succeeded
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        '202':
          description: The notification request accepted
          headers:
            location:
              type: string
              description: The location header that has the polling uri.
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Createnotifications
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/notificationStatus/{notificationId}:
    get:
      description: Get the test notifications by the notification id
      operationId: microsoftAzureActiongroupsGettestnotifications
      x-ms-examples:
        Get notification details at subscription level:
          $ref: ./examples/getTestNotifications.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: '#/parameters/NotificationIdParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The notification details
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Notificationstatus Notificationid
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/notificationStatus/{notificationId}
  : get:
      description: Get the test notifications by the notification id
      operationId: microsoftAzureActiongroupsGettestnotificationsatresourcegrouplevel
      x-ms-examples:
        Get notification details at resource group level:
          $ref: ./examples/getTestNotificationsAtResourceGroupLevel.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/NotificationIdParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The notification details
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Notificationstatus Notificationid
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/notificationStatus/{notificationId}
  : get:
      description: Get the test notifications by the notification id
      operationId: microsoftAzureActiongroupsGettestnotificationsatactiongroupresourcelevel
      x-ms-examples:
        Get notification details at resource group level:
          $ref: ./examples/getTestNotificationsAtActionGroupResourceLevel.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - $ref: '#/parameters/NotificationIdParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The notification details
          schema:
            $ref: '#/definitions/TestNotificationDetailsResponse'
        default:
          description: An error occurred while sending the test notifications
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Notificationstatus Notificationid
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/actionGroups:
    get:
      description: Get a list of all action groups in a subscription.
      operationId: microsoftAzureActiongroupsListbysubscriptionid
      x-ms-examples:
        List action groups at subscription level:
          $ref: ./examples/listActionGroups.json
      x-ms-pageable:
        nextLinkName:
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request succeeded.
          schema:
            $ref: '#/definitions/ActionGroupList'
        default:
          description: >-
            An error occurred and the list of action groups could not be
            retrieved.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Actiongroups
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups:
    get:
      description: Get a list of all action groups in a resource group.
      operationId: microsoftAzureActiongroupsListbyresourcegroup
      x-ms-examples:
        List action groups at resource group level:
          $ref: ./examples/listActionGroups.json
      x-ms-pageable:
        nextLinkName:
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request succeeded.
          schema:
            $ref: '#/definitions/ActionGroupList'
        default:
          description: >-
            An error occurred and the list of action groups could not be
            retrieved.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/subscribe
  : post:
      description: >-
        Enable a receiver in an action group. This changes the receiver's status
        from Disabled to Enabled. This operation is only supported for Email or
        SMS receivers.
      operationId: microsoftAzureActiongroupsEnablereceiver
      x-ms-examples:
        Enable the receiver:
          $ref: ./examples/enableReceiver.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - $ref: '#/parameters/ActionGroupNameParameter'
        - name: enableRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/EnableRequest'
          description: The receiver to re-enable.
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The receiver was successfully enabled.
        '409':
          description: The receiver is already enabled in the action group.
          x-ms-error-response: true
        default:
          description: >-
            An error occurred and the receiver could not be enabled, e.g.: 404:
            The action group was not found or no matching receiver was found in
            the action group.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Subscribe
      tags:
        - Subscriptions
definitions:
  AzureResource:
    properties:
      id:
        type: string
        readOnly: true
        description: Azure resource Id
      name:
        type: string
        readOnly: true
        description: Azure resource name
      type:
        type: string
        readOnly: true
        description: Azure resource type
      location:
        type: string
        description: Resource location
        x-ms-mutability:
          - create
          - read
      tags:
        additionalProperties:
          type: string
        type: object
        description: Resource tags
    required:
      - location
    type: object
    x-ms-azure-resource: true
    description: An azure resource object
  TestNotificationDetailsResponse:
    description: The details of the test notification results.
    type: object
    properties:
      context:
        type: object
        $ref: '#/definitions/Context'
      state:
        type: string
        description: The overall state
      completedTime:
        type: string
        description: The completed time
      createdTime:
        type: string
        description: The created time
      actionDetails:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ActionDetail'
        description: The list of action detail
    required:
      - state
  ActionDetail:
    description: The action detail
    type: object
    properties:
      MechanismType:
        type: string
        description: The mechanism type
      Name:
        type: string
        description: The name of the action
      Status:
        type: string
        description: The status of the action
      SubState:
        type: string
        description: The substatus of the action
      SendTime:
        type: string
        description: The send time
      Detail:
        type: string
        description: The detail of the friendly error message
  Context:
    description: The context info
    type: object
    properties:
      notificationSource:
        type: string
        description: The source of the notification request
      contextType:
        type: string
        description: The context id type
  ActionGroupResource:
    description: An action group resource.
    type: object
    allOf:
      - $ref: '#/definitions/AzureResource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ActionGroup'
        description: The action groups properties of the resource.
  ActionGroupList:
    description: A list of action groups.
    type: object
    properties:
      value:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ActionGroupResource'
        description: The list of action groups.
      nextLink:
        type: string
        description: Provides the link to retrieve the next set of elements.
  NotificationRequestBody:
    description: The request body which contain contact detail metadata
    type: object
    properties:
      alertType:
        type: string
        maxLength: 30
        description: >-
          The value of the supported alert type. Supported alert type values
          are: servicehealth, metricstaticthreshold, metricsdynamicthreshold,
          logalertv2, smartalert, webtestalert, logalertv1numresult,
          logalertv1metricmeasurement, resourcehealth, activitylog,
          actualcostbudget, forecastedbudget
      emailReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/EmailReceiver'
        description: The list of email receivers that are part of this action group.
      smsReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/SmsReceiver'
        description: The list of SMS receivers that are part of this action group.
      webhookReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/WebhookReceiver'
        description: The list of webhook receivers that are part of this action group.
      itsmReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ItsmReceiver'
        description: The list of ITSM receivers that are part of this action group.
      azureAppPushReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AzureAppPushReceiver'
        description: The list of AzureAppPush receivers that are part of this action group.
      automationRunbookReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AutomationRunbookReceiver'
        description: >-
          The list of AutomationRunbook receivers that are part of this action
          group.
      voiceReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/VoiceReceiver'
        description: The list of voice receivers that are part of this action group.
      logicAppReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/LogicAppReceiver'
        description: The list of logic app receivers that are part of this action group.
      azureFunctionReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AzureFunctionReceiver'
        description: >-
          The list of azure function receivers that are part of this action
          group.
      armRoleReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ArmRoleReceiver'
        description: >-
          The list of ARM role receivers that are part of this action group.
          Roles are Azure RBAC roles and only built-in roles are supported.
      eventHubReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/EventHubReceiver'
        description: The list of event hub receivers that are part of this action group.
    required:
      - alertType
  ActionGroup:
    description: An Azure action group.
    type: object
    properties:
      groupShortName:
        type: string
        maxLength: 12
        description: The short name of the action group. This will be used in SMS messages.
      enabled:
        type: boolean
        default: true
        description: >-
          Indicates whether this action group is enabled. If an action group is
          not enabled, then none of its receivers will receive communications.
      emailReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/EmailReceiver'
        description: The list of email receivers that are part of this action group.
      smsReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/SmsReceiver'
        description: The list of SMS receivers that are part of this action group.
      webhookReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/WebhookReceiver'
        description: The list of webhook receivers that are part of this action group.
      itsmReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ItsmReceiver'
        description: The list of ITSM receivers that are part of this action group.
      azureAppPushReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AzureAppPushReceiver'
        description: The list of AzureAppPush receivers that are part of this action group.
      automationRunbookReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AutomationRunbookReceiver'
        description: >-
          The list of AutomationRunbook receivers that are part of this action
          group.
      voiceReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/VoiceReceiver'
        description: The list of voice receivers that are part of this action group.
      logicAppReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/LogicAppReceiver'
        description: The list of logic app receivers that are part of this action group.
      azureFunctionReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/AzureFunctionReceiver'
        description: >-
          The list of azure function receivers that are part of this action
          group.
      armRoleReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/ArmRoleReceiver'
        description: >-
          The list of ARM role receivers that are part of this action group.
          Roles are Azure RBAC roles and only built-in roles are supported.
      eventHubReceivers:
        x-ms-identifiers: []
        type: array
        items:
          $ref: '#/definitions/EventHubReceiver'
        description: The list of event hub receivers that are part of this action group.
    required:
      - groupShortName
      - enabled
  EmailReceiver:
    description: An email receiver.
    type: object
    properties:
      name:
        type: string
        description: >-
          The name of the email receiver. Names must be unique across all
          receivers within an action group.
      emailAddress:
        type: string
        description: The email address of this receiver.
      useCommonAlertSchema:
        type: boolean
        default: false
        description: Indicates whether to use common alert schema.
      status:
        readOnly: true
        $ref: '#/definitions/ReceiverStatus'
        description: The receiver status of the e-mail.
    required:
      - name
      - emailAddress
  SmsReceiver:
    description: An SMS receiver.
    type: object
    properties:
      name:
        type: string
        description: >-
          The name of the SMS receiver. Names must be unique across all
          receivers within an action group.
      countryCode:
        type: string
        description: The country code of the SMS receiver.
      phoneNumber:
        type: string
        description: The phone number of the SMS receiver.
      status:
        readOnly: true
        $ref: '#/definitions/ReceiverStatus'
        description: The status of the receiver.
    required:
      - name
      - countryCode
      - phoneNumber
  WebhookReceiver:
    description: A webhook receiver.
    type: object
    properties:
      name:
        type: string
        description: >-
          The name of the webhook receiver. Names must be unique across all
          receivers within an action group.
      serviceUri:
        type: string
        description: The URI where webhooks should be sent.
      useCommonAlertSchema:
        type: boolean
        default: false
        description: Indicates whether to use common alert schema.
      useAadAuth:
        type: boolean
        default: false
        description: Indicates whether or not use AAD authentication.
      objectId:
        type: string
        description: Indicates the webhook app object Id for aad auth.
      identifierUri:
        type: string
        description: Indicates the identifier uri for aad auth.
      tenantId:
        type: string
        description: Indicates the tenant id for aad auth.
    required:
      - name
      - serviceUri
  ItsmReceiver:
    description: An Itsm receiver.
    type: object
    properties:
      name:
        type: string
        description: >-
          The name of the Itsm receiver. Names must be unique across all
          receivers within an action group.
      workspaceId:
        type: string
        description: OMS LA instance identifier.
      connectionId:
        type: string
        description: >-
         

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-action-groups-api-openapi-original.yml