Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
meraki.organizations.getSummaryTopDevicesByUsage
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";
const example = meraki.organizations.getSummaryTopDevicesByUsage({
    organizationId: "string",
    t0: "string",
    t1: "string",
    timespan: 1,
});
export const merakiOrganizationsSummaryTopDevicesByUsageExample = example.then(example => example.items);
import pulumi
import pulumi_meraki as meraki
example = meraki.organizations.get_summary_top_devices_by_usage(organization_id="string",
    t0="string",
    t1="string",
    timespan=1)
pulumi.export("merakiOrganizationsSummaryTopDevicesByUsageExample", 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.GetSummaryTopDevicesByUsage(ctx, &organizations.GetSummaryTopDevicesByUsageArgs{
			OrganizationId: "string",
			T0:             pulumi.StringRef("string"),
			T1:             pulumi.StringRef("string"),
			Timespan:       pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSummaryTopDevicesByUsageExample", 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.GetSummaryTopDevicesByUsage.Invoke(new()
    {
        OrganizationId = "string",
        T0 = "string",
        T1 = "string",
        Timespan = 1,
    });
    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSummaryTopDevicesByUsageExample"] = example.Apply(getSummaryTopDevicesByUsageResult => getSummaryTopDevicesByUsageResult.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.GetSummaryTopDevicesByUsageArgs;
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.getSummaryTopDevicesByUsage(GetSummaryTopDevicesByUsageArgs.builder()
            .organizationId("string")
            .t0("string")
            .t1("string")
            .timespan(1)
            .build());
        ctx.export("merakiOrganizationsSummaryTopDevicesByUsageExample", example.applyValue(getSummaryTopDevicesByUsageResult -> getSummaryTopDevicesByUsageResult.items()));
    }
}
variables:
  example:
    fn::invoke:
      function: meraki:organizations:getSummaryTopDevicesByUsage
      arguments:
        organizationId: string
        t0: string
        t1: string
        timespan: 1
outputs:
  merakiOrganizationsSummaryTopDevicesByUsageExample: ${example.items}
