1. Packages
  2. Port
  3. API Docs
  4. Team
Port v2.6.1 published on Thursday, Apr 17, 2025 by port-labs

port.Team

Explore with Pulumi AI

Team resource

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: TeamArgs,
         opts: Optional[ResourceOptions] = None)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TeamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TeamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TeamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 Port.Team("teamResource", new()
{
    Name = "string",
    Description = "string",
    Users = new[]
    {
        "string",
    },
});
Copy
example, err := port.NewTeam(ctx, "teamResource", &port.TeamArgs{
	Name:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var teamResource = new Team("teamResource", TeamArgs.builder()
    .name("string")
    .description("string")
    .users("string")
    .build());
Copy
team_resource = port.Team("teamResource",
    name="string",
    description="string",
    users=["string"])
Copy
const teamResource = new port.Team("teamResource", {
    name: "string",
    description: "string",
    users: ["string"],
});
Copy
type: port:Team
properties:
    description: string
    name: string
    users:
        - string
Copy

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:

Name This property is required. string
The name of the team
Description string
The description of the team
Users List<string>
The users of the team
Name This property is required. string
The name of the team
Description string
The description of the team
Users []string
The users of the team
name This property is required. String
The name of the team
description String
The description of the team
users List<String>
The users of the team
name This property is required. string
The name of the team
description string
The description of the team
users string[]
The users of the team
name This property is required. str
The name of the team
description str
The description of the team
users Sequence[str]
The users of the team
name This property is required. String
The name of the team
description String
The description of the team
users List<String>
The users of the team

Outputs

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

CreatedAt string
The creation date of the team
Id string
The provider-assigned unique ID for this managed resource.
Identifier string
The machine-readable identifier of the _team entity
ProviderName string
The provider of the team
UpdatedAt string
The last update date of the team
CreatedAt string
The creation date of the team
Id string
The provider-assigned unique ID for this managed resource.
Identifier string
The machine-readable identifier of the _team entity
ProviderName string
The provider of the team
UpdatedAt string
The last update date of the team
createdAt String
The creation date of the team
id String
The provider-assigned unique ID for this managed resource.
identifier String
The machine-readable identifier of the _team entity
providerName String
The provider of the team
updatedAt String
The last update date of the team
createdAt string
The creation date of the team
id string
The provider-assigned unique ID for this managed resource.
identifier string
The machine-readable identifier of the _team entity
providerName string
The provider of the team
updatedAt string
The last update date of the team
created_at str
The creation date of the team
id str
The provider-assigned unique ID for this managed resource.
identifier str
The machine-readable identifier of the _team entity
provider_name str
The provider of the team
updated_at str
The last update date of the team
createdAt String
The creation date of the team
id String
The provider-assigned unique ID for this managed resource.
identifier String
The machine-readable identifier of the _team entity
providerName String
The provider of the team
updatedAt String
The last update date 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,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        provider_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        users: 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: port:Team    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
The creation date of the team
Description string
The description of the team
Identifier string
The machine-readable identifier of the _team entity
Name string
The name of the team
ProviderName string
The provider of the team
UpdatedAt string
The last update date of the team
Users List<string>
The users of the team
CreatedAt string
The creation date of the team
Description string
The description of the team
Identifier string
The machine-readable identifier of the _team entity
Name string
The name of the team
ProviderName string
The provider of the team
UpdatedAt string
The last update date of the team
Users []string
The users of the team
createdAt String
The creation date of the team
description String
The description of the team
identifier String
The machine-readable identifier of the _team entity
name String
The name of the team
providerName String
The provider of the team
updatedAt String
The last update date of the team
users List<String>
The users of the team
createdAt string
The creation date of the team
description string
The description of the team
identifier string
The machine-readable identifier of the _team entity
name string
The name of the team
providerName string
The provider of the team
updatedAt string
The last update date of the team
users string[]
The users of the team
created_at str
The creation date of the team
description str
The description of the team
identifier str
The machine-readable identifier of the _team entity
name str
The name of the team
provider_name str
The provider of the team
updated_at str
The last update date of the team
users Sequence[str]
The users of the team
createdAt String
The creation date of the team
description String
The description of the team
identifier String
The machine-readable identifier of the _team entity
name String
The name of the team
providerName String
The provider of the team
updatedAt String
The last update date of the team
users List<String>
The users of the team

Package Details

Repository
port port-labs/pulumi-port
License
Apache-2.0
Notes
This Pulumi package is based on the port-labs Terraform Provider.