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

octopusdeploy.Tenant

Explore with Pulumi AI

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

    This resource manages tenants in Octopus Deploy.

    Create Tenant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Tenant(name: string, args?: TenantArgs, opts?: CustomResourceOptions);
    @overload
def Tenant(resource_name: str,
           args: Optional[TenantArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Tenant(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cloned_from_tenant_id: Optional[str] = None,
           description: Optional[str] = None,
           is_disabled: Optional[bool] = None,
           name: Optional[str] = None,
           space_id: Optional[str] = None,
           tenant_tags: Optional[Sequence[str]] = None)
    func NewTenant(ctx *Context, name string, args *TenantArgs, opts ...ResourceOption) (*Tenant, error)
    public Tenant(string name, TenantArgs? args = null, CustomResourceOptions? opts = null)
    public Tenant(String name, TenantArgs args)
public Tenant(String name, TenantArgs args, CustomResourceOptions options)

    type: octopusdeploy:Tenant
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 TenantArgs
    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 TenantArgs
    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 TenantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantArgs
    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 tenantResource = new Octopusdeploy.Tenant("tenantResource", new()
{
    ClonedFromTenantId = "string",
    Description = "string",
    IsDisabled = false,
    Name = "string",
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewTenant(ctx, "tenantResource", &octopusdeploy.TenantArgs{
	ClonedFromTenantId: pulumi.String("string"),
	Description:        pulumi.String("string"),
	IsDisabled:         pulumi.Bool(false),
	Name:               pulumi.String("string"),
	SpaceId:            pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var tenantResource = new Tenant("tenantResource", TenantArgs.builder()
    .clonedFromTenantId("string")
    .description("string")
    .isDisabled(false)
    .name("string")
    .spaceId("string")
    .tenantTags("string")
    .build());

    tenant_resource = octopusdeploy.Tenant("tenantResource",
    cloned_from_tenant_id="string",
    description="string",
    is_disabled=False,
    name="string",
    space_id="string",
    tenant_tags=["string"])

    const tenantResource = new octopusdeploy.Tenant("tenantResource", {
    clonedFromTenantId: "string",
    description: "string",
    isDisabled: false,
    name: "string",
    spaceId: "string",
    tenantTags: ["string"],
});

    type: octopusdeploy:Tenant
properties:
    clonedFromTenantId: string
    description: string
    isDisabled: false
    name: string
    spaceId: string
    tenantTags:
        - string

    Tenant 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 Tenant resource accepts the following input properties:

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Tenant Resource

    Get an existing Tenant 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?: TenantState, opts?: CustomResourceOptions): Tenant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloned_from_tenant_id: Optional[str] = None,
        description: Optional[str] = None,
        is_disabled: Optional[bool] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None) -> Tenant
    func GetTenant(ctx *Context, name string, id IDInput, state *TenantState, opts ...ResourceOption) (*Tenant, error)
    public static Tenant Get(string name, Input<string> id, TenantState? state, CustomResourceOptions? opts = null)
    public static Tenant get(String name, Output<String> id, TenantState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:Tenant    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:
    ClonedFromTenantId string
    The ID of the tenant from which this tenant was cloned.
    Description string
    The description of this tenant.
    IsDisabled bool
    The disabled status of this tenant.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this tenant.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    ClonedFromTenantId string
    The ID of the tenant from which this tenant was cloned.
    Description string
    The description of this tenant.
    IsDisabled bool
    The disabled status of this tenant.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this tenant.
    TenantTags []string
    A list of tenant tags associated with this resource.
    clonedFromTenantId String
    The ID of the tenant from which this tenant was cloned.
    description String
    The description of this tenant.
    isDisabled Boolean
    The disabled status of this tenant.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this tenant.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    clonedFromTenantId string
    The ID of the tenant from which this tenant was cloned.
    description string
    The description of this tenant.
    isDisabled boolean
    The disabled status of this tenant.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this tenant.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    cloned_from_tenant_id str
    The ID of the tenant from which this tenant was cloned.
    description str
    The description of this tenant.
    is_disabled bool
    The disabled status of this tenant.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this tenant.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    clonedFromTenantId String
    The ID of the tenant from which this tenant was cloned.
    description String
    The description of this tenant.
    isDisabled Boolean
    The disabled status of this tenant.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this tenant.
    tenantTags 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 logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy