@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
119 lines (118 loc) • 4.43 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.networks.getClientsOverview({
* networkId: "string",
* resolution: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiNetworksClientsOverviewExample = example.then(example => example.item);
* ```
*/
export declare function getClientsOverview(args: GetClientsOverviewArgs, opts?: pulumi.InvokeOptions): Promise<GetClientsOverviewResult>;
/**
* A collection of arguments for invoking getClientsOverview.
*/
export interface GetClientsOverviewArgs {
/**
* networkId path parameter. Network ID
*/
networkId: string;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
*/
resolution?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
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 less than or equal to 31 days. The default is 1 day.
*/
timespan?: number;
}
/**
* A collection of values returned by getClientsOverview.
*/
export interface GetClientsOverviewResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly item: outputs.networks.GetClientsOverviewItem;
/**
* networkId path parameter. Network ID
*/
readonly networkId: string;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
*/
readonly resolution?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
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 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.networks.getClientsOverview({
* networkId: "string",
* resolution: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiNetworksClientsOverviewExample = example.then(example => example.item);
* ```
*/
export declare function getClientsOverviewOutput(args: GetClientsOverviewOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClientsOverviewResult>;
/**
* A collection of arguments for invoking getClientsOverview.
*/
export interface GetClientsOverviewOutputArgs {
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
*/
resolution?: pulumi.Input<number>;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
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 less than or equal to 31 days. The default is 1 day.
*/
timespan?: pulumi.Input<number>;
}