# getEndpointsSummary

> Function getEndpointsSummary in pulumi-portainer.

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

Function getEndpointsSummary in pulumi-portainer.

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

## 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.getEndpointsSummary()
```

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

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `id`     | `string` | no       |             |

## Result

| Property     | Type                           | Always present | Description |
| ------------ | ------------------------------ | -------------- | ----------- |
| `azure`      | `number`                       | yes            |             |
| `byGroups`   | `GetEndpointsSummaryByGroup[]` | yes            |             |
| `docker`     | `number`                       | yes            |             |
| `down`       | `number`                       | yes            |             |
| `heartbeat`  | `number`                       | yes            |             |
| `id`         | `string`                       | yes            |             |
| `kubernetes` | `number`                       | yes            |             |
| `outdated`   | `number`                       | yes            |             |
| `podman`     | `number`                       | yes            |             |
| `total`      | `number`                       | yes            |             |
| `unassigned` | `number`                       | yes            |             |
| `up`         | `number`                       | yes            |             |

## `GetEndpointsSummaryByGroup`

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

| Property    | Type     | Always present | Description |
| ----------- | -------- | -------------- | ----------- |
| `count`     | `number` | no             |             |
| `groupId`   | `number` | no             |             |
| `groupName` | `string` | no             |             |