@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
192 lines (191 loc) • 8.42 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.getDevicesBootsHistory({
* endingBefore: "string",
* mostRecentPerDevice: false,
* organizationId: "string",
* perPage: 1,
* serials: ["string"],
* sortOrder: "string",
* startingAfter: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiOrganizationsDevicesBootsHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesBootsHistory(args: GetDevicesBootsHistoryArgs, opts?: pulumi.InvokeOptions): Promise<GetDevicesBootsHistoryResult>;
/**
* A collection of arguments for invoking getDevicesBootsHistory.
*/
export interface GetDevicesBootsHistoryArgs {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
endingBefore?: string;
/**
* mostRecentPerDevice query parameter. If true, only the most recent boot for each device is returned.
*/
mostRecentPerDevice?: boolean;
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*/
perPage?: number;
/**
* serials query parameter. Optional parameter to filter device by device serial numbers. This filter uses multiple exact matches.
*/
serials?: string[];
/**
* sortOrder query parameter. Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'.
*/
sortOrder?: string;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
startingAfter?: 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 730 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 730 days.
*/
timespan?: number;
}
/**
* A collection of values returned by getDevicesBootsHistory.
*/
export interface GetDevicesBootsHistoryResult {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
readonly endingBefore?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Array of ResponseOrganizationsGetOrganizationDevicesBootsHistory
*/
readonly items: outputs.organizations.GetDevicesBootsHistoryItem[];
/**
* mostRecentPerDevice query parameter. If true, only the most recent boot for each device is returned.
*/
readonly mostRecentPerDevice?: boolean;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*/
readonly perPage?: number;
/**
* serials query parameter. Optional parameter to filter device by device serial numbers. This filter uses multiple exact matches.
*/
readonly serials?: string[];
/**
* sortOrder query parameter. Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'.
*/
readonly sortOrder?: string;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
readonly startingAfter?: 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 730 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 730 days.
*/
readonly timespan?: number;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getDevicesBootsHistory({
* endingBefore: "string",
* mostRecentPerDevice: false,
* organizationId: "string",
* perPage: 1,
* serials: ["string"],
* sortOrder: "string",
* startingAfter: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiOrganizationsDevicesBootsHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesBootsHistoryOutput(args: GetDevicesBootsHistoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDevicesBootsHistoryResult>;
/**
* A collection of arguments for invoking getDevicesBootsHistory.
*/
export interface GetDevicesBootsHistoryOutputArgs {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
endingBefore?: pulumi.Input<string>;
/**
* mostRecentPerDevice query parameter. If true, only the most recent boot for each device is returned.
*/
mostRecentPerDevice?: pulumi.Input<boolean>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*/
perPage?: pulumi.Input<number>;
/**
* serials query parameter. Optional parameter to filter device by device serial numbers. This filter uses multiple exact matches.
*/
serials?: pulumi.Input<pulumi.Input<string>[]>;
/**
* sortOrder query parameter. Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'.
*/
sortOrder?: pulumi.Input<string>;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
startingAfter?: 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 730 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 730 days.
*/
timespan?: pulumi.Input<number>;
}