@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.74 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.getAlertsHistory({
* endingBefore: "string",
* networkId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiNetworksAlertsHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getAlertsHistory(args: GetAlertsHistoryArgs, opts?: pulumi.InvokeOptions): Promise<GetAlertsHistoryResult>;
/**
* A collection of arguments for invoking getAlertsHistory.
*/
export interface GetAlertsHistoryArgs {
/**
* 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;
/**
* networkId path parameter. Network ID
*/
networkId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
*/
perPage?: number;
/**
* 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;
}
/**
* A collection of values returned by getAlertsHistory.
*/
export interface GetAlertsHistoryResult {
/**
* 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 ResponseNetworksGetNetworkAlertsHistory
*/
readonly items: outputs.networks.GetAlertsHistoryItem[];
/**
* networkId path parameter. Network ID
*/
readonly networkId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
*/
readonly perPage?: number;
/**
* 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;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getAlertsHistory({
* endingBefore: "string",
* networkId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiNetworksAlertsHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getAlertsHistoryOutput(args: GetAlertsHistoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAlertsHistoryResult>;
/**
* A collection of arguments for invoking getAlertsHistory.
*/
export interface GetAlertsHistoryOutputArgs {
/**
* 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>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 100.
*/
perPage?: pulumi.Input<number>;
/**
* 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>;
}