Azure Alerts connector powered by Jitterbit

The BMC Helix iPaaSAzure Alerts connector provides an interface for entering user-provided input such as credentials to create an authenticated Azure Alerts connection. That connection provides the foundation to configure associated Azure Alerts connector activities that interact with the connection. Together, a specific Azure Alerts connection and its activities are referred to as an Azure Alerts endpoint.

Use the connector to perform the following actions:  

  • Configure the connection to create an authenticated Azure Alerts connection by entering credentials.
  • Configure associated Azure Alerts activities that interact with the connection to be used either as a source to provide data within an operation, or as a target to consume data within an operation.
  • Use the connector activities to perform the following actions: 
    • Retrieve all alerts, or alerts by ID
    • Change alert status

Supported API versions and prerequisites

The Azure Alerts connector uses the  Azure Alerts REST API version 2019-03-01 Open link . Refer to the API documentation for information on the schema fields.

The Azure Alerts connector requires the use of an agent version  10.1 Open link  or later. These agent versions automatically download the latest version of the connector when required.

To configure an Azure Alerts connection 

The Azure Alerts  connection is configured by using the Azure Alerts connector to establish access to the Azure Alerts endpoint. Once a connection is established, create operations that include  activities associated with that connection to be used either as a source, to provide data to an operation, or as a target, to consume data in an operation. 

To create or edit an Azure Alerts connection, complete the following steps:

  1. From the design canvas, open the  Connectivity tab of the design component palette.
  2. To open the configuration screen to configure an Azure Alerts connection:
    • To configure a new Azure Alerts connection, use the Show dropdown to filter on Connectors, and then click the Azure Alerts connector block:
    • To configure an existing Azure Alerts connection, use the Show dropdown to filter on Endpoints, and then double-click the Azure Alerts connector block:
  3. On the configuration screen, enter the values described in the following table:

    Tip

    Fields with a variable icon  support using  global variables Open link project variables Open link , and Jitterbit variables Open link . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Field nameAction
    Endpoint NameEnter a name to use to identify the Azure Alerts connection. The name must be unique for each Azure Alerts connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Azure Alerts endpoint, which refers to both a specific connection and its activities.
    TENANT IDEnter the tenant ID.
    CLIENT IDEnter the client ID.
    CLIENT SECRETEnter the client secret.


    Important

    If you click Delete while creating a new connection, an error is displayed. For more information, see  Component Dependencies, Deletion, and Removal Open link

  4. Click Save Changes.

    After configuring an Azure Alerts connection, you can configure one or more Azure Alerts activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation). For more information about creating an activity, see Creating an Azure DevOps activity.

To create an Azure Alerts activity 

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. Use the Show dropdown to filter on Endpoints, and then click the Azure Alerts connection block to display activities that are available to be used with an Azure Alerts connection:

    The following activities are available. For more information about configuring these activities, see the specific activity sections.

    Activity nameDescription
    Get All AlertsFinds alerts at an Azure Alerts endpoint and is intended to be used as a source in an operation.
    Get By IdFinds an alert based on the ID at an Azure Alerts endpoint and is intended to be used as a source in an operation.
    Change Alert StatusPlaces the status update for the alert into an Azure Alerts endpoint and is intended to be used as a target in an operation.
  3. To create an activity that can be configured, drag the activity block Open link  from the palette to the operation. 

For more information about the parts of an operation and adding activities to operations, see  Operation Creation and Configuration Open link

To configure an Azure Alerts Get All Alerts activity 

An Azure Alerts Get All Alerts activity finds an alert at an Azure Alerts endpoint and is intended to be used as a source to provide data to an operation. After configuring an Azure Alerts connection, you can configure as many Azure Alerts activities as you like for each Azure Alerts connection.

To configure an Azure Alerts Get All Alerts Activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings: 

    Field nameAction
    Name Enter a name to identify the Azure Alerts Get All Alerts activity. The name must be unique for each Azure Alerts Get All Alerts activity and must not contain forward slashes (/) or colons (:).
    Resource ID Enter the ID of the resource for which the alerts are generated.
    Maximum number of records to be processed

    Enter a number for the maximum number of records to be retrieved.

    Leave the field blank for unlimited number of records.


  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Azure Alerts Get All Alerts activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more. The Azure Alerts connector uses the Azure Alerts REST API version 2019-03-01 Open link . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After the activity is created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tab, and from the design canvas. For more information, see Activity Actions Menu Open link .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Azure Alerts Get All Alerts activity operation patterns