Using getSummaryTopDevicesByUsage
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 getSummaryTopDevicesByUsage(args: GetSummaryTopDevicesByUsageArgs, opts?: InvokeOptions): Promise<GetSummaryTopDevicesByUsageResult>
function getSummaryTopDevicesByUsageOutput(args: GetSummaryTopDevicesByUsageOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopDevicesByUsageResult>def get_summary_top_devices_by_usage(organization_id: Optional[str] = None,
                                     t0: Optional[str] = None,
                                     t1: Optional[str] = None,
                                     timespan: Optional[float] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetSummaryTopDevicesByUsageResult
def get_summary_top_devices_by_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[GetSummaryTopDevicesByUsageResult]func GetSummaryTopDevicesByUsage(ctx *Context, args *GetSummaryTopDevicesByUsageArgs, opts ...InvokeOption) (*GetSummaryTopDevicesByUsageResult, error)
func GetSummaryTopDevicesByUsageOutput(ctx *Context, args *GetSummaryTopDevicesByUsageOutputArgs, opts ...InvokeOption) GetSummaryTopDevicesByUsageResultOutput> Note: This function is named GetSummaryTopDevicesByUsage in the Go SDK.
public static class GetSummaryTopDevicesByUsage 
{
    public static Task<GetSummaryTopDevicesByUsageResult> InvokeAsync(GetSummaryTopDevicesByUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetSummaryTopDevicesByUsageResult> Invoke(GetSummaryTopDevicesByUsageInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSummaryTopDevicesByUsageResult> getSummaryTopDevicesByUsage(GetSummaryTopDevicesByUsageArgs args, InvokeOptions options)
public static Output<GetSummaryTopDevicesByUsageResult> getSummaryTopDevicesByUsage(GetSummaryTopDevicesByUsageArgs args, InvokeOptions options)
fn::invoke:
  function: meraki:organizations/getSummaryTopDevicesByUsage:getSummaryTopDevicesByUsage
  arguments:
    # arguments dictionaryThe 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 8 hours 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 8 hours 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 8 hours 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 8 hours 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 8 hours 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 8 hours and be less than or equal to 31 days. The default is 1 day.
getSummaryTopDevicesByUsage Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Items
List<GetSummary Top Devices By Usage Item> 
- Array of ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours 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
[]GetSummary Top Devices By Usage Item 
- Array of ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours 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<GetSummary Top Devices By Usage Item> 
- Array of ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours 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
GetSummary Top Devices By Usage Item[] 
- Array of ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours 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[GetSummary Top Devices By Usage Item] 
- Array of ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours 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 ResponseOrganizationsGetOrganizationSummaryTopDevicesByUsage
- 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 8 hours and be less than or equal to 31 days. The default is 1 day.
Supporting Types
GetSummaryTopDevicesByUsageItem      
- Clients
GetSummary Top Devices By Usage Item Clients 
- Clients
- Mac string
- Mac address of the device
- Model string
- Model of the device
- Name string
- Name of the device
- Network
GetSummary Top Devices By Usage Item Network 
- Network info
- ProductType string
- Product type of the device
- Serial string
- Serial number of the device
- Usage
GetSummary Top Devices By Usage Item Usage 
- Data usage of the device
- Clients
GetSummary Top Devices By Usage Item Clients 
- Clients
- Mac string
- Mac address of the device
- Model string
- Model of the device
- Name string
- Name of the device
- Network
GetSummary Top Devices By Usage Item Network 
- Network info
- ProductType string
- Product type of the device
- Serial string
- Serial number of the device
- Usage
GetSummary Top Devices By Usage Item Usage 
- Data usage of the device
- clients
GetSummary Top Devices By Usage Item Clients 
- Clients
- mac String
- Mac address of the device
- model String
- Model of the device
- name String
- Name of the device
- network
GetSummary Top Devices By Usage Item Network 
- Network info
- productType String
- Product type of the device
- serial String
- Serial number of the device
- usage
GetSummary Top Devices By Usage Item Usage 
- Data usage of the device
- clients
GetSummary Top Devices By Usage Item Clients 
- Clients
- mac string
- Mac address of the device
- model string
- Model of the device
- name string
- Name of the device
- network
GetSummary Top Devices By Usage Item Network 
- Network info
- productType string
- Product type of the device
- serial string
- Serial number of the device
- usage
GetSummary Top Devices By Usage Item Usage 
- Data usage of the device
- clients
GetSummary Top Devices By Usage Item Clients 
- Clients
- mac str
- Mac address of the device
- model str
- Model of the device
- name str
- Name of the device
- network
GetSummary Top Devices By Usage Item Network 
- Network info
- product_type str
- Product type of the device
- serial str
- Serial number of the device
- usage
GetSummary Top Devices By Usage Item Usage 
- Data usage of the device
- clients Property Map
- Clients
- mac String
- Mac address of the device
- model String
- Model of the device
- name String
- Name of the device
- network Property Map
- Network info
- productType String
- Product type of the device
- serial String
- Serial number of the device
- usage Property Map
- Data usage of the device
GetSummaryTopDevicesByUsageItemClients       
- Counts
GetSummary Top Devices By Usage Item Clients Counts 
- Counts of clients
- Counts
GetSummary Top Devices By Usage Item Clients Counts 
- Counts of clients
- counts
GetSummary Top Devices By Usage Item Clients Counts 
- Counts of clients
- counts
GetSummary Top Devices By Usage Item Clients Counts 
- Counts of clients
- counts
GetSummary Top Devices By Usage Item Clients Counts 
- Counts of clients
- counts Property Map
- Counts of clients
GetSummaryTopDevicesByUsageItemClientsCounts        
- Total int
- Total counts of clients
- Total int
- Total counts of clients
- total Integer
- Total counts of clients
- total number
- Total counts of clients
- total int
- Total counts of clients
- total Number
- Total counts of clients
GetSummaryTopDevicesByUsageItemNetwork       
GetSummaryTopDevicesByUsageItemUsage       
- Percentage double
- Data usage of the device by percentage
- Total double
- Total data usage of the device
- Percentage float64
- Data usage of the device by percentage
- Total float64
- Total data usage of the device
- percentage Double
- Data usage of the device by percentage
- total Double
- Total data usage of the device
- percentage number
- Data usage of the device by percentage
- total number
- Total data usage of the device
- percentage float
- Data usage of the device by percentage
- total float
- Total data usage of the device
- percentage Number
- Data usage of the device by percentage
- total Number
- Total data usage of the device
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the merakiTerraform Provider.
