@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
206 lines (205 loc) • 9.39 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.getDevicesAvailabilitiesChangeHistory({
* endingBefore: "string",
* networkIds: ["string"],
* organizationId: "string",
* perPage: 1,
* productTypes: ["string"],
* serials: ["string"],
* startingAfter: "string",
* statuses: ["string"],
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiOrganizationsDevicesAvailabilitiesChangeHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesAvailabilitiesChangeHistory(args: GetDevicesAvailabilitiesChangeHistoryArgs, opts?: pulumi.InvokeOptions): Promise<GetDevicesAvailabilitiesChangeHistoryResult>;
/**
* A collection of arguments for invoking getDevicesAvailabilitiesChangeHistory.
*/
export interface GetDevicesAvailabilitiesChangeHistoryArgs {
/**
* 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;
/**
* networkIds query parameter. Optional parameter to filter device availabilities history by network IDs
*/
networkIds?: string[];
/**
* 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;
/**
* productTypes query parameter. Optional parameter to filter device availabilities history by device product types
*/
productTypes?: string[];
/**
* serials query parameter. Optional parameter to filter device availabilities history by device serial numbers
*/
serials?: 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;
/**
* statuses query parameter. Optional parameter to filter device availabilities history by device statuses
*/
statuses?: string[];
/**
* 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 getDevicesAvailabilitiesChangeHistory.
*/
export interface GetDevicesAvailabilitiesChangeHistoryResult {
/**
* 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 ResponseOrganizationsGetOrganizationDevicesAvailabilitiesChangeHistory
*/
readonly items: outputs.organizations.GetDevicesAvailabilitiesChangeHistoryItem[];
/**
* networkIds query parameter. Optional parameter to filter device availabilities history by network IDs
*/
readonly networkIds?: string[];
/**
* 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;
/**
* productTypes query parameter. Optional parameter to filter device availabilities history by device product types
*/
readonly productTypes?: string[];
/**
* serials query parameter. Optional parameter to filter device availabilities history by device serial numbers
*/
readonly serials?: 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;
/**
* statuses query parameter. Optional parameter to filter device availabilities history by device statuses
*/
readonly statuses?: string[];
/**
* 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.organizations.getDevicesAvailabilitiesChangeHistory({
* endingBefore: "string",
* networkIds: ["string"],
* organizationId: "string",
* perPage: 1,
* productTypes: ["string"],
* serials: ["string"],
* startingAfter: "string",
* statuses: ["string"],
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiOrganizationsDevicesAvailabilitiesChangeHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesAvailabilitiesChangeHistoryOutput(args: GetDevicesAvailabilitiesChangeHistoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDevicesAvailabilitiesChangeHistoryResult>;
/**
* A collection of arguments for invoking getDevicesAvailabilitiesChangeHistory.
*/
export interface GetDevicesAvailabilitiesChangeHistoryOutputArgs {
/**
* 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>;
/**
* networkIds query parameter. Optional parameter to filter device availabilities history by network IDs
*/
networkIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 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>;
/**
* productTypes query parameter. Optional parameter to filter device availabilities history by device product types
*/
productTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* serials query parameter. Optional parameter to filter device availabilities history by device serial numbers
*/
serials?: pulumi.Input<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>;
/**
* statuses query parameter. Optional parameter to filter device availabilities history by device statuses
*/
statuses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 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>;
}