1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. Team
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi

pagerduty.Team

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi

    A team is a collection of users and escalation policies that represent a group of people within an organization.

    The account must have the teams ability to use the following resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as pagerduty from "@pulumi/pagerduty";
    
    const parent = new pagerduty.Team("parent", {
        name: "Product Development",
        description: "Product and Engineering",
    });
    const example = new pagerduty.Team("example", {
        name: "Engineering",
        description: "All engineering",
        parent: parent.id,
    });
    
    import pulumi
    import pulumi_pagerduty as pagerduty
    
    parent = pagerduty.Team("parent",
        name="Product Development",
        description="Product and Engineering")
    example = pagerduty.Team("example",
        name="Engineering",
        description="All engineering",
        parent=parent.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		parent, err := pagerduty.NewTeam(ctx, "parent", &pagerduty.TeamArgs{
    			Name:        pulumi.String("Product Development"),
    			Description: pulumi.String("Product and Engineering"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = pagerduty.NewTeam(ctx, "example", &pagerduty.TeamArgs{
    			Name:        pulumi.String("Engineering"),
    			Description: pulumi.String("All engineering"),
    			Parent:      parent.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Pagerduty = Pulumi.Pagerduty;
    
    return await Deployment.RunAsync(() => 
    {
        var parent = new Pagerduty.Team("parent", new()
        {
            Name = "Product Development",
            Description = "Product and Engineering",
        });
    
        var example = new Pagerduty.Team("example", new()
        {
            Name = "Engineering",
            Description = "All engineering",
            Parent = parent.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.pagerduty.Team;
    import com.pulumi.pagerduty.TeamArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var parent = new Team("parent", TeamArgs.builder()
                .name("Product Development")
                .description("Product and Engineering")
                .build());
    
            var example = new Team("example", TeamArgs.builder()
                .name("Engineering")
                .description("All engineering")
                .parent(parent.id())
                .build());
    
        }
    }
    
    resources:
      parent:
        type: pagerduty:Team
        properties:
          name: Product Development
          description: Product and Engineering
      example:
        type: pagerduty:Team
        properties:
          name: Engineering
          description: All engineering
          parent: ${parent.id}
    

    Create Team Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Team(name: string, args?: TeamArgs, opts?: CustomResourceOptions);
    @overload
    def Team(resource_name: str,
             args: Optional[TeamArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Team(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             default_role: Optional[str] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             parent: Optional[str] = None)
    func NewTeam(ctx *Context, name string, args *TeamArgs, opts ...ResourceOption) (*Team, error)
    public Team(string name, TeamArgs? args = null, CustomResourceOptions? opts = null)
    public Team(String name, TeamArgs args)
    public Team(String name, TeamArgs args, CustomResourceOptions options)
    
    type: pagerduty:Team
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var teamResource = new Pagerduty.Team("teamResource", new()
    {
        DefaultRole = "string",
        Description = "string",
        Name = "string",
        Parent = "string",
    });
    
    example, err := pagerduty.NewTeam(ctx, "teamResource", &pagerduty.TeamArgs{
    	DefaultRole: pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Parent:      pulumi.String("string"),
    })
    
    var teamResource = new Team("teamResource", TeamArgs.builder()
        .defaultRole("string")
        .description("string")
        .name("string")
        .parent("string")
        .build());
    
    team_resource = pagerduty.Team("teamResource",
        default_role="string",
        description="string",
        name="string",
        parent="string")
    
    const teamResource = new pagerduty.Team("teamResource", {
        defaultRole: "string",
        description: "string",
        name: "string",
        parent: "string",
    });
    
    type: pagerduty:Team
    properties:
        defaultRole: string
        description: string
        name: string
        parent: string
    

    Team Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Team resource accepts the following input properties:

    DefaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    Description string
    Name string
    The name of the group.
    Parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    DefaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    Description string
    Name string
    The name of the group.
    Parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole String
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description String
    name String
    The name of the group.
    parent String
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description string
    name string
    The name of the group.
    parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    default_role str
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description str
    name str
    The name of the group.
    parent str
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole String
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description String
    name String
    The name of the group.
    parent String
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Team resource produces the following output properties:

    HtmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    Id string
    The provider-assigned unique ID for this managed resource.
    HtmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    Id string
    The provider-assigned unique ID for this managed resource.
    htmlUrl String
    URL at which the entity is uniquely displayed in the Web app
    id String
    The provider-assigned unique ID for this managed resource.
    htmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    id string
    The provider-assigned unique ID for this managed resource.
    html_url str
    URL at which the entity is uniquely displayed in the Web app
    id str
    The provider-assigned unique ID for this managed resource.
    htmlUrl String
    URL at which the entity is uniquely displayed in the Web app
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Team Resource

    Get an existing Team resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TeamState, opts?: CustomResourceOptions): Team
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_role: Optional[str] = None,
            description: Optional[str] = None,
            html_url: Optional[str] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None) -> Team
    func GetTeam(ctx *Context, name string, id IDInput, state *TeamState, opts ...ResourceOption) (*Team, error)
    public static Team Get(string name, Input<string> id, TeamState? state, CustomResourceOptions? opts = null)
    public static Team get(String name, Output<String> id, TeamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    Description string
    HtmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    Name string
    The name of the group.
    Parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    DefaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    Description string
    HtmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    Name string
    The name of the group.
    Parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole String
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description String
    htmlUrl String
    URL at which the entity is uniquely displayed in the Web app
    name String
    The name of the group.
    parent String
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole string
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description string
    htmlUrl string
    URL at which the entity is uniquely displayed in the Web app
    name string
    The name of the group.
    parent string
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    default_role str
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description str
    html_url str
    URL at which the entity is uniquely displayed in the Web app
    name str
    The name of the group.
    parent str
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
    defaultRole String
    The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
    description String
    htmlUrl String
    URL at which the entity is uniquely displayed in the Web app
    name String
    The name of the group.
    parent String
    ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.

    Import

    Teams can be imported using the id, e.g.

    $ pulumi import pagerduty:index/team:Team main PLBP09X
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi