1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getTenantProjects
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.getTenantProjects

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    Provides information about existing tenants.

    Using getTenantProjects

    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 getTenantProjects(args: GetTenantProjectsArgs, opts?: InvokeOptions): Promise<GetTenantProjectsResult>
    function getTenantProjectsOutput(args: GetTenantProjectsOutputArgs, opts?: InvokeOptions): Output<GetTenantProjectsResult>
    def get_tenant_projects(environment_ids: Optional[Sequence[str]] = None,
                            project_ids: Optional[Sequence[str]] = None,
                            space_id: Optional[str] = None,
                            tenant_ids: Optional[Sequence[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetTenantProjectsResult
    def get_tenant_projects_output(environment_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            project_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            space_id: Optional[pulumi.Input[str]] = None,
                            tenant_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetTenantProjectsResult]
    func GetTenantProjects(ctx *Context, args *GetTenantProjectsArgs, opts ...InvokeOption) (*GetTenantProjectsResult, error)
    func GetTenantProjectsOutput(ctx *Context, args *GetTenantProjectsOutputArgs, opts ...InvokeOption) GetTenantProjectsResultOutput

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

    public static class GetTenantProjects 
    {
        public static Task<GetTenantProjectsResult> InvokeAsync(GetTenantProjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetTenantProjectsResult> Invoke(GetTenantProjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTenantProjectsResult> getTenantProjects(GetTenantProjectsArgs args, InvokeOptions options)
    public static Output<GetTenantProjectsResult> getTenantProjects(GetTenantProjectsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: octopusdeploy:index/getTenantProjects:getTenantProjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EnvironmentIds List<string>
    A filter to search by a list of IDs.
    ProjectIds List<string>
    A filter to search by a list of IDs.
    SpaceId string
    The space ID associated with this tenant projects.
    TenantIds List<string>
    A filter to search by a list of IDs.
    EnvironmentIds []string
    A filter to search by a list of IDs.
    ProjectIds []string
    A filter to search by a list of IDs.
    SpaceId string
    The space ID associated with this tenant projects.
    TenantIds []string
    A filter to search by a list of IDs.
    environmentIds List<String>
    A filter to search by a list of IDs.
    projectIds List<String>
    A filter to search by a list of IDs.
    spaceId String
    The space ID associated with this tenant projects.
    tenantIds List<String>
    A filter to search by a list of IDs.
    environmentIds string[]
    A filter to search by a list of IDs.
    projectIds string[]
    A filter to search by a list of IDs.
    spaceId string
    The space ID associated with this tenant projects.
    tenantIds string[]
    A filter to search by a list of IDs.
    environment_ids Sequence[str]
    A filter to search by a list of IDs.
    project_ids Sequence[str]
    A filter to search by a list of IDs.
    space_id str
    The space ID associated with this tenant projects.
    tenant_ids Sequence[str]
    A filter to search by a list of IDs.
    environmentIds List<String>
    A filter to search by a list of IDs.
    projectIds List<String>
    A filter to search by a list of IDs.
    spaceId String
    The space ID associated with this tenant projects.
    tenantIds List<String>
    A filter to search by a list of IDs.

    getTenantProjects Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    SpaceId string
    The space ID associated with this tenant projects.
    TenantProjects List<GetTenantProjectsTenantProject>
    A list of related tenants, projects and environments that match the filter(s).
    EnvironmentIds List<string>
    A filter to search by a list of IDs.
    ProjectIds List<string>
    A filter to search by a list of IDs.
    TenantIds List<string>
    A filter to search by a list of IDs.
    Id string
    The provider-assigned unique ID for this managed resource.
    SpaceId string
    The space ID associated with this tenant projects.
    TenantProjects []GetTenantProjectsTenantProject
    A list of related tenants, projects and environments that match the filter(s).
    EnvironmentIds []string
    A filter to search by a list of IDs.
    ProjectIds []string
    A filter to search by a list of IDs.
    TenantIds []string
    A filter to search by a list of IDs.
    id String
    The provider-assigned unique ID for this managed resource.
    spaceId String
    The space ID associated with this tenant projects.
    tenantProjects List<GetTenantProjectsTenantProject>
    A list of related tenants, projects and environments that match the filter(s).
    environmentIds List<String>
    A filter to search by a list of IDs.
    projectIds List<String>
    A filter to search by a list of IDs.
    tenantIds List<String>
    A filter to search by a list of IDs.
    id string
    The provider-assigned unique ID for this managed resource.
    spaceId string
    The space ID associated with this tenant projects.
    tenantProjects GetTenantProjectsTenantProject[]
    A list of related tenants, projects and environments that match the filter(s).
    environmentIds string[]
    A filter to search by a list of IDs.
    projectIds string[]
    A filter to search by a list of IDs.
    tenantIds string[]
    A filter to search by a list of IDs.
    id str
    The provider-assigned unique ID for this managed resource.
    space_id str
    The space ID associated with this tenant projects.
    tenant_projects Sequence[GetTenantProjectsTenantProject]
    A list of related tenants, projects and environments that match the filter(s).
    environment_ids Sequence[str]
    A filter to search by a list of IDs.
    project_ids Sequence[str]
    A filter to search by a list of IDs.
    tenant_ids Sequence[str]
    A filter to search by a list of IDs.
    id String
    The provider-assigned unique ID for this managed resource.
    spaceId String
    The space ID associated with this tenant projects.
    tenantProjects List<Property Map>
    A list of related tenants, projects and environments that match the filter(s).
    environmentIds List<String>
    A filter to search by a list of IDs.
    projectIds List<String>
    A filter to search by a list of IDs.
    tenantIds List<String>
    A filter to search by a list of IDs.

    Supporting Types

    GetTenantProjectsTenantProject

    EnvironmentIds List<string>
    The environment IDs associated with this tenant.
    Id string
    The unique ID for this resource.
    ProjectId string
    The project ID associated with this tenant.
    TenantId string
    The tenant ID associated with this tenant.
    EnvironmentIds []string
    The environment IDs associated with this tenant.
    Id string
    The unique ID for this resource.
    ProjectId string
    The project ID associated with this tenant.
    TenantId string
    The tenant ID associated with this tenant.
    environmentIds List<String>
    The environment IDs associated with this tenant.
    id String
    The unique ID for this resource.
    projectId String
    The project ID associated with this tenant.
    tenantId String
    The tenant ID associated with this tenant.
    environmentIds string[]
    The environment IDs associated with this tenant.
    id string
    The unique ID for this resource.
    projectId string
    The project ID associated with this tenant.
    tenantId string
    The tenant ID associated with this tenant.
    environment_ids Sequence[str]
    The environment IDs associated with this tenant.
    id str
    The unique ID for this resource.
    project_id str
    The project ID associated with this tenant.
    tenant_id str
    The tenant ID associated with this tenant.
    environmentIds List<String>
    The environment IDs associated with this tenant.
    id String
    The unique ID for this resource.
    projectId String
    The project ID associated with this tenant.
    tenantId String
    The tenant ID associated with this tenant.

    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