1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getTenants
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploy.getTenants

Explore with Pulumi AI

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

Provides information about existing tenants.

Using getTenants

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 getTenants(args: GetTenantsArgs, opts?: InvokeOptions): Promise<GetTenantsResult>
function getTenantsOutput(args: GetTenantsOutputArgs, opts?: InvokeOptions): Output<GetTenantsResult>
Copy
def get_tenants(cloned_from_tenant_id: Optional[str] = None,
                ids: Optional[Sequence[str]] = None,
                is_clone: Optional[bool] = None,
                is_disabled: Optional[bool] = None,
                name: Optional[str] = None,
                partial_name: Optional[str] = None,
                project_id: Optional[str] = None,
                skip: Optional[float] = None,
                space_id: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                take: Optional[float] = None,
                opts: Optional[InvokeOptions] = None) -> GetTenantsResult
def get_tenants_output(cloned_from_tenant_id: Optional[pulumi.Input[str]] = None,
                ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                is_clone: Optional[pulumi.Input[bool]] = None,
                is_disabled: Optional[pulumi.Input[bool]] = None,
                name: Optional[pulumi.Input[str]] = None,
                partial_name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                skip: Optional[pulumi.Input[float]] = None,
                space_id: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                take: Optional[pulumi.Input[float]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetTenantsResult]
Copy
func GetTenants(ctx *Context, args *GetTenantsArgs, opts ...InvokeOption) (*GetTenantsResult, error)
func GetTenantsOutput(ctx *Context, args *GetTenantsOutputArgs, opts ...InvokeOption) GetTenantsResultOutput
Copy

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

public static class GetTenants 
{
    public static Task<GetTenantsResult> InvokeAsync(GetTenantsArgs args, InvokeOptions? opts = null)
    public static Output<GetTenantsResult> Invoke(GetTenantsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)
public static Output<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: octopusdeploy:index/getTenants:getTenants
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClonedFromTenantId string
A filter to search for a cloned tenant by its ID.
Ids List<string>
A filter to search by a list of IDs.
IsClone bool
A filter to search for cloned resources.
IsDisabled bool
A filter to search by the disabled status of a resource.
Name string
A filter to search by name.
PartialName string
A filter to search by a partial name.
ProjectId string
A filter to search by a project ID.
Skip double
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this tenants.
Tags List<string>
A filter to search by a list of tags.
Take double
A filter to specify the number of items to take (or return) in the response.
ClonedFromTenantId string
A filter to search for a cloned tenant by its ID.
Ids []string
A filter to search by a list of IDs.
IsClone bool
A filter to search for cloned resources.
IsDisabled bool
A filter to search by the disabled status of a resource.
Name string
A filter to search by name.
PartialName string
A filter to search by a partial name.
ProjectId string
A filter to search by a project ID.
Skip float64
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this tenants.
Tags []string
A filter to search by a list of tags.
Take float64
A filter to specify the number of items to take (or return) in the response.
clonedFromTenantId String
A filter to search for a cloned tenant by its ID.
ids List<String>
A filter to search by a list of IDs.
isClone Boolean
A filter to search for cloned resources.
isDisabled Boolean
A filter to search by the disabled status of a resource.
name String
A filter to search by name.
partialName String
A filter to search by a partial name.
projectId String
A filter to search by a project ID.
skip Double
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this tenants.
tags List<String>
A filter to search by a list of tags.
take Double
A filter to specify the number of items to take (or return) in the response.
clonedFromTenantId string
A filter to search for a cloned tenant by its ID.
ids string[]
A filter to search by a list of IDs.
isClone boolean
A filter to search for cloned resources.
isDisabled boolean
A filter to search by the disabled status of a resource.
name string
A filter to search by name.
partialName string
A filter to search by a partial name.
projectId string
A filter to search by a project ID.
skip number
A filter to specify the number of items to skip in the response.
spaceId string
The space ID associated with this tenants.
tags string[]
A filter to search by a list of tags.
take number
A filter to specify the number of items to take (or return) in the response.
cloned_from_tenant_id str
A filter to search for a cloned tenant by its ID.
ids Sequence[str]
A filter to search by a list of IDs.
is_clone bool
A filter to search for cloned resources.
is_disabled bool
A filter to search by the disabled status of a resource.
name str
A filter to search by name.
partial_name str
A filter to search by a partial name.
project_id str
A filter to search by a project ID.
skip float
A filter to specify the number of items to skip in the response.
space_id str
The space ID associated with this tenants.
tags Sequence[str]
A filter to search by a list of tags.
take float
A filter to specify the number of items to take (or return) in the response.
clonedFromTenantId String
A filter to search for a cloned tenant by its ID.
ids List<String>
A filter to search by a list of IDs.
isClone Boolean
A filter to search for cloned resources.
isDisabled Boolean
A filter to search by the disabled status of a resource.
name String
A filter to search by name.
partialName String
A filter to search by a partial name.
projectId String
A filter to search by a project ID.
skip Number
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this tenants.
tags List<String>
A filter to search by a list of tags.
take Number
A filter to specify the number of items to take (or return) in the response.

getTenants Result

The following output properties are available:

Id string
The unique ID for this resource.
SpaceId string
The space ID associated with this tenants.
Tenants List<GetTenantsTenant>
ClonedFromTenantId string
A filter to search for a cloned tenant by its ID.
Ids List<string>
A filter to search by a list of IDs.
IsClone bool
A filter to search for cloned resources.
IsDisabled bool
A filter to search by the disabled status of a resource.
Name string
A filter to search by name.
PartialName string
A filter to search by a partial name.
ProjectId string
A filter to search by a project ID.
Skip double
A filter to specify the number of items to skip in the response.
Tags List<string>
A filter to search by a list of tags.
Take double
A filter to specify the number of items to take (or return) in the response.
Id string
The unique ID for this resource.
SpaceId string
The space ID associated with this tenants.
Tenants []GetTenantsTenant
ClonedFromTenantId string
A filter to search for a cloned tenant by its ID.
Ids []string
A filter to search by a list of IDs.
IsClone bool
A filter to search for cloned resources.
IsDisabled bool
A filter to search by the disabled status of a resource.
Name string
A filter to search by name.
PartialName string
A filter to search by a partial name.
ProjectId string
A filter to search by a project ID.
Skip float64
A filter to specify the number of items to skip in the response.
Tags []string
A filter to search by a list of tags.
Take float64
A filter to specify the number of items to take (or return) in the response.
id String
The unique ID for this resource.
spaceId String
The space ID associated with this tenants.
tenants List<GetTenantsTenant>
clonedFromTenantId String
A filter to search for a cloned tenant by its ID.
ids List<String>
A filter to search by a list of IDs.
isClone Boolean
A filter to search for cloned resources.
isDisabled Boolean
A filter to search by the disabled status of a resource.
name String
A filter to search by name.
partialName String
A filter to search by a partial name.
projectId String
A filter to search by a project ID.
skip Double
A filter to specify the number of items to skip in the response.
tags List<String>
A filter to search by a list of tags.
take Double
A filter to specify the number of items to take (or return) in the response.
id string
The unique ID for this resource.
spaceId string
The space ID associated with this tenants.
tenants GetTenantsTenant[]
clonedFromTenantId string
A filter to search for a cloned tenant by its ID.
ids string[]
A filter to search by a list of IDs.
isClone boolean
A filter to search for cloned resources.
isDisabled boolean
A filter to search by the disabled status of a resource.
name string
A filter to search by name.
partialName string
A filter to search by a partial name.
projectId string
A filter to search by a project ID.
skip number
A filter to specify the number of items to skip in the response.
tags string[]
A filter to search by a list of tags.
take number
A filter to specify the number of items to take (or return) in the response.
id str
The unique ID for this resource.
space_id str
The space ID associated with this tenants.
tenants Sequence[GetTenantsTenant]
cloned_from_tenant_id str
A filter to search for a cloned tenant by its ID.
ids Sequence[str]
A filter to search by a list of IDs.
is_clone bool
A filter to search for cloned resources.
is_disabled bool
A filter to search by the disabled status of a resource.
name str
A filter to search by name.
partial_name str
A filter to search by a partial name.
project_id str
A filter to search by a project ID.
skip float
A filter to specify the number of items to skip in the response.
tags Sequence[str]
A filter to search by a list of tags.
take float
A filter to specify the number of items to take (or return) in the response.
id String
The unique ID for this resource.
spaceId String
The space ID associated with this tenants.
tenants List<Property Map>
clonedFromTenantId String
A filter to search for a cloned tenant by its ID.
ids List<String>
A filter to search by a list of IDs.
isClone Boolean
A filter to search for cloned resources.
isDisabled Boolean
A filter to search by the disabled status of a resource.
name String
A filter to search by name.
partialName String
A filter to search by a partial name.
projectId String
A filter to search by a project ID.
skip Number
A filter to specify the number of items to skip in the response.
tags List<String>
A filter to search by a list of tags.
take Number
A filter to specify the number of items to take (or return) in the response.

Supporting Types

GetTenantsTenant

ClonedFromTenantId This property is required. string
The ID of the tenant from which this tenant was cloned.
Description This property is required. string
The description of this tenants.
Id This property is required. string
The unique ID for this resource.
IsDisabled This property is required. bool
The disabled status of this tenant.
Name This property is required. string
The name of this resource.
SpaceId This property is required. string
The space ID associated with this tenant.
TenantTags This property is required. List<string>
A list of tenant tags associated with this resource.
ClonedFromTenantId This property is required. string
The ID of the tenant from which this tenant was cloned.
Description This property is required. string
The description of this tenants.
Id This property is required. string
The unique ID for this resource.
IsDisabled This property is required. bool
The disabled status of this tenant.
Name This property is required. string
The name of this resource.
SpaceId This property is required. string
The space ID associated with this tenant.
TenantTags This property is required. []string
A list of tenant tags associated with this resource.
clonedFromTenantId This property is required. String
The ID of the tenant from which this tenant was cloned.
description This property is required. String
The description of this tenants.
id This property is required. String
The unique ID for this resource.
isDisabled This property is required. Boolean
The disabled status of this tenant.
name This property is required. String
The name of this resource.
spaceId This property is required. String
The space ID associated with this tenant.
tenantTags This property is required. List<String>
A list of tenant tags associated with this resource.
clonedFromTenantId This property is required. string
The ID of the tenant from which this tenant was cloned.
description This property is required. string
The description of this tenants.
id This property is required. string
The unique ID for this resource.
isDisabled This property is required. boolean
The disabled status of this tenant.
name This property is required. string
The name of this resource.
spaceId This property is required. string
The space ID associated with this tenant.
tenantTags This property is required. string[]
A list of tenant tags associated with this resource.
cloned_from_tenant_id This property is required. str
The ID of the tenant from which this tenant was cloned.
description This property is required. str
The description of this tenants.
id This property is required. str
The unique ID for this resource.
is_disabled This property is required. bool
The disabled status of this tenant.
name This property is required. str
The name of this resource.
space_id This property is required. str
The space ID associated with this tenant.
tenant_tags This property is required. Sequence[str]
A list of tenant tags associated with this resource.
clonedFromTenantId This property is required. String
The ID of the tenant from which this tenant was cloned.
description This property is required. String
The description of this tenants.
id This property is required. String
The unique ID for this resource.
isDisabled This property is required. Boolean
The disabled status of this tenant.
name This property is required. String
The name of this resource.
spaceId This property is required. String
The space ID associated with this tenant.
tenantTags This property is required. List<String>
A list of tenant tags associated with this resource.

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs