@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) • 7.85 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.getApiRequestsOverviewResponseCodesByInterval({
* adminIds: ["string"],
* interval: 1,
* operationIds: ["string"],
* organizationId: "string",
* sourceIps: ["string"],
* t0: "string",
* t1: "string",
* timespan: 1,
* userAgent: "string",
* version: 1,
* });
* export const merakiOrganizationsApiRequestsOverviewResponseCodesByIntervalExample = example.then(example => example.items);
* ```
*/
export declare function getApiRequestsOverviewResponseCodesByInterval(args: GetApiRequestsOverviewResponseCodesByIntervalArgs, opts?: pulumi.InvokeOptions): Promise<GetApiRequestsOverviewResponseCodesByIntervalResult>;
/**
* A collection of arguments for invoking getApiRequestsOverviewResponseCodesByInterval.
*/
export interface GetApiRequestsOverviewResponseCodesByIntervalArgs {
/**
* adminIds query parameter. Filter by admin ID of user that made the API request
*/
adminIds?: string[];
/**
* interval query parameter. The time interval in seconds for returned data. The valid intervals are: 120, 3600, 14400, 21600. The default is 21600. Interval is calculated if time params are provided.
*/
interval?: number;
/**
* operationIds query parameter. Filter by operation ID of the endpoint
*/
operationIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* sourceIps query parameter. Filter by source IP that made the API request
*/
sourceIps?: 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 31 days. If interval is provided, the timespan will be autocalculated.
*/
timespan?: number;
/**
* userAgent query parameter. Filter by user agent string for API request. This will filter by a complete or partial match.
*/
userAgent?: string;
/**
* version query parameter. Filter by API version of the endpoint. Allowable values are: [0, 1]
*/
version?: number;
}
/**
* A collection of values returned by getApiRequestsOverviewResponseCodesByInterval.
*/
export interface GetApiRequestsOverviewResponseCodesByIntervalResult {
/**
* adminIds query parameter. Filter by admin ID of user that made the API request
*/
readonly adminIds?: string[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* interval query parameter. The time interval in seconds for returned data. The valid intervals are: 120, 3600, 14400, 21600. The default is 21600. Interval is calculated if time params are provided.
*/
readonly interval?: number;
/**
* Array of ResponseOrganizationsGetOrganizationApiRequestsOverviewResponseCodesByInterval
*/
readonly items: outputs.organizations.GetApiRequestsOverviewResponseCodesByIntervalItem[];
/**
* operationIds query parameter. Filter by operation ID of the endpoint
*/
readonly operationIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* sourceIps query parameter. Filter by source IP that made the API request
*/
readonly sourceIps?: 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 31 days. If interval is provided, the timespan will be autocalculated.
*/
readonly timespan?: number;
/**
* userAgent query parameter. Filter by user agent string for API request. This will filter by a complete or partial match.
*/
readonly userAgent?: string;
/**
* version query parameter. Filter by API version of the endpoint. Allowable values are: [0, 1]
*/
readonly version?: number;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getApiRequestsOverviewResponseCodesByInterval({
* adminIds: ["string"],
* interval: 1,
* operationIds: ["string"],
* organizationId: "string",
* sourceIps: ["string"],
* t0: "string",
* t1: "string",
* timespan: 1,
* userAgent: "string",
* version: 1,
* });
* export const merakiOrganizationsApiRequestsOverviewResponseCodesByIntervalExample = example.then(example => example.items);
* ```
*/
export declare function getApiRequestsOverviewResponseCodesByIntervalOutput(args: GetApiRequestsOverviewResponseCodesByIntervalOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiRequestsOverviewResponseCodesByIntervalResult>;
/**
* A collection of arguments for invoking getApiRequestsOverviewResponseCodesByInterval.
*/
export interface GetApiRequestsOverviewResponseCodesByIntervalOutputArgs {
/**
* adminIds query parameter. Filter by admin ID of user that made the API request
*/
adminIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* interval query parameter. The time interval in seconds for returned data. The valid intervals are: 120, 3600, 14400, 21600. The default is 21600. Interval is calculated if time params are provided.
*/
interval?: pulumi.Input<number>;
/**
* operationIds query parameter. Filter by operation ID of the endpoint
*/
operationIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* sourceIps query parameter. Filter by source IP that made the API request
*/
sourceIps?: 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 31 days. If interval is provided, the timespan will be autocalculated.
*/
timespan?: pulumi.Input<number>;
/**
* userAgent query parameter. Filter by user agent string for API request. This will filter by a complete or partial match.
*/
userAgent?: pulumi.Input<string>;
/**
* version query parameter. Filter by API version of the endpoint. Allowable values are: [0, 1]
*/
version?: pulumi.Input<number>;
}