@pulumi/meraki/organizations/getUplinksStatuses.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.getUplinksStatuses({
 *     endingBefore: "string",
 *     iccids: ["string"],
 *     networkIds: ["string"],
 *     organizationId: "string",
 *     perPage: 1,
 *     serials: ["string"],
 *     startingAfter: "string",
 * });
 * export const merakiOrganizationsUplinksStatusesExample = example.then(example => example.items);
 * ```
 */
export declare function getUplinksStatuses(args: GetUplinksStatusesArgs, opts?: pulumi.InvokeOptions): Promise<GetUplinksStatusesResult>;
/**
 * A collection of arguments for invoking getUplinksStatuses.
 */
export interface GetUplinksStatusesArgs {
    /**
     * 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;
    /**
     * iccids query parameter. A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs.
     */
    iccids?: string[];
    /**
     * networkIds query parameter. A list of network IDs. The returned devices will be filtered to only include these networks.
     */
    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 1000.
     */
    perPage?: number;
    /**
     * serials query parameter. A list of serial numbers. The returned devices will be filtered to only include these serials.
     */
    serials?: 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 getUplinksStatuses.
 */
export interface GetUplinksStatusesResult {
    /**
     * 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;
    /**
     * iccids query parameter. A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs.
     */
    readonly iccids?: string[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Array of ResponseOrganizationsGetOrganizationUplinksStatuses
     */
    readonly items: outputs.organizations.GetUplinksStatusesItem[];
    /**
     * networkIds query parameter. A list of network IDs. The returned devices will be filtered to only include these networks.
     */
    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 1000.
     */
    readonly perPage?: number;
    /**
     * serials query parameter. A list of serial numbers. The returned devices will be filtered to only include these serials.
     */
    readonly serials?: 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.getUplinksStatuses({
 *     endingBefore: "string",
 *     iccids: ["string"],
 *     networkIds: ["string"],
 *     organizationId: "string",
 *     perPage: 1,
 *     serials: ["string"],
 *     startingAfter: "string",
 * });
 * export const merakiOrganizationsUplinksStatusesExample = example.then(example => example.items);
 * ```
 */
export declare function getUplinksStatusesOutput(args: GetUplinksStatusesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUplinksStatusesResult>;
/**
 * A collection of arguments for invoking getUplinksStatuses.
 */
export interface GetUplinksStatusesOutputArgs {
    /**
     * 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>;
    /**
     * iccids query parameter. A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs.
     */
    iccids?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * networkIds query parameter. A list of network IDs. The returned devices will be filtered to only include these networks.
     */
    networkIds?: pulumi.Input<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 1000. Default is 1000.
     */
    perPage?: pulumi.Input<number>;
    /**
     * serials query parameter. A list of serial numbers. The returned devices will be filtered to only include these serials.
     */
    serials?: pulumi.Input<pulumi.Input<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?: pulumi.Input<string>;
}