# getAlertingRuleEnvironments

> Function getAlertingRuleEnvironments in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Function getAlertingRuleEnvironments in pulumi-portainer.

Invoke token: `portainer:index/getAlertingRuleEnvironments:getAlertingRuleEnvironments`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const result = await portainer.getAlertingRuleEnvironments({
  ruleId: 0,
})
```

`getAlertingRuleEnvironmentsOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `id`     | `string` | no       |             |
| `ruleId` | `number` | yes      |             |

## Result

| Property       | Type                                 | Always present | Description |
| -------------- | ------------------------------------ | -------------- | ----------- |
| `active`       | `number`                             | yes            |             |
| `error`        | `number`                             | yes            |             |
| `excluded`     | `number`                             | yes            |             |
| `groups`       | `GetAlertingRuleEnvironmentsGroup[]` | yes            |             |
| `id`           | `string`                             | yes            |             |
| `notSupported` | `number`                             | yes            |             |
| `pending`      | `number`                             | yes            |             |
| `ruleId`       | `number`                             | yes            |             |
| `total`        | `number`                             | yes            |             |

## `GetAlertingRuleEnvironmentsGroup`

Output object `GetAlertingRuleEnvironmentsGroup`. Fields below belong to this object.

| Property            | Type                                            | Always present | Description |
| ------------------- | ----------------------------------------------- | -------------- | ----------- |
| `endpointGroupId`   | `number`                                        | no             |             |
| `endpointGroupName` | `string`                                        | no             |             |
| `environments`      | `GetAlertingRuleEnvironmentsGroupEnvironment[]` | no             |             |
| `size`              | `number`                                        | no             |             |

## `GetAlertingRuleEnvironmentsGroupEnvironment`

Output object `GetAlertingRuleEnvironmentsGroupEnvironment`. Fields below belong to this object.

| Property     | Type     | Always present | Description |
| ------------ | -------- | -------------- | ----------- |
| `endpointId` | `number` | no             |             |
| `message`    | `string` | no             |             |
| `name`       | `string` | no             |             |
| `reasonCode` | `string` | no             |             |
| `status`     | `string` | no             |             |
| `updatedAt`  | `number` | no             |             |