@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
108 lines • 5.12 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.getSummaryTopNetworksByStatus({
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsSummaryTopNetworksByStatusExample = example.then(example => example.items);
* ```
*/
export declare function getSummaryTopNetworksByStatus(args: GetSummaryTopNetworksByStatusArgs, opts?: pulumi.InvokeOptions): Promise<GetSummaryTopNetworksByStatusResult>;
/**
* A collection of arguments for invoking getSummaryTopNetworksByStatus.
*/
export interface GetSummaryTopNetworksByStatusArgs {
/**
* 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;
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
*/
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 getSummaryTopNetworksByStatus.
*/
export interface GetSummaryTopNetworksByStatusResult {
/**
* 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 ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
*/
readonly items: outputs.organizations.GetSummaryTopNetworksByStatusItem[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
*/
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.organizations.getSummaryTopNetworksByStatus({
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsSummaryTopNetworksByStatusExample = example.then(example => example.items);
* ```
*/
export declare function getSummaryTopNetworksByStatusOutput(args: GetSummaryTopNetworksByStatusOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSummaryTopNetworksByStatusResult>;
/**
* A collection of arguments for invoking getSummaryTopNetworksByStatus.
*/
export interface GetSummaryTopNetworksByStatusOutputArgs {
/**
* 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>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
*/
perPage?: pulumi.Input<number | 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>;
}
//# sourceMappingURL=getSummaryTopNetworksByStatus.d.ts.map