Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getSensorAlertsOverviewByMetric
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.getSensorAlertsOverviewByMetric

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.networks.getSensorAlertsOverviewByMetric({
    interval: 1,
    networkId: "string",
    t0: "string",
    t1: "string",
    timespan: 1,
});
export const merakiNetworksSensorAlertsOverviewByMetricExample = example.then(example => example.items);

    import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_sensor_alerts_overview_by_metric(interval=1,
    network_id="string",
    t0="string",
    t1="string",
    timespan=1)
pulumi.export("merakiNetworksSensorAlertsOverviewByMetricExample", example.items)

    package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.GetSensorAlertsOverviewByMetric(ctx, &networks.GetSensorAlertsOverviewByMetricArgs{
			Interval:  pulumi.IntRef(1),
			NetworkId: "string",
			T0:        pulumi.StringRef("string"),
			T1:        pulumi.StringRef("string"),
			Timespan:  pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksSensorAlertsOverviewByMetricExample", example.Items)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetSensorAlertsOverviewByMetric.Invoke(new()
    {
        Interval = 1,
        NetworkId = "string",
        T0 = "string",
        T1 = "string",
        Timespan = 1,
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksSensorAlertsOverviewByMetricExample"] = example.Apply(getSensorAlertsOverviewByMetricResult => getSensorAlertsOverviewByMetricResult.Items),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetSensorAlertsOverviewByMetricArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworksFunctions.getSensorAlertsOverviewByMetric(GetSensorAlertsOverviewByMetricArgs.builder()
            .interval(1)
            .networkId("string")
            .t0("string")
            .t1("string")
            .timespan(1)
            .build());

        ctx.export("merakiNetworksSensorAlertsOverviewByMetricExample", example.applyValue(getSensorAlertsOverviewByMetricResult -> getSensorAlertsOverviewByMetricResult.items()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:networks:getSensorAlertsOverviewByMetric
      Arguments:
        interval: 1
        networkId: string
        t0: string
        t1: string
        timespan: 1
outputs:
  merakiNetworksSensorAlertsOverviewByMetricExample: ${example.items}

    Using getSensorAlertsOverviewByMetric

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSensorAlertsOverviewByMetric(args: GetSensorAlertsOverviewByMetricArgs, opts?: InvokeOptions): Promise<GetSensorAlertsOverviewByMetricResult>
function getSensorAlertsOverviewByMetricOutput(args: GetSensorAlertsOverviewByMetricOutputArgs, opts?: InvokeOptions): Output<GetSensorAlertsOverviewByMetricResult>
    def get_sensor_alerts_overview_by_metric(interval: Optional[int] = None,
                                         network_id: Optional[str] = None,
                                         t0: Optional[str] = None,
                                         t1: Optional[str] = None,
                                         timespan: Optional[float] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetSensorAlertsOverviewByMetricResult
def get_sensor_alerts_overview_by_metric_output(interval: Optional[pulumi.Input[int]] = None,
                                         network_id: Optional[pulumi.Input[str]] = None,
                                         t0: Optional[pulumi.Input[str]] = None,
                                         t1: Optional[pulumi.Input[str]] = None,
                                         timespan: Optional[pulumi.Input[float]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetSensorAlertsOverviewByMetricResult]
    func GetSensorAlertsOverviewByMetric(ctx *Context, args *GetSensorAlertsOverviewByMetricArgs, opts ...InvokeOption) (*GetSensorAlertsOverviewByMetricResult, error)
func GetSensorAlertsOverviewByMetricOutput(ctx *Context, args *GetSensorAlertsOverviewByMetricOutputArgs, opts ...InvokeOption) GetSensorAlertsOverviewByMetricResultOutput

    > Note: This function is named GetSensorAlertsOverviewByMetric in the Go SDK.

    public static class GetSensorAlertsOverviewByMetric 
{
    public static Task<GetSensorAlertsOverviewByMetricResult> InvokeAsync(GetSensorAlertsOverviewByMetricArgs args, InvokeOptions? opts = null)
    public static Output<GetSensorAlertsOverviewByMetricResult> Invoke(GetSensorAlertsOverviewByMetricInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSensorAlertsOverviewByMetricResult> getSensorAlertsOverviewByMetric(GetSensorAlertsOverviewByMetricArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:networks/getSensorAlertsOverviewByMetric:getSensorAlertsOverviewByMetric
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NetworkId string
    networkId path parameter. Network ID
    Interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    NetworkId string
    networkId path parameter. Network ID
    Interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    networkId String
    networkId path parameter. Network ID
    interval Integer
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    networkId string
    networkId path parameter. Network ID
    interval number
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    network_id str
    networkId path parameter. Network ID
    interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    networkId String
    networkId path parameter. Network ID
    interval Number
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

    getSensorAlertsOverviewByMetric Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSensorAlertsOverviewByMetricItem>
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    NetworkId string
    networkId path parameter. Network ID
    Interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetSensorAlertsOverviewByMetricItem
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    NetworkId string
    networkId path parameter. Network ID
    Interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetSensorAlertsOverviewByMetricItem>
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    networkId String
    networkId path parameter. Network ID
    interval Integer
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetSensorAlertsOverviewByMetricItem[]
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    networkId string
    networkId path parameter. Network ID
    interval number
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetSensorAlertsOverviewByMetricItem]
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    network_id str
    networkId path parameter. Network ID
    interval int
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseSensorGetNetworkSensorAlertsOverviewByMetric
    networkId String
    networkId path parameter. Network ID
    interval Number
    interval query parameter. The time interval in seconds for returned data. The valid intervals are: 86400, 604800. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

    Supporting Types

    GetSensorAlertsOverviewByMetricItem

    Counts GetSensorAlertsOverviewByMetricItemCounts
    Counts of sensor alerts over the timespan, by reading metric
    EndTs string
    End of the timespan over which sensor alerts are counted
    StartTs string
    Start of the timespan over which sensor alerts are counted
    Counts GetSensorAlertsOverviewByMetricItemCounts
    Counts of sensor alerts over the timespan, by reading metric
    EndTs string
    End of the timespan over which sensor alerts are counted
    StartTs string
    Start of the timespan over which sensor alerts are counted
    counts GetSensorAlertsOverviewByMetricItemCounts
    Counts of sensor alerts over the timespan, by reading metric
    endTs String
    End of the timespan over which sensor alerts are counted
    startTs String
    Start of the timespan over which sensor alerts are counted
    counts GetSensorAlertsOverviewByMetricItemCounts
    Counts of sensor alerts over the timespan, by reading metric
    endTs string
    End of the timespan over which sensor alerts are counted
    startTs string
    Start of the timespan over which sensor alerts are counted
    counts GetSensorAlertsOverviewByMetricItemCounts
    Counts of sensor alerts over the timespan, by reading metric
    end_ts str
    End of the timespan over which sensor alerts are counted
    start_ts str
    Start of the timespan over which sensor alerts are counted
    counts Property Map
    Counts of sensor alerts over the timespan, by reading metric
    endTs String
    End of the timespan over which sensor alerts are counted
    startTs String
    Start of the timespan over which sensor alerts are counted

    GetSensorAlertsOverviewByMetricItemCounts

    ApparentPower int
    Number of sensor alerts that occurred due to apparent power readings
    Co2 int
    Number of sensors that are currently alerting due to CO2 readings
    Current int
    Number of sensor alerts that occurred due to electrical current readings
    Door int
    Number of sensor alerts that occurred due to an open door
    Frequency int
    Number of sensor alerts that occurred due to frequency readings
    Humidity int
    Number of sensor alerts that occurred due to humidity readings
    IndoorAirQuality int
    Number of sensor alerts that occurred due to indoor air quality readings
    Noise GetSensorAlertsOverviewByMetricItemCountsNoise
    Object containing the number of sensor alerts that occurred due to noise readings
    Pm25 int
    Number of sensor alerts that occurred due to PM2.5 readings
    PowerFactor int
    Number of sensor alerts that occurred due to power factor readings
    RealPower int
    Number of sensor alerts that occurred due to real power readings
    Temperature int
    Number of sensor alerts that occurred due to temperature readings
    Tvoc int
    Number of sensor alerts that occurred due to TVOC readings
    UpstreamPower int
    Number of sensor alerts that occurred due to upstream power outages
    Voltage int
    Number of sensor alerts that occurred due to voltage readings
    Water int
    Number of sensor alerts that occurred due to the presence of water
    ApparentPower int
    Number of sensor alerts that occurred due to apparent power readings
    Co2 int
    Number of sensors that are currently alerting due to CO2 readings
    Current int
    Number of sensor alerts that occurred due to electrical current readings
    Door int
    Number of sensor alerts that occurred due to an open door
    Frequency int
    Number of sensor alerts that occurred due to frequency readings
    Humidity int
    Number of sensor alerts that occurred due to humidity readings
    IndoorAirQuality int
    Number of sensor alerts that occurred due to indoor air quality readings
    Noise GetSensorAlertsOverviewByMetricItemCountsNoise
    Object containing the number of sensor alerts that occurred due to noise readings
    Pm25 int
    Number of sensor alerts that occurred due to PM2.5 readings
    PowerFactor int
    Number of sensor alerts that occurred due to power factor readings
    RealPower int
    Number of sensor alerts that occurred due to real power readings
    Temperature int
    Number of sensor alerts that occurred due to temperature readings
    Tvoc int
    Number of sensor alerts that occurred due to TVOC readings
    UpstreamPower int
    Number of sensor alerts that occurred due to upstream power outages
    Voltage int
    Number of sensor alerts that occurred due to voltage readings
    Water int
    Number of sensor alerts that occurred due to the presence of water
    apparentPower Integer
    Number of sensor alerts that occurred due to apparent power readings
    co2 Integer
    Number of sensors that are currently alerting due to CO2 readings
    current Integer
    Number of sensor alerts that occurred due to electrical current readings
    door Integer
    Number of sensor alerts that occurred due to an open door
    frequency Integer
    Number of sensor alerts that occurred due to frequency readings
    humidity Integer
    Number of sensor alerts that occurred due to humidity readings
    indoorAirQuality Integer
    Number of sensor alerts that occurred due to indoor air quality readings
    noise GetSensorAlertsOverviewByMetricItemCountsNoise
    Object containing the number of sensor alerts that occurred due to noise readings
    pm25 Integer
    Number of sensor alerts that occurred due to PM2.5 readings
    powerFactor Integer
    Number of sensor alerts that occurred due to power factor readings
    realPower Integer
    Number of sensor alerts that occurred due to real power readings
    temperature Integer
    Number of sensor alerts that occurred due to temperature readings
    tvoc Integer
    Number of sensor alerts that occurred due to TVOC readings
    upstreamPower Integer
    Number of sensor alerts that occurred due to upstream power outages
    voltage Integer
    Number of sensor alerts that occurred due to voltage readings
    water Integer
    Number of sensor alerts that occurred due to the presence of water
    apparentPower number
    Number of sensor alerts that occurred due to apparent power readings
    co2 number
    Number of sensors that are currently alerting due to CO2 readings
    current number
    Number of sensor alerts that occurred due to electrical current readings
    door number
    Number of sensor alerts that occurred due to an open door
    frequency number
    Number of sensor alerts that occurred due to frequency readings
    humidity number
    Number of sensor alerts that occurred due to humidity readings
    indoorAirQuality number
    Number of sensor alerts that occurred due to indoor air quality readings
    noise GetSensorAlertsOverviewByMetricItemCountsNoise
    Object containing the number of sensor alerts that occurred due to noise readings
    pm25 number
    Number of sensor alerts that occurred due to PM2.5 readings
    powerFactor number
    Number of sensor alerts that occurred due to power factor readings
    realPower number
    Number of sensor alerts that occurred due to real power readings
    temperature number
    Number of sensor alerts that occurred due to temperature readings
    tvoc number
    Number of sensor alerts that occurred due to TVOC readings
    upstreamPower number
    Number of sensor alerts that occurred due to upstream power outages
    voltage number
    Number of sensor alerts that occurred due to voltage readings
    water number
    Number of sensor alerts that occurred due to the presence of water
    apparent_power int
    Number of sensor alerts that occurred due to apparent power readings
    co2 int
    Number of sensors that are currently alerting due to CO2 readings
    current int
    Number of sensor alerts that occurred due to electrical current readings
    door int
    Number of sensor alerts that occurred due to an open door
    frequency int
    Number of sensor alerts that occurred due to frequency readings
    humidity int
    Number of sensor alerts that occurred due to humidity readings
    indoor_air_quality int
    Number of sensor alerts that occurred due to indoor air quality readings
    noise GetSensorAlertsOverviewByMetricItemCountsNoise
    Object containing the number of sensor alerts that occurred due to noise readings
    pm25 int
    Number of sensor alerts that occurred due to PM2.5 readings
    power_factor int
    Number of sensor alerts that occurred due to power factor readings
    real_power int
    Number of sensor alerts that occurred due to real power readings
    temperature int
    Number of sensor alerts that occurred due to temperature readings
    tvoc int
    Number of sensor alerts that occurred due to TVOC readings
    upstream_power int
    Number of sensor alerts that occurred due to upstream power outages
    voltage int
    Number of sensor alerts that occurred due to voltage readings
    water int
    Number of sensor alerts that occurred due to the presence of water
    apparentPower Number
    Number of sensor alerts that occurred due to apparent power readings
    co2 Number
    Number of sensors that are currently alerting due to CO2 readings
    current Number
    Number of sensor alerts that occurred due to electrical current readings
    door Number
    Number of sensor alerts that occurred due to an open door
    frequency Number
    Number of sensor alerts that occurred due to frequency readings
    humidity Number
    Number of sensor alerts that occurred due to humidity readings
    indoorAirQuality Number
    Number of sensor alerts that occurred due to indoor air quality readings
    noise Property Map
    Object containing the number of sensor alerts that occurred due to noise readings
    pm25 Number
    Number of sensor alerts that occurred due to PM2.5 readings
    powerFactor Number
    Number of sensor alerts that occurred due to power factor readings
    realPower Number
    Number of sensor alerts that occurred due to real power readings
    temperature Number
    Number of sensor alerts that occurred due to temperature readings
    tvoc Number
    Number of sensor alerts that occurred due to TVOC readings
    upstreamPower Number
    Number of sensor alerts that occurred due to upstream power outages
    voltage Number
    Number of sensor alerts that occurred due to voltage readings
    water Number
    Number of sensor alerts that occurred due to the presence of water

    GetSensorAlertsOverviewByMetricItemCountsNoise

    Ambient int
    Number of sensor alerts that occurred due to ambient noise readings
    Ambient int
    Number of sensor alerts that occurred due to ambient noise readings
    ambient Integer
    Number of sensor alerts that occurred due to ambient noise readings
    ambient number
    Number of sensor alerts that occurred due to ambient noise readings
    ambient int
    Number of sensor alerts that occurred due to ambient noise readings
    ambient Number
    Number of sensor alerts that occurred due to ambient noise readings

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki