@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
122 lines • 6 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.getWirelessDevicesEthernetStatuses({
* endingBefore: "string",
* networkIds: ["string"],
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsWirelessDevicesEthernetStatusesExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessDevicesEthernetStatuses(args: GetWirelessDevicesEthernetStatusesArgs, opts?: pulumi.InvokeOptions): Promise<GetWirelessDevicesEthernetStatusesResult>;
/**
* A collection of arguments for invoking getWirelessDevicesEthernetStatuses.
*/
export interface GetWirelessDevicesEthernetStatusesArgs {
/**
* 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;
/**
* networkIds query parameter. A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N*12345678&networkIds[]=L*3456
*/
networkIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
organizationId: 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 getWirelessDevicesEthernetStatuses.
*/
export interface GetWirelessDevicesEthernetStatusesResult {
/**
* 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 ResponseWirelessGetOrganizationWirelessDevicesEthernetStatuses
*/
readonly items: outputs.organizations.GetWirelessDevicesEthernetStatusesItem[];
/**
* networkIds query parameter. A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N*12345678&networkIds[]=L*3456
*/
readonly networkIds?: string[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: 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.organizations.getWirelessDevicesEthernetStatuses({
* endingBefore: "string",
* networkIds: ["string"],
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsWirelessDevicesEthernetStatusesExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessDevicesEthernetStatusesOutput(args: GetWirelessDevicesEthernetStatusesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWirelessDevicesEthernetStatusesResult>;
/**
* A collection of arguments for invoking getWirelessDevicesEthernetStatuses.
*/
export interface GetWirelessDevicesEthernetStatusesOutputArgs {
/**
* 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>;
/**
* networkIds query parameter. A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N*12345678&networkIds[]=L*3456
*/
networkIds?: pulumi.Input<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 1000. Default is 100.
*/
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=getWirelessDevicesEthernetStatuses.d.ts.map