Azure Alerts Get All Alerts activities can be used as a source with these operation patterns:

  • Transformation Pattern Open link
  • Two-Target Archive Pattern Open link  (as the first source only)
  • Two-Transformation Pattern Open link  (as the first or second source)

Other patterns are not valid using Azure DevOps Create Webhook activities. For more information on the validation patterns, see the  Operation Validity Open link  page.

A typical use case is to use an Azure Alerts Get All Alerts activity in the Two-Transformation Pattern. In this example, the first transformation (Azure Alerts Get All Alerts Request) creates a request structure that is passed to the Azure Alerts Get All Alerts activity. The second transformation (Azure Alerts Get All Alerts Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure Alerts Get All Alerts Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs Open link .

To configure an Azure Alerts Get By ID activity 

An Azure Alerts Get By ID activity retrieves alert data based on the Alert ID from an Azure Alerts endpoint and is intended to be used as a source to provide data to an operation. After configuring an Azure Alerts connection, you can configure as many Azure Alerts activities as you like for each Azure Alerts connection.

To configure Azure Alerts Get By ID activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings:

    Field nameAction
    NameEnter a name to identify the Azure Alerts Get By Id activity. The name must be unique for each Azure Alerts Get By Id activity and must not contain forward slashes (/) or colons (:).
    Alert IDEnter the ID of the alert to retrieve.
    Resource IDEnter the ID of the resource for which the alert has been created.


  3. Click Next.

  4. Review the request and response data schemas.
    The data schemas list the field available for the Azure Alerts Get By ID activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Azure Alerts connector uses the Azure Alerts REST API version 2019-03-01 Open link . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After the activity is created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tab, and from the design canvas. For more information, see Activity Actions Menu Open link .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Azure Alerts Get By Id activity operation patterns

Azure Alerts Get By Id activities can be used as a source with these operation patterns:

  • Transformation Pattern Open link
  • Two-Target Archive Pattern Open link  (as the first source only)
  • Two-Transformation Pattern Open link (as the first or second source)

Other patterns are not valid using Azure DevOps Create Webhook activities. For more information on the validation patterns, see the  Operation Validity Open link  page.

A typical use case is to use an Azure Alerts Get By Id activity in the Two-Transformation Pattern. In this example, the first transformation (Azure Alerts Get By Id Request) creates a request structure that is passed to the Azure Alerts Get By Id activity. The second transformation (Azure Alerts Get By Id Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure Alerts Get By Id Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs Open link .

Configuring an Azure Alerts Change Alert Status activity 

An Azure Alerts Change Alert Status activity places the alert status value into an Azure Alerts endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure Alerts connection, you can configure as many Azure Alerts activities as you like for each Azure Alerts connection. 

To configure an Azure Alerts Change Alert Status activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings: 

    Field nameAction
    Name

    Enter a name to identify the Azure Alerts Change Alert Status activity. The name must be unique for each Azure Alerts Change Alert Status activity and must not contain forward slashes (/) or colons (:).

    Resource IDEnter the ID of the resource for which the alert is generated.
    Alert IDEnter the ID of the alert for which you want to change the status.
    Alert StateEnter the state to which you want to change the alert status.


  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Azure Alerts Change Status activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Azure Alerts connector uses the Azure Alerts REST API version 2019-03-01 Open link . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After the activity is created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tab, and from the design canvas. For more information, see Activity Actions Menu Open link .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Azure Alerts Change Alert Status activity operation patterns

After configuring an Azure Alerts Change Alert Status activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Azure Alerts Change Alert Status activities can be used as a target with these operation patterns:

  • Transformation Pattern Open link
  • Two-Transformation Pattern Open link (as the first or second source)

Other patterns are not valid using Azure DevOps Create Webhook activities. For more information on the validation patterns, see the  Operation Validity Open link  page.

A typical use case is to use an Azure Alerts Change Alert Status activity in the Two-Transformation Pattern. In this example, the first transformation (Azure Alerts Change Alert Status Request) creates a request structure that is passed to the Azure Alerts Change Alert Status activity. The second transformation (Azure Alerts Change Alert Status Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure Alerts Change Alert Status Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs Open link .

Was this page helpful? Yes No Submitting... Thank you

Comments