Cisco Meraki v0.3.2, Sep 24 24

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.networks.getAlertsHistory

Explore with Pulumi AI

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

Example Usage

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

const example = meraki.networks.getAlertsHistory({
    endingBefore: "string",
    networkId: "string",
    perPage: 1,
    startingAfter: "string",
});
export const merakiNetworksAlertsHistoryExample = example.then(example => example.items);

import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_alerts_history(ending_before="string",
    network_id="string",
    per_page=1,
    starting_after="string")
pulumi.export("merakiNetworksAlertsHistoryExample", 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.GetAlertsHistory(ctx, &networks.GetAlertsHistoryArgs{
			EndingBefore:  pulumi.StringRef("string"),
			NetworkId:     "string",
			PerPage:       pulumi.IntRef(1),
			StartingAfter: pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksAlertsHistoryExample", 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.GetAlertsHistory.Invoke(new()
    {
        EndingBefore = "string",
        NetworkId = "string",
        PerPage = 1,
        StartingAfter = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksAlertsHistoryExample"] = example.Apply(getAlertsHistoryResult => getAlertsHistoryResult.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.GetAlertsHistoryArgs;
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.getAlertsHistory(GetAlertsHistoryArgs.builder()
            .endingBefore("string")
            .networkId("string")
            .perPage(1)
            .startingAfter("string")
            .build());

        ctx.export("merakiNetworksAlertsHistoryExample", example.applyValue(getAlertsHistoryResult -> getAlertsHistoryResult.items()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:networks:getAlertsHistory
      Arguments:
        endingBefore: string
        networkId: string
        perPage: 1
        startingAfter: string
outputs:
  merakiNetworksAlertsHistoryExample: ${example.items}

Using getAlertsHistory

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 getAlertsHistory(args: GetAlertsHistoryArgs, opts?: InvokeOptions): Promise<GetAlertsHistoryResult>
function getAlertsHistoryOutput(args: GetAlertsHistoryOutputArgs, opts?: InvokeOptions): Output<GetAlertsHistoryResult>

def get_alerts_history(ending_before: Optional[str] = None,
                       network_id: Optional[str] = None,
                       per_page: Optional[int] = None,
                       starting_after: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAlertsHistoryResult
def get_alerts_history_output(ending_before: Optional[pulumi.Input[str]] = None,
                       network_id: Optional[pulumi.Input[str]] = None,
                       per_page: Optional[pulumi.Input[int]] = None,
                       starting_after: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAlertsHistoryResult]

func GetAlertsHistory(ctx *Context, args *GetAlertsHistoryArgs, opts ...InvokeOption) (*GetAlertsHistoryResult, error)
func GetAlertsHistoryOutput(ctx *Context, args *GetAlertsHistoryOutputArgs, opts ...InvokeOption) GetAlertsHistoryResultOutput

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

public static class GetAlertsHistory 
{
    public static Task<GetAlertsHistoryResult> InvokeAsync(GetAlertsHistoryArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertsHistoryResult> Invoke(GetAlertsHistoryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlertsHistoryResult> getAlertsHistory(GetAlertsHistoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

NetworkId string: networkId path parameter. Network ID
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

NetworkId string: networkId path parameter. Network ID
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

networkId String: networkId path parameter. Network ID
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

networkId string: networkId path parameter. Network ID
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

network_id str: networkId path parameter. Network ID
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

networkId String: networkId path parameter. Network ID
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

getAlertsHistory Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetAlertsHistoryItem>: Array of ResponseNetworksGetNetworkAlertsHistory
NetworkId string: networkId path parameter. Network ID
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

Id string: The provider-assigned unique ID for this managed resource.
Items []GetAlertsHistoryItem: Array of ResponseNetworksGetNetworkAlertsHistory
NetworkId string: networkId path parameter. Network ID
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

id String: The provider-assigned unique ID for this managed resource.
items List<GetAlertsHistoryItem>: Array of ResponseNetworksGetNetworkAlertsHistory
networkId String: networkId path parameter. Network ID
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

id string: The provider-assigned unique ID for this managed resource.
items GetAlertsHistoryItem[]: Array of ResponseNetworksGetNetworkAlertsHistory
networkId string: networkId path parameter. Network ID
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetAlertsHistoryItem]: Array of ResponseNetworksGetNetworkAlertsHistory
network_id str: networkId path parameter. Network ID
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: Array of ResponseNetworksGetNetworkAlertsHistory
networkId String: networkId path parameter. Network ID
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

Supporting Types

GetAlertsHistoryItem

AlertData string: relevant data about the event that caused the alert
AlertType string: user friendly alert type
AlertTypeId string: type of alert
Destinations GetAlertsHistoryItemDestinations: the destinations this alert is configured to be delivered to
Device GetAlertsHistoryItemDevice: info related to the device that caused the alert
OccurredAt string: time when the event occurred

AlertData string: relevant data about the event that caused the alert
AlertType string: user friendly alert type
AlertTypeId string: type of alert
Destinations GetAlertsHistoryItemDestinations: the destinations this alert is configured to be delivered to
Device GetAlertsHistoryItemDevice: info related to the device that caused the alert
OccurredAt string: time when the event occurred

alertData String: relevant data about the event that caused the alert
alertType String: user friendly alert type
alertTypeId String: type of alert
destinations GetAlertsHistoryItemDestinations: the destinations this alert is configured to be delivered to
device GetAlertsHistoryItemDevice: info related to the device that caused the alert
occurredAt String: time when the event occurred

alertData string: relevant data about the event that caused the alert
alertType string: user friendly alert type
alertTypeId string: type of alert
destinations GetAlertsHistoryItemDestinations: the destinations this alert is configured to be delivered to
device GetAlertsHistoryItemDevice: info related to the device that caused the alert
occurredAt string: time when the event occurred

alert_data str: relevant data about the event that caused the alert
alert_type str: user friendly alert type
alert_type_id str: type of alert
destinations GetAlertsHistoryItemDestinations: the destinations this alert is configured to be delivered to
device GetAlertsHistoryItemDevice: info related to the device that caused the alert
occurred_at str: time when the event occurred

alertData String: relevant data about the event that caused the alert
alertType String: user friendly alert type
alertTypeId String: type of alert
destinations Property Map: the destinations this alert is configured to be delivered to
device Property Map: info related to the device that caused the alert
occurredAt String: time when the event occurred

GetAlertsHistoryItemDestinations

Email GetAlertsHistoryItemDestinationsEmail: email destinations for this alert
Push GetAlertsHistoryItemDestinationsPush: push destinations for this alert
Sms GetAlertsHistoryItemDestinationsSms: sms destinations for this alert
Webhook GetAlertsHistoryItemDestinationsWebhook: webhook destinations for this alert

Email GetAlertsHistoryItemDestinationsEmail: email destinations for this alert
Push GetAlertsHistoryItemDestinationsPush: push destinations for this alert
Sms GetAlertsHistoryItemDestinationsSms: sms destinations for this alert
Webhook GetAlertsHistoryItemDestinationsWebhook: webhook destinations for this alert

email GetAlertsHistoryItemDestinationsEmail: email destinations for this alert
push GetAlertsHistoryItemDestinationsPush: push destinations for this alert
sms GetAlertsHistoryItemDestinationsSms: sms destinations for this alert
webhook GetAlertsHistoryItemDestinationsWebhook: webhook destinations for this alert

email GetAlertsHistoryItemDestinationsEmail: email destinations for this alert
push GetAlertsHistoryItemDestinationsPush: push destinations for this alert
sms GetAlertsHistoryItemDestinationsSms: sms destinations for this alert
webhook GetAlertsHistoryItemDestinationsWebhook: webhook destinations for this alert

email GetAlertsHistoryItemDestinationsEmail: email destinations for this alert
push GetAlertsHistoryItemDestinationsPush: push destinations for this alert
sms GetAlertsHistoryItemDestinationsSms: sms destinations for this alert
webhook GetAlertsHistoryItemDestinationsWebhook: webhook destinations for this alert

email Property Map: email destinations for this alert
push Property Map: push destinations for this alert
sms Property Map: sms destinations for this alert
webhook Property Map: webhook destinations for this alert

GetAlertsHistoryItemDestinationsEmail

SentAt string: time when the alert was sent to the user(s) for this channel

SentAt string: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

sentAt string: time when the alert was sent to the user(s) for this channel

sent_at str: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

GetAlertsHistoryItemDestinationsPush

SentAt string: time when the alert was sent to the user(s) for this channel

SentAt string: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

sentAt string: time when the alert was sent to the user(s) for this channel

sent_at str: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

GetAlertsHistoryItemDestinationsSms

SentAt string: time when the alert was sent to the user(s) for this channel

SentAt string: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

sentAt string: time when the alert was sent to the user(s) for this channel

sent_at str: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

GetAlertsHistoryItemDestinationsWebhook

SentAt string: time when the alert was sent to the user(s) for this channel

SentAt string: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

sentAt string: time when the alert was sent to the user(s) for this channel

sent_at str: time when the alert was sent to the user(s) for this channel

sentAt String: time when the alert was sent to the user(s) for this channel

GetAlertsHistoryItemDevice

Serial string: device serial

Serial string: device serial

serial String: device serial

serial string: device serial

serial str: device serial

serial String: device serial

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.networks.getAlertsHistory

On this page

On this page

Example Usage

Using getAlertsHistory

getAlertsHistory Result

Supporting Types

GetAlertsHistoryItem

GetAlertsHistoryItemDestinations

GetAlertsHistoryItemDestinationsEmail

GetAlertsHistoryItemDestinationsPush

GetAlertsHistoryItemDestinationsSms

GetAlertsHistoryItemDestinationsWebhook

GetAlertsHistoryItemDevice

Package Details

On this page

On this page