UNPKG

@pulumi/meraki

Version:

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

117 lines (116 loc) 5.08 kB
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.getPolicyObjects({ * endingBefore: "string", * organizationId: "string", * perPage: 1, * startingAfter: "string", * }); * export const merakiOrganizationsPolicyObjectsExample = example.then(example => example.item); * ``` */ export declare function getPolicyObjects(args?: GetPolicyObjectsArgs, opts?: pulumi.InvokeOptions): Promise<GetPolicyObjectsResult>; /** * A collection of arguments for invoking getPolicyObjects. */ export interface GetPolicyObjectsArgs { /** * 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 10 5000. Default is 5000. */ perPage?: number; /** * policyObjectId path parameter. Policy object ID */ policyObjectId?: 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 getPolicyObjects. */ export interface GetPolicyObjectsResult { /** * 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.GetPolicyObjectsItem; /** * organizationId path parameter. Organization ID */ readonly organizationId?: string; /** * perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000. */ readonly perPage?: number; /** * policyObjectId path parameter. Policy object ID */ readonly policyObjectId?: 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.getPolicyObjects({ * endingBefore: "string", * organizationId: "string", * perPage: 1, * startingAfter: "string", * }); * export const merakiOrganizationsPolicyObjectsExample = example.then(example => example.item); * ``` */ export declare function getPolicyObjectsOutput(args?: GetPolicyObjectsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPolicyObjectsResult>; /** * A collection of arguments for invoking getPolicyObjects. */ export interface GetPolicyObjectsOutputArgs { /** * 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>; /** * organizationId path parameter. Organization ID */ organizationId?: pulumi.Input<string>; /** * perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000. */ perPage?: pulumi.Input<number>; /** * policyObjectId path parameter. Policy object ID */ policyObjectId?: 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>; }