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

meraki.organizations.getSummaryTopClientsByUsage

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.organizations.getSummaryTopClientsByUsage({
    organizationId: "string",
    t0: "string",
    t1: "string",
    timespan: 1,
});
export const merakiOrganizationsSummaryTopClientsByUsageExample = example.then(example => example.items);

    import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_summary_top_clients_by_usage(organization_id="string",
    t0="string",
    t1="string",
    timespan=1)
pulumi.export("merakiOrganizationsSummaryTopClientsByUsageExample", 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.GetSummaryTopClientsByUsage(ctx, &organizations.GetSummaryTopClientsByUsageArgs{
			OrganizationId: "string",
			T0:             pulumi.StringRef("string"),
			T1:             pulumi.StringRef("string"),
			Timespan:       pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSummaryTopClientsByUsageExample", 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.GetSummaryTopClientsByUsage.Invoke(new()
    {
        OrganizationId = "string",
        T0 = "string",
        T1 = "string",
        Timespan = 1,
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSummaryTopClientsByUsageExample"] = example.Apply(getSummaryTopClientsByUsageResult => getSummaryTopClientsByUsageResult.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.GetSummaryTopClientsByUsageArgs;
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.getSummaryTopClientsByUsage(GetSummaryTopClientsByUsageArgs.builder()
            .organizationId("string")
            .t0("string")
            .t1("string")
            .timespan(1)
            .build());

        ctx.export("merakiOrganizationsSummaryTopClientsByUsageExample", example.applyValue(getSummaryTopClientsByUsageResult -> getSummaryTopClientsByUsageResult.items()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:organizations:getSummaryTopClientsByUsage
      Arguments:
        organizationId: string
        t0: string
        t1: string
        timespan: 1
outputs:
  merakiOrganizationsSummaryTopClientsByUsageExample: ${example.items}

    Using getSummaryTopClientsByUsage

    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 getSummaryTopClientsByUsage(args: GetSummaryTopClientsByUsageArgs, opts?: InvokeOptions): Promise<GetSummaryTopClientsByUsageResult>
function getSummaryTopClientsByUsageOutput(args: GetSummaryTopClientsByUsageOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopClientsByUsageResult>
    def get_summary_top_clients_by_usage(organization_id: Optional[str] = None,
                                     t0: Optional[str] = None,
                                     t1: Optional[str] = None,
                                     timespan: Optional[float] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetSummaryTopClientsByUsageResult
def get_summary_top_clients_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[GetSummaryTopClientsByUsageResult]
    func GetSummaryTopClientsByUsage(ctx *Context, args *GetSummaryTopClientsByUsageArgs, opts ...InvokeOption) (*GetSummaryTopClientsByUsageResult, error)
func GetSummaryTopClientsByUsageOutput(ctx *Context, args *GetSummaryTopClientsByUsageOutputArgs, opts ...InvokeOption) GetSummaryTopClientsByUsageResultOutput

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

    public static class GetSummaryTopClientsByUsage 
{
    public static Task<GetSummaryTopClientsByUsageResult> InvokeAsync(GetSummaryTopClientsByUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetSummaryTopClientsByUsageResult> Invoke(GetSummaryTopClientsByUsageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSummaryTopClientsByUsageResult> getSummaryTopClientsByUsage(GetSummaryTopClientsByUsageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:organizations/getSummaryTopClientsByUsage:getSummaryTopClientsByUsage
  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 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.

    getSummaryTopClientsByUsage Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSummaryTopClientsByUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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 []GetSummaryTopClientsByUsageItem
    Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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<GetSummaryTopClientsByUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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 GetSummaryTopClientsByUsageItem[]
    Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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[GetSummaryTopClientsByUsageItem]
    Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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 ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
    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

    GetSummaryTopClientsByUsageItem

    Id string
    ID of client
    Mac string
    MAC address of client
    Name string
    Name of client
    Network GetSummaryTopClientsByUsageItemNetwork
    Usage GetSummaryTopClientsByUsageItemUsage
    Data usage information
    Id string
    ID of client
    Mac string
    MAC address of client
    Name string
    Name of client
    Network GetSummaryTopClientsByUsageItemNetwork
    Usage GetSummaryTopClientsByUsageItemUsage
    Data usage information
    id String
    ID of client
    mac String
    MAC address of client
    name String
    Name of client
    network GetSummaryTopClientsByUsageItemNetwork
    usage GetSummaryTopClientsByUsageItemUsage
    Data usage information
    id string
    ID of client
    mac string
    MAC address of client
    name string
    Name of client
    network GetSummaryTopClientsByUsageItemNetwork
    usage GetSummaryTopClientsByUsageItemUsage
    Data usage information
    id str
    ID of client
    mac str
    MAC address of client
    name str
    Name of client
    network GetSummaryTopClientsByUsageItemNetwork
    usage GetSummaryTopClientsByUsageItemUsage
    Data usage information
    id String
    ID of client
    mac String
    MAC address of client
    name String
    Name of client
    network Property Map
    usage Property Map
    Data usage information

    GetSummaryTopClientsByUsageItemNetwork

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

    GetSummaryTopClientsByUsageItemUsage

    Downstream double
    Downstream data usage by client
    Percentage double
    Percentage of total data usage by client
    Total double
    Total data usage by client
    Upstream double
    Upstream data usage by client
    Downstream float64
    Downstream data usage by client
    Percentage float64
    Percentage of total data usage by client
    Total float64
    Total data usage by client
    Upstream float64
    Upstream data usage by client
    downstream Double
    Downstream data usage by client
    percentage Double
    Percentage of total data usage by client
    total Double
    Total data usage by client
    upstream Double
    Upstream data usage by client
    downstream number
    Downstream data usage by client
    percentage number
    Percentage of total data usage by client
    total number
    Total data usage by client
    upstream number
    Upstream data usage by client
    downstream float
    Downstream data usage by client
    percentage float
    Percentage of total data usage by client
    total float
    Total data usage by client
    upstream float
    Upstream data usage by client
    downstream Number
    Downstream data usage by client
    percentage Number
    Percentage of total data usage by client
    total Number
    Total data usage by client
    upstream Number
    Upstream data usage by client

    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