1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getHealthAlerts
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.networks.getHealthAlerts

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.networks.getHealthAlerts({
        networkId: "string",
    });
    export const merakiNetworksHealthAlertsExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.get_health_alerts(network_id="string")
    pulumi.export("merakiNetworksHealthAlertsExample", 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.GetHealthAlerts(ctx, &networks.GetHealthAlertsArgs{
    			NetworkId: "string",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksHealthAlertsExample", 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.GetHealthAlerts.Invoke(new()
        {
            NetworkId = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksHealthAlertsExample"] = example.Apply(getHealthAlertsResult => getHealthAlertsResult.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.GetHealthAlertsArgs;
    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.getHealthAlerts(GetHealthAlertsArgs.builder()
                .networkId("string")
                .build());
    
            ctx.export("merakiNetworksHealthAlertsExample", example.applyValue(getHealthAlertsResult -> getHealthAlertsResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:networks:getHealthAlerts
          Arguments:
            networkId: string
    outputs:
      merakiNetworksHealthAlertsExample: ${example.items}
    

    Using getHealthAlerts

    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 getHealthAlerts(args: GetHealthAlertsArgs, opts?: InvokeOptions): Promise<GetHealthAlertsResult>
    function getHealthAlertsOutput(args: GetHealthAlertsOutputArgs, opts?: InvokeOptions): Output<GetHealthAlertsResult>
    def get_health_alerts(network_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHealthAlertsResult
    def get_health_alerts_output(network_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHealthAlertsResult]
    func GetHealthAlerts(ctx *Context, args *GetHealthAlertsArgs, opts ...InvokeOption) (*GetHealthAlertsResult, error)
    func GetHealthAlertsOutput(ctx *Context, args *GetHealthAlertsOutputArgs, opts ...InvokeOption) GetHealthAlertsResultOutput

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

    public static class GetHealthAlerts 
    {
        public static Task<GetHealthAlertsResult> InvokeAsync(GetHealthAlertsArgs args, InvokeOptions? opts = null)
        public static Output<GetHealthAlertsResult> Invoke(GetHealthAlertsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHealthAlertsResult> getHealthAlerts(GetHealthAlertsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:networks/getHealthAlerts:getHealthAlerts
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NetworkId string
    networkId path parameter. Network ID
    NetworkId string
    networkId path parameter. Network ID
    networkId String
    networkId path parameter. Network ID
    networkId string
    networkId path parameter. Network ID
    network_id str
    networkId path parameter. Network ID
    networkId String
    networkId path parameter. Network ID

    getHealthAlerts Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetHealthAlertsItem>
    Array of ResponseNetworksGetNetworkHealthAlerts
    NetworkId string
    networkId path parameter. Network ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetHealthAlertsItem
    Array of ResponseNetworksGetNetworkHealthAlerts
    NetworkId string
    networkId path parameter. Network ID
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetHealthAlertsItem>
    Array of ResponseNetworksGetNetworkHealthAlerts
    networkId String
    networkId path parameter. Network ID
    id string
    The provider-assigned unique ID for this managed resource.
    items GetHealthAlertsItem[]
    Array of ResponseNetworksGetNetworkHealthAlerts
    networkId string
    networkId path parameter. Network ID
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetHealthAlertsItem]
    Array of ResponseNetworksGetNetworkHealthAlerts
    network_id str
    networkId path parameter. Network ID
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseNetworksGetNetworkHealthAlerts
    networkId String
    networkId path parameter. Network ID

    Supporting Types

    GetHealthAlertsItem

    Category string
    Category of the alert
    Id string
    Alert identifier. Value can be empty
    Scope GetHealthAlertsItemScope
    The scope of the alert
    Severity string
    Severity of the alert
    Type string
    Alert type
    Category string
    Category of the alert
    Id string
    Alert identifier. Value can be empty
    Scope GetHealthAlertsItemScope
    The scope of the alert
    Severity string
    Severity of the alert
    Type string
    Alert type
    category String
    Category of the alert
    id String
    Alert identifier. Value can be empty
    scope GetHealthAlertsItemScope
    The scope of the alert
    severity String
    Severity of the alert
    type String
    Alert type
    category string
    Category of the alert
    id string
    Alert identifier. Value can be empty
    scope GetHealthAlertsItemScope
    The scope of the alert
    severity string
    Severity of the alert
    type string
    Alert type
    category str
    Category of the alert
    id str
    Alert identifier. Value can be empty
    scope GetHealthAlertsItemScope
    The scope of the alert
    severity str
    Severity of the alert
    type str
    Alert type
    category String
    Category of the alert
    id String
    Alert identifier. Value can be empty
    scope Property Map
    The scope of the alert
    severity String
    Severity of the alert
    type String
    Alert type

    GetHealthAlertsItemScope

    Applications List<GetHealthAlertsItemScopeApplication>
    Applications related to the alert
    Devices List<GetHealthAlertsItemScopeDevice>
    Devices related to the alert
    Peers List<GetHealthAlertsItemScopePeer>
    Peers related to the alert
    Applications []GetHealthAlertsItemScopeApplication
    Applications related to the alert
    Devices []GetHealthAlertsItemScopeDevice
    Devices related to the alert
    Peers []GetHealthAlertsItemScopePeer
    Peers related to the alert
    applications List<GetHealthAlertsItemScopeApplication>
    Applications related to the alert
    devices List<GetHealthAlertsItemScopeDevice>
    Devices related to the alert
    peers List<GetHealthAlertsItemScopePeer>
    Peers related to the alert
    applications GetHealthAlertsItemScopeApplication[]
    Applications related to the alert
    devices GetHealthAlertsItemScopeDevice[]
    Devices related to the alert
    peers GetHealthAlertsItemScopePeer[]
    Peers related to the alert
    applications List<Property Map>
    Applications related to the alert
    devices List<Property Map>
    Devices related to the alert
    peers List<Property Map>
    Peers related to the alert

    GetHealthAlertsItemScopeApplication

    Name string
    Name of the application
    Url string
    URL to the application
    Name string
    Name of the application
    Url string
    URL to the application
    name String
    Name of the application
    url String
    URL to the application
    name string
    Name of the application
    url string
    URL to the application
    name str
    Name of the application
    url str
    URL to the application
    name String
    Name of the application
    url String
    URL to the application

    GetHealthAlertsItemScopeDevice

    Clients List<GetHealthAlertsItemScopeDeviceClient>
    Clients related to the device
    Lldp GetHealthAlertsItemScopeDeviceLldp
    Lldp information
    Mac string
    The mac address of the device
    Name string
    Name of the device
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Url string
    URL to the device
    Clients []GetHealthAlertsItemScopeDeviceClient
    Clients related to the device
    Lldp GetHealthAlertsItemScopeDeviceLldp
    Lldp information
    Mac string
    The mac address of the device
    Name string
    Name of the device
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Url string
    URL to the device
    clients List<GetHealthAlertsItemScopeDeviceClient>
    Clients related to the device
    lldp GetHealthAlertsItemScopeDeviceLldp
    Lldp information
    mac String
    The mac address of the device
    name String
    Name of the device
    productType String
    Product type of the device
    serial String
    Serial number of the device
    url String
    URL to the device
    clients GetHealthAlertsItemScopeDeviceClient[]
    Clients related to the device
    lldp GetHealthAlertsItemScopeDeviceLldp
    Lldp information
    mac string
    The mac address of the device
    name string
    Name of the device
    productType string
    Product type of the device
    serial string
    Serial number of the device
    url string
    URL to the device
    clients Sequence[GetHealthAlertsItemScopeDeviceClient]
    Clients related to the device
    lldp GetHealthAlertsItemScopeDeviceLldp
    Lldp information
    mac str
    The mac address of the device
    name str
    Name of the device
    product_type str
    Product type of the device
    serial str
    Serial number of the device
    url str
    URL to the device
    clients List<Property Map>
    Clients related to the device
    lldp Property Map
    Lldp information
    mac String
    The mac address of the device
    name String
    Name of the device
    productType String
    Product type of the device
    serial String
    Serial number of the device
    url String
    URL to the device

    GetHealthAlertsItemScopeDeviceClient

    Mac string
    Mac address of the client
    Mac string
    Mac address of the client
    mac String
    Mac address of the client
    mac string
    Mac address of the client
    mac str
    Mac address of the client
    mac String
    Mac address of the client

    GetHealthAlertsItemScopeDeviceLldp

    PortId string
    Port Id
    PortId string
    Port Id
    portId String
    Port Id
    portId string
    Port Id
    port_id str
    Port Id
    portId String
    Port Id

    GetHealthAlertsItemScopePeer

    Network GetHealthAlertsItemScopePeerNetwork
    Network of the peer
    Url string
    URL to the peer
    Network GetHealthAlertsItemScopePeerNetwork
    Network of the peer
    Url string
    URL to the peer
    network GetHealthAlertsItemScopePeerNetwork
    Network of the peer
    url String
    URL to the peer
    network GetHealthAlertsItemScopePeerNetwork
    Network of the peer
    url string
    URL to the peer
    network GetHealthAlertsItemScopePeerNetwork
    Network of the peer
    url str
    URL to the peer
    network Property Map
    Network of the peer
    url String
    URL to the peer

    GetHealthAlertsItemScopePeerNetwork

    Id string
    Id of the network
    Name string
    Name of the network
    Id string
    Id of the network
    Name string
    Name of the network
    id String
    Id of the network
    name String
    Name of the network
    id string
    Id of the network
    name string
    Name of the network
    id str
    Id of the network
    name str
    Name of the network
    id String
    Id of the network
    name String
    Name of the network

    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