@pulumi/meraki/organizations/getClientsSearch.d.ts

A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0

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.getClientsSearch({
 *     endingBefore: "string",
 *     mac: "string",
 *     organizationId: "string",
 *     perPage: 1,
 *     startingAfter: "string",
 * });
 * export const merakiOrganizationsClientsSearchExample = example.then(example => example.item);
 * ```
 */
export declare function getClientsSearch(args: GetClientsSearchArgs, opts?: pulumi.InvokeOptions): Promise<GetClientsSearchResult>;
/**
 * A collection of arguments for invoking getClientsSearch.
 */
export interface GetClientsSearchArgs {
    /**
     * 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;
    /**
     * mac query parameter. The MAC address of the client. Required.
     */
    mac: string;
    /**
     * organizationId path parameter. Organization ID
     */
    organizationId: string;
    /**
     * perPage query parameter. The number of entries per page returned. Acceptable range is 3 5. Default is 5.
     */
    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 getClientsSearch.
 */
export interface GetClientsSearchResult {
    /**
     * 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;
    readonly item: outputs.organizations.GetClientsSearchItem;
    /**
     * mac query parameter. The MAC address of the client. Required.
     */
    readonly mac: string;
    /**
     * organizationId path parameter. Organization ID
     */
    readonly organizationId: string;
    /**
     * perPage query parameter. The number of entries per page returned. Acceptable range is 3 5. Default is 5.
     */
    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.getClientsSearch({
 *     endingBefore: "string",
 *     mac: "string",
 *     organizationId: "string",
 *     perPage: 1,
 *     startingAfter: "string",
 * });
 * export const merakiOrganizationsClientsSearchExample = example.then(example => example.item);
 * ```
 */
export declare function getClientsSearchOutput(args: GetClientsSearchOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClientsSearchResult>;
/**
 * A collection of arguments for invoking getClientsSearch.
 */
export interface GetClientsSearchOutputArgs {
    /**
     * 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>;
    /**
     * mac query parameter. The MAC address of the client. Required.
     */
    mac: pulumi.Input<string>;
    /**
     * organizationId path parameter. Organization ID
     */
    organizationId: pulumi.Input<string>;
    /**
     * perPage query parameter. The number of entries per page returned. Acceptable range is 3 5. Default is 5.
     */
    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=getClientsSearch.d.ts.map