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 5.34 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.getPolicyObjectsGroups({ * endingBefore: "string", * organizationId: "string", * perPage: 1, * startingAfter: "string", * }); * export const merakiOrganizationsPolicyObjectsGroupsExample = example.then(example => example.item); * ``` */ export declare function getPolicyObjectsGroups(args?: GetPolicyObjectsGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetPolicyObjectsGroupsResult>; /** * A collection of arguments for invoking getPolicyObjectsGroups. */ export interface GetPolicyObjectsGroupsArgs { /** * 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 1000. Default is 1000. */ perPage?: number; /** * policyObjectGroupId path parameter. Policy object group ID */ policyObjectGroupId?: 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 getPolicyObjectsGroups. */ export interface GetPolicyObjectsGroupsResult { /** * 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.GetPolicyObjectsGroupsItem; /** * organizationId path parameter. Organization ID */ readonly organizationId?: string; /** * perPage query parameter. The number of entries per page returned. Acceptable range is 10 1000. Default is 1000. */ readonly perPage?: number; /** * policyObjectGroupId path parameter. Policy object group ID */ readonly policyObjectGroupId?: 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.getPolicyObjectsGroups({ * endingBefore: "string", * organizationId: "string", * perPage: 1, * startingAfter: "string", * }); * export const merakiOrganizationsPolicyObjectsGroupsExample = example.then(example => example.item); * ``` */ export declare function getPolicyObjectsGroupsOutput(args?: GetPolicyObjectsGroupsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPolicyObjectsGroupsResult>; /** * A collection of arguments for invoking getPolicyObjectsGroups. */ export interface GetPolicyObjectsGroupsOutputArgs { /** * 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 | undefined>; /** * perPage query parameter. The number of entries per page returned. Acceptable range is 10 1000. Default is 1000. */ perPage?: pulumi.Input<number | undefined>; /** * policyObjectGroupId path parameter. Policy object group ID */ policyObjectGroupId?: 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=getPolicyObjectsGroups.d.ts.map