@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
136 lines • 6.33 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.getInventoryOnboardingCloudMonitoringNetworks({
* deviceType: "string",
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* search: "string",
* startingAfter: "string",
* });
* export const merakiOrganizationsInventoryOnboardingCloudMonitoringNetworksExample = example.then(example => example.items);
* ```
*/
export declare function getInventoryOnboardingCloudMonitoringNetworks(args: GetInventoryOnboardingCloudMonitoringNetworksArgs, opts?: pulumi.InvokeOptions): Promise<GetInventoryOnboardingCloudMonitoringNetworksResult>;
/**
* A collection of arguments for invoking getInventoryOnboardingCloudMonitoringNetworks.
*/
export interface GetInventoryOnboardingCloudMonitoringNetworksArgs {
/**
* deviceType query parameter. Device Type switch or wireless controller
*/
deviceType: 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;
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
*/
perPage?: number;
/**
* search query parameter. Optional parameter to search on network name
*/
search?: 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;
}
/**
* A collection of values returned by getInventoryOnboardingCloudMonitoringNetworks.
*/
export interface GetInventoryOnboardingCloudMonitoringNetworksResult {
/**
* deviceType query parameter. Device Type switch or wireless controller
*/
readonly deviceType: 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 ResponseOrganizationsGetOrganizationInventoryOnboardingCloudMonitoringNetworks
*/
readonly items: outputs.organizations.GetInventoryOnboardingCloudMonitoringNetworksItem[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
*/
readonly perPage?: number;
/**
* search query parameter. Optional parameter to search on network name
*/
readonly search?: 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;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getInventoryOnboardingCloudMonitoringNetworks({
* deviceType: "string",
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* search: "string",
* startingAfter: "string",
* });
* export const merakiOrganizationsInventoryOnboardingCloudMonitoringNetworksExample = example.then(example => example.items);
* ```
*/
export declare function getInventoryOnboardingCloudMonitoringNetworksOutput(args: GetInventoryOnboardingCloudMonitoringNetworksOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInventoryOnboardingCloudMonitoringNetworksResult>;
/**
* A collection of arguments for invoking getInventoryOnboardingCloudMonitoringNetworks.
*/
export interface GetInventoryOnboardingCloudMonitoringNetworksOutputArgs {
/**
* deviceType query parameter. Device Type switch or wireless controller
*/
deviceType: pulumi.Input<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?: 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 100000. Default is 1000.
*/
perPage?: pulumi.Input<number | undefined>;
/**
* search query parameter. Optional parameter to search on network name
*/
search?: 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>;
}
//# sourceMappingURL=getInventoryOnboardingCloudMonitoringNetworks.d.ts.map