@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
262 lines • 10.9 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.getApiRequests({
* adminId: "string",
* endingBefore: "string",
* method: "string",
* operationIds: ["string"],
* organizationId: "string",
* path: "string",
* perPage: 1,
* responseCode: 1,
* sourceIp: "string",
* startingAfter: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* userAgent: "string",
* version: 1,
* });
* export const merakiOrganizationsApiRequestsExample = example.then(example => example.items);
* ```
*/
export declare function getApiRequests(args: GetApiRequestsArgs, opts?: pulumi.InvokeOptions): Promise<GetApiRequestsResult>;
/**
* A collection of arguments for invoking getApiRequests.
*/
export interface GetApiRequestsArgs {
/**
* adminId query parameter. Filter the results by the ID of the admin who made the API requests
*/
adminId?: string;
/**
* 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;
/**
* method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
*/
method?: string;
/**
* operationIds query parameter. Filter the results by one or more operation IDs for the API request
*/
operationIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* path query parameter. Filter the results by the path of the API requests
*/
path?: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
perPage?: number;
/**
* responseCode query parameter. Filter the results by the response code of the API requests
*/
responseCode?: number;
/**
* sourceIp query parameter. Filter the results by the IP address of the originating API request
*/
sourceIp?: 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. 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.
*/
timespan?: number;
/**
* userAgent query parameter. Filter the results by the user agent string of the API request
*/
userAgent?: string;
/**
* version query parameter. Filter the results by the API version of the API request
*/
version?: number;
}
/**
* A collection of values returned by getApiRequests.
*/
export interface GetApiRequestsResult {
/**
* adminId query parameter. Filter the results by the ID of the admin who made the API requests
*/
readonly adminId?: string;
/**
* 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 ResponseOrganizationsGetOrganizationApiRequests
*/
readonly items: outputs.organizations.GetApiRequestsItem[];
/**
* method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
*/
readonly method?: string;
/**
* operationIds query parameter. Filter the results by one or more operation IDs for the API request
*/
readonly operationIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* path query parameter. Filter the results by the path of the API requests
*/
readonly path?: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
readonly perPage?: number;
/**
* responseCode query parameter. Filter the results by the response code of the API requests
*/
readonly responseCode?: number;
/**
* sourceIp query parameter. Filter the results by the IP address of the originating API request
*/
readonly sourceIp?: 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. 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.
*/
readonly timespan?: number;
/**
* userAgent query parameter. Filter the results by the user agent string of the API request
*/
readonly userAgent?: string;
/**
* version query parameter. Filter the results by the API version of the API request
*/
readonly version?: number;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getApiRequests({
* adminId: "string",
* endingBefore: "string",
* method: "string",
* operationIds: ["string"],
* organizationId: "string",
* path: "string",
* perPage: 1,
* responseCode: 1,
* sourceIp: "string",
* startingAfter: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* userAgent: "string",
* version: 1,
* });
* export const merakiOrganizationsApiRequestsExample = example.then(example => example.items);
* ```
*/
export declare function getApiRequestsOutput(args: GetApiRequestsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiRequestsResult>;
/**
* A collection of arguments for invoking getApiRequests.
*/
export interface GetApiRequestsOutputArgs {
/**
* adminId query parameter. Filter the results by the ID of the admin who made the API requests
*/
adminId?: pulumi.Input<string | undefined>;
/**
* 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 | undefined>;
/**
* method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
*/
method?: pulumi.Input<string | undefined>;
/**
* operationIds query parameter. Filter the results by one or more operation IDs for the API request
*/
operationIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* path query parameter. Filter the results by the path of the API requests
*/
path?: pulumi.Input<string | undefined>;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
perPage?: pulumi.Input<number | undefined>;
/**
* responseCode query parameter. Filter the results by the response code of the API requests
*/
responseCode?: pulumi.Input<number | undefined>;
/**
* sourceIp query parameter. Filter the results by the IP address of the originating API request
*/
sourceIp?: pulumi.Input<string | undefined>;
/**
* 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 | undefined>;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
t0?: pulumi.Input<string | undefined>;
/**
* 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 | undefined>;
/**
* 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.
*/
timespan?: pulumi.Input<number | undefined>;
/**
* userAgent query parameter. Filter the results by the user agent string of the API request
*/
userAgent?: pulumi.Input<string | undefined>;
/**
* version query parameter. Filter the results by the API version of the API request
*/
version?: pulumi.Input<number | undefined>;
}
//# sourceMappingURL=getApiRequests.d.ts.map