UNPKG

@pulumi/pagerduty

Version:

A Pulumi package for creating and managing pagerduty cloud resources.

95 lines (94 loc) 3.08 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Use this data source to get information about [list of users](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIzMw-list-users) that you can use for other PagerDuty resources, optionally filtering by team ids. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as pagerduty from "@pulumi/pagerduty"; * * const devops = pagerduty.getTeam({ * name: "devops", * }); * const me = pagerduty.getUser({ * email: "me@example.com", * }); * const exampleWTeam = new pagerduty.User("example_w_team", { * name: "user-with-team", * email: "user-with-team@example.com", * }); * const example = new pagerduty.TeamMembership("example", { * teamId: devopsPagerdutyTeam.id, * userId: exampleWTeam.id, * }); * const allUsers = pagerduty.getUsers({}); * const fromDevopsTeam = pagerduty.getUsers({ * teamIds: [devopsPagerdutyTeam.id], * }); * ``` */ export declare function getUsers(args?: GetUsersArgs, opts?: pulumi.InvokeOptions): Promise<GetUsersResult>; /** * A collection of arguments for invoking getUsers. */ export interface GetUsersArgs { /** * List of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. */ teamIds?: string[]; } /** * A collection of values returned by getUsers. */ export interface GetUsersResult { /** * The ID of the found user. */ readonly id: string; readonly teamIds?: string[]; /** * List of users queried. */ readonly users: outputs.GetUsersUser[]; } /** * Use this data source to get information about [list of users](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIzMw-list-users) that you can use for other PagerDuty resources, optionally filtering by team ids. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as pagerduty from "@pulumi/pagerduty"; * * const devops = pagerduty.getTeam({ * name: "devops", * }); * const me = pagerduty.getUser({ * email: "me@example.com", * }); * const exampleWTeam = new pagerduty.User("example_w_team", { * name: "user-with-team", * email: "user-with-team@example.com", * }); * const example = new pagerduty.TeamMembership("example", { * teamId: devopsPagerdutyTeam.id, * userId: exampleWTeam.id, * }); * const allUsers = pagerduty.getUsers({}); * const fromDevopsTeam = pagerduty.getUsers({ * teamIds: [devopsPagerdutyTeam.id], * }); * ``` */ export declare function getUsersOutput(args?: GetUsersOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUsersResult>; /** * A collection of arguments for invoking getUsers. */ export interface GetUsersOutputArgs { /** * List of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. */ teamIds?: pulumi.Input<pulumi.Input<string>[]>; }