1. Packages
  2. Vantage Provider
  3. API Docs
  4. Team
vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh

vantage.Team

Explore with Pulumi AI

vantage logo
vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vantage from "@pulumi/vantage";
    
    const demoTeam = new vantage.Team("demoTeam", {
        description: "Demo Team Description",
        userEmails: ["support@vantage.sh"],
        workspaceTokens: ["wrkspc_47c3254c790e9351"],
    });
    
    import pulumi
    import pulumi_vantage as vantage
    
    demo_team = vantage.Team("demoTeam",
        description="Demo Team Description",
        user_emails=["support@vantage.sh"],
        workspace_tokens=["wrkspc_47c3254c790e9351"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vantage.NewTeam(ctx, "demoTeam", &vantage.TeamArgs{
    			Description: pulumi.String("Demo Team Description"),
    			UserEmails: pulumi.StringArray{
    				pulumi.String("support@vantage.sh"),
    			},
    			WorkspaceTokens: pulumi.StringArray{
    				pulumi.String("wrkspc_47c3254c790e9351"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vantage = Pulumi.Vantage;
    
    return await Deployment.RunAsync(() => 
    {
        var demoTeam = new Vantage.Team("demoTeam", new()
        {
            Description = "Demo Team Description",
            UserEmails = new[]
            {
                "support@vantage.sh",
            },
            WorkspaceTokens = new[]
            {
                "wrkspc_47c3254c790e9351",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vantage.Team;
    import com.pulumi.vantage.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 demoTeam = new Team("demoTeam", TeamArgs.builder()
                .description("Demo Team Description")
                .userEmails("support@vantage.sh")
                .workspaceTokens("wrkspc_47c3254c790e9351")
                .build());
    
        }
    }
    
    resources:
      demoTeam:
        type: vantage:Team
        properties:
          description: Demo Team Description
          userEmails:
            - support@vantage.sh
          workspaceTokens:
            - wrkspc_47c3254c790e9351
    

    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,
             description: Optional[str] = None,
             name: Optional[str] = None,
             role: Optional[str] = None,
             user_emails: Optional[Sequence[str]] = None,
             user_tokens: Optional[Sequence[str]] = None,
             workspace_tokens: Optional[Sequence[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: vantage: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 Vantage.Team("teamResource", new()
    {
        Description = "string",
        Name = "string",
        Role = "string",
        UserEmails = new[]
        {
            "string",
        },
        UserTokens = new[]
        {
            "string",
        },
        WorkspaceTokens = new[]
        {
            "string",
        },
    });
    
    example, err := vantage.NewTeam(ctx, "teamResource", &vantage.TeamArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Role:        pulumi.String("string"),
    	UserEmails: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkspaceTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var teamResource = new Team("teamResource", TeamArgs.builder()
        .description("string")
        .name("string")
        .role("string")
        .userEmails("string")
        .userTokens("string")
        .workspaceTokens("string")
        .build());
    
    team_resource = vantage.Team("teamResource",
        description="string",
        name="string",
        role="string",
        user_emails=["string"],
        user_tokens=["string"],
        workspace_tokens=["string"])
    
    const teamResource = new vantage.Team("teamResource", {
        description: "string",
        name: "string",
        role: "string",
        userEmails: ["string"],
        userTokens: ["string"],
        workspaceTokens: ["string"],
    });
    
    type: vantage:Team
    properties:
        description: string
        name: string
        role: string
        userEmails:
            - string
        userTokens:
            - string
        workspaceTokens:
            - 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:

    Description string
    The description of the Team.
    Name string
    The name of the Team.
    Role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    UserEmails List<string>
    The User emails to associate to the Team.
    UserTokens List<string>
    The User tokens to associate to the Team.
    WorkspaceTokens List<string>
    The Workspace tokens to associate to the Team.
    Description string
    The description of the Team.
    Name string
    The name of the Team.
    Role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    UserEmails []string
    The User emails to associate to the Team.
    UserTokens []string
    The User tokens to associate to the Team.
    WorkspaceTokens []string
    The Workspace tokens to associate to the Team.
    description String
    The description of the Team.
    name String
    The name of the Team.
    role String
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    userEmails List<String>
    The User emails to associate to the Team.
    userTokens List<String>
    The User tokens to associate to the Team.
    workspaceTokens List<String>
    The Workspace tokens to associate to the Team.
    description string
    The description of the Team.
    name string
    The name of the Team.
    role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    userEmails string[]
    The User emails to associate to the Team.
    userTokens string[]
    The User tokens to associate to the Team.
    workspaceTokens string[]
    The Workspace tokens to associate to the Team.
    description str
    The description of the Team.
    name str
    The name of the Team.
    role str
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    user_emails Sequence[str]
    The User emails to associate to the Team.
    user_tokens Sequence[str]
    The User tokens to associate to the Team.
    workspace_tokens Sequence[str]
    The Workspace tokens to associate to the Team.
    description String
    The description of the Team.
    name String
    The name of the Team.
    role String
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    userEmails List<String>
    The User emails to associate to the Team.
    userTokens List<String>
    The User tokens to associate to the Team.
    workspaceTokens List<String>
    The Workspace tokens to associate to the Team.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the Team
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the Team
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the Team
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the Team
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the Team
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the Team

    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,
            description: Optional[str] = None,
            name: Optional[str] = None,
            role: Optional[str] = None,
            token: Optional[str] = None,
            user_emails: Optional[Sequence[str]] = None,
            user_tokens: Optional[Sequence[str]] = None,
            workspace_tokens: Optional[Sequence[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)
    resources:  _:    type: vantage:Team    get:      id: ${id}
    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:
    Description string
    The description of the Team.
    Name string
    The name of the Team.
    Role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    Token string
    The token of the Team
    UserEmails List<string>
    The User emails to associate to the Team.
    UserTokens List<string>
    The User tokens to associate to the Team.
    WorkspaceTokens List<string>
    The Workspace tokens to associate to the Team.
    Description string
    The description of the Team.
    Name string
    The name of the Team.
    Role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    Token string
    The token of the Team
    UserEmails []string
    The User emails to associate to the Team.
    UserTokens []string
    The User tokens to associate to the Team.
    WorkspaceTokens []string
    The Workspace tokens to associate to the Team.
    description String
    The description of the Team.
    name String
    The name of the Team.
    role String
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    token String
    The token of the Team
    userEmails List<String>
    The User emails to associate to the Team.
    userTokens List<String>
    The User tokens to associate to the Team.
    workspaceTokens List<String>
    The Workspace tokens to associate to the Team.
    description string
    The description of the Team.
    name string
    The name of the Team.
    role string
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    token string
    The token of the Team
    userEmails string[]
    The User emails to associate to the Team.
    userTokens string[]
    The User tokens to associate to the Team.
    workspaceTokens string[]
    The Workspace tokens to associate to the Team.
    description str
    The description of the Team.
    name str
    The name of the Team.
    role str
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    token str
    The token of the Team
    user_emails Sequence[str]
    The User emails to associate to the Team.
    user_tokens Sequence[str]
    The User tokens to associate to the Team.
    workspace_tokens Sequence[str]
    The Workspace tokens to associate to the Team.
    description String
    The description of the Team.
    name String
    The name of the Team.
    role String
    The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
    token String
    The token of the Team
    userEmails List<String>
    The User emails to associate to the Team.
    userTokens List<String>
    The User tokens to associate to the Team.
    workspaceTokens List<String>
    The Workspace tokens to associate to the Team.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh