@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
108 lines (107 loc) • 4.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* 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);
* ```
*/
export declare function getSummaryTopClientsByUsage(args: GetSummaryTopClientsByUsageArgs, opts?: pulumi.InvokeOptions): Promise<GetSummaryTopClientsByUsageResult>;
/**
* A collection of arguments for invoking getSummaryTopClientsByUsage.
*/
export interface GetSummaryTopClientsByUsageArgs {
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* t0 query parameter. The beginning of the timespan for the data.
*/
t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
*/
t1?: string;
/**
* 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.
*/
timespan?: number;
}
/**
* A collection of values returned by getSummaryTopClientsByUsage.
*/
export interface GetSummaryTopClientsByUsageResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Array of ResponseOrganizationsGetOrganizationSummaryTopClientsByUsage
*/
readonly items: outputs.organizations.GetSummaryTopClientsByUsageItem[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* t0 query parameter. The beginning of the timespan for the data.
*/
readonly t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
*/
readonly t1?: string;
/**
* 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.
*/
readonly timespan?: number;
}
/**
* ## Example Usage
*
* ```typescript
* 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);
* ```
*/
export declare function getSummaryTopClientsByUsageOutput(args: GetSummaryTopClientsByUsageOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSummaryTopClientsByUsageResult>;
/**
* A collection of arguments for invoking getSummaryTopClientsByUsage.
*/
export interface GetSummaryTopClientsByUsageOutputArgs {
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* t0 query parameter. The beginning of the timespan for the data.
*/
t0?: pulumi.Input<string>;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
*/
t1?: pulumi.Input<string>;
/**
* 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.
*/
timespan?: pulumi.Input<number>;
}