Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getTeams
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getTeams

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    Provides information about existing users.

    Using getTeams

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTeams(args: GetTeamsArgs, opts?: InvokeOptions): Promise<GetTeamsResult>
function getTeamsOutput(args: GetTeamsOutputArgs, opts?: InvokeOptions): Output<GetTeamsResult>
    def get_teams(ids: Optional[Sequence[str]] = None,
              include_system: Optional[bool] = None,
              partial_name: Optional[str] = None,
              skip: Optional[float] = None,
              spaces: Optional[Sequence[str]] = None,
              take: Optional[float] = None,
              opts: Optional[InvokeOptions] = None) -> GetTeamsResult
def get_teams_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              include_system: Optional[pulumi.Input[bool]] = None,
              partial_name: Optional[pulumi.Input[str]] = None,
              skip: Optional[pulumi.Input[float]] = None,
              spaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              take: Optional[pulumi.Input[float]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTeamsResult]
    func GetTeams(ctx *Context, args *GetTeamsArgs, opts ...InvokeOption) (*GetTeamsResult, error)
func GetTeamsOutput(ctx *Context, args *GetTeamsOutputArgs, opts ...InvokeOption) GetTeamsResultOutput

    > Note: This function is named GetTeams in the Go SDK.

    public static class GetTeams 
{
    public static Task<GetTeamsResult> InvokeAsync(GetTeamsArgs args, InvokeOptions? opts = null)
    public static Output<GetTeamsResult> Invoke(GetTeamsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTeamsResult> getTeams(GetTeamsArgs args, InvokeOptions options)
public static Output<GetTeamsResult> getTeams(GetTeamsArgs args, InvokeOptions options)

    fn::invoke:
  function: octopusdeploy:index/getTeams:getTeams
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A filter to search by a list of IDs.
    IncludeSystem bool
    A filter to include system teams.
    PartialName string
    A filter to search by the partial match of a name.
    Skip double
    A filter to specify the number of items to skip in the response.
    Spaces List<string>
    A filter to search by a list of space IDs.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Ids []string
    A filter to search by a list of IDs.
    IncludeSystem bool
    A filter to include system teams.
    PartialName string
    A filter to search by the partial match of a name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    Spaces []string
    A filter to search by a list of space IDs.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    ids List<String>
    A filter to search by a list of IDs.
    includeSystem Boolean
    A filter to include system teams.
    partialName String
    A filter to search by the partial match of a name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaces List<String>
    A filter to search by a list of space IDs.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    ids string[]
    A filter to search by a list of IDs.
    includeSystem boolean
    A filter to include system teams.
    partialName string
    A filter to search by the partial match of a name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaces string[]
    A filter to search by a list of space IDs.
    take number
    A filter to specify the number of items to take (or return) in the response.
    ids Sequence[str]
    A filter to search by a list of IDs.
    include_system bool
    A filter to include system teams.
    partial_name str
    A filter to search by the partial match of a name.
    skip float
    A filter to specify the number of items to skip in the response.
    spaces Sequence[str]
    A filter to search by a list of space IDs.
    take float
    A filter to specify the number of items to take (or return) in the response.
    ids List<String>
    A filter to search by a list of IDs.
    includeSystem Boolean
    A filter to include system teams.
    partialName String
    A filter to search by the partial match of a name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaces List<String>
    A filter to search by a list of space IDs.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getTeams Result

    The following output properties are available:

    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    Teams List<GetTeamsTeam>
    A list of teams that match the filter(s).
    Ids List<string>
    A filter to search by a list of IDs.
    IncludeSystem bool
    A filter to include system teams.
    PartialName string
    A filter to search by the partial match of a name.
    Skip double
    A filter to specify the number of items to skip in the response.
    Spaces List<string>
    A filter to search by a list of space IDs.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    Teams []GetTeamsTeam
    A list of teams that match the filter(s).
    Ids []string
    A filter to search by a list of IDs.
    IncludeSystem bool
    A filter to include system teams.
    PartialName string
    A filter to search by the partial match of a name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    Spaces []string
    A filter to search by a list of space IDs.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    teams List<GetTeamsTeam>
    A list of teams that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    includeSystem Boolean
    A filter to include system teams.
    partialName String
    A filter to search by the partial match of a name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaces List<String>
    A filter to search by a list of space IDs.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    teams GetTeamsTeam[]
    A list of teams that match the filter(s).
    ids string[]
    A filter to search by a list of IDs.
    includeSystem boolean
    A filter to include system teams.
    partialName string
    A filter to search by the partial match of a name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaces string[]
    A filter to search by a list of space IDs.
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    teams Sequence[GetTeamsTeam]
    A list of teams that match the filter(s).
    ids Sequence[str]
    A filter to search by a list of IDs.
    include_system bool
    A filter to include system teams.
    partial_name str
    A filter to search by the partial match of a name.
    skip float
    A filter to specify the number of items to skip in the response.
    spaces Sequence[str]
    A filter to search by a list of space IDs.
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    teams List<Property Map>
    A list of teams that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    includeSystem Boolean
    A filter to include system teams.
    partialName String
    A filter to search by the partial match of a name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaces List<String>
    A filter to search by a list of space IDs.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetTeamsTeam

    GetTeamsTeamExternalSecurityGroup

    displayIdAndName Boolean
    displayName String
    id String
    displayIdAndName boolean
    displayName string
    id string
    displayIdAndName Boolean
    displayName String
    id String

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy