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

meraki.organizations.getSummaryTopSwitchesByEnergyUsage

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.organizations.getSummaryTopSwitchesByEnergyUsage({
        organizationId: "string",
        t0: "string",
        t1: "string",
        timespan: 1,
    });
    export const merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_summary_top_switches_by_energy_usage(organization_id="string",
        t0="string",
        t1="string",
        timespan=1)
    pulumi.export("merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample", example.items)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.GetSummaryTopSwitchesByEnergyUsage(ctx, &organizations.GetSummaryTopSwitchesByEnergyUsageArgs{
    			OrganizationId: "string",
    			T0:             pulumi.StringRef("string"),
    			T1:             pulumi.StringRef("string"),
    			Timespan:       pulumi.Float64Ref(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample", example.Items)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetSummaryTopSwitchesByEnergyUsage.Invoke(new()
        {
            OrganizationId = "string",
            T0 = "string",
            T1 = "string",
            Timespan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample"] = example.Apply(getSummaryTopSwitchesByEnergyUsageResult => getSummaryTopSwitchesByEnergyUsageResult.Items),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.inputs.GetSummaryTopSwitchesByEnergyUsageArgs;
    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 = OrganizationsFunctions.getSummaryTopSwitchesByEnergyUsage(GetSummaryTopSwitchesByEnergyUsageArgs.builder()
                .organizationId("string")
                .t0("string")
                .t1("string")
                .timespan(1)
                .build());
    
            ctx.export("merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample", example.applyValue(getSummaryTopSwitchesByEnergyUsageResult -> getSummaryTopSwitchesByEnergyUsageResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getSummaryTopSwitchesByEnergyUsage
          Arguments:
            organizationId: string
            t0: string
            t1: string
            timespan: 1
    outputs:
      merakiOrganizationsSummaryTopSwitchesByEnergyUsageExample: ${example.items}
    

    Using getSummaryTopSwitchesByEnergyUsage

    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 getSummaryTopSwitchesByEnergyUsage(args: GetSummaryTopSwitchesByEnergyUsageArgs, opts?: InvokeOptions): Promise<GetSummaryTopSwitchesByEnergyUsageResult>
    function getSummaryTopSwitchesByEnergyUsageOutput(args: GetSummaryTopSwitchesByEnergyUsageOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopSwitchesByEnergyUsageResult>
    def get_summary_top_switches_by_energy_usage(organization_id: Optional[str] = None,
                                                 t0: Optional[str] = None,
                                                 t1: Optional[str] = None,
                                                 timespan: Optional[float] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetSummaryTopSwitchesByEnergyUsageResult
    def get_summary_top_switches_by_energy_usage_output(organization_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[GetSummaryTopSwitchesByEnergyUsageResult]
    func GetSummaryTopSwitchesByEnergyUsage(ctx *Context, args *GetSummaryTopSwitchesByEnergyUsageArgs, opts ...InvokeOption) (*GetSummaryTopSwitchesByEnergyUsageResult, error)
    func GetSummaryTopSwitchesByEnergyUsageOutput(ctx *Context, args *GetSummaryTopSwitchesByEnergyUsageOutputArgs, opts ...InvokeOption) GetSummaryTopSwitchesByEnergyUsageResultOutput

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

    public static class GetSummaryTopSwitchesByEnergyUsage 
    {
        public static Task<GetSummaryTopSwitchesByEnergyUsageResult> InvokeAsync(GetSummaryTopSwitchesByEnergyUsageArgs args, InvokeOptions? opts = null)
        public static Output<GetSummaryTopSwitchesByEnergyUsageResult> Invoke(GetSummaryTopSwitchesByEnergyUsageInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSummaryTopSwitchesByEnergyUsageResult> getSummaryTopSwitchesByEnergyUsage(GetSummaryTopSwitchesByEnergyUsageArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getSummaryTopSwitchesByEnergyUsage:getSummaryTopSwitchesByEnergyUsage
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.

    getSummaryTopSwitchesByEnergyUsage Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSummaryTopSwitchesByEnergyUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetSummaryTopSwitchesByEnergyUsageItem
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetSummaryTopSwitchesByEnergyUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetSummaryTopSwitchesByEnergyUsageItem[]
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetSummaryTopSwitchesByEnergyUsageItem]
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSwitchesByEnergyUsage
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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 greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.

    Supporting Types

    GetSummaryTopSwitchesByEnergyUsageItem

    Mac string
    Mac address of the switch
    Model string
    Model of the switch
    Name string
    Name of the switch
    Network GetSummaryTopSwitchesByEnergyUsageItemNetwork
    Network info
    Usage GetSummaryTopSwitchesByEnergyUsageItemUsage
    Energy usage of the switch
    Mac string
    Mac address of the switch
    Model string
    Model of the switch
    Name string
    Name of the switch
    Network GetSummaryTopSwitchesByEnergyUsageItemNetwork
    Network info
    Usage GetSummaryTopSwitchesByEnergyUsageItemUsage
    Energy usage of the switch
    mac String
    Mac address of the switch
    model String
    Model of the switch
    name String
    Name of the switch
    network GetSummaryTopSwitchesByEnergyUsageItemNetwork
    Network info
    usage GetSummaryTopSwitchesByEnergyUsageItemUsage
    Energy usage of the switch
    mac string
    Mac address of the switch
    model string
    Model of the switch
    name string
    Name of the switch
    network GetSummaryTopSwitchesByEnergyUsageItemNetwork
    Network info
    usage GetSummaryTopSwitchesByEnergyUsageItemUsage
    Energy usage of the switch
    mac str
    Mac address of the switch
    model str
    Model of the switch
    name str
    Name of the switch
    network GetSummaryTopSwitchesByEnergyUsageItemNetwork
    Network info
    usage GetSummaryTopSwitchesByEnergyUsageItemUsage
    Energy usage of the switch
    mac String
    Mac address of the switch
    model String
    Model of the switch
    name String
    Name of the switch
    network Property Map
    Network info
    usage Property Map
    Energy usage of the switch

    GetSummaryTopSwitchesByEnergyUsageItemNetwork

    Id string
    Network id
    Name string
    Network name
    Id string
    Network id
    Name string
    Network name
    id String
    Network id
    name String
    Network name
    id string
    Network id
    name string
    Network name
    id str
    Network id
    name str
    Network name
    id String
    Network id
    name String
    Network name

    GetSummaryTopSwitchesByEnergyUsageItemUsage

    Total double
    Total energy usage of the switch
    Total float64
    Total energy usage of the switch
    total Double
    Total energy usage of the switch
    total number
    Total energy usage of the switch
    total float
    Total energy usage of the switch
    total Number
    Total energy usage of the switch

    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