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

octopusdeploy.TenantProject

Explore with Pulumi AI

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

    Create TenantProject Resource

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

    Constructor syntax

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

@overload
def TenantProject(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  project_id: Optional[str] = None,
                  tenant_id: Optional[str] = None,
                  environment_ids: Optional[Sequence[str]] = None,
                  space_id: Optional[str] = None)
    func NewTenantProject(ctx *Context, name string, args TenantProjectArgs, opts ...ResourceOption) (*TenantProject, error)
    public TenantProject(string name, TenantProjectArgs args, CustomResourceOptions? opts = null)
    public TenantProject(String name, TenantProjectArgs args)
public TenantProject(String name, TenantProjectArgs args, CustomResourceOptions options)

    type: octopusdeploy:TenantProject
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 TenantProjectArgs
    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 TenantProjectArgs
    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 TenantProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantProjectArgs
    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 tenantProjectResource = new Octopusdeploy.TenantProject("tenantProjectResource", new()
{
    ProjectId = "string",
    TenantId = "string",
    EnvironmentIds = new[]
    {
        "string",
    },
    SpaceId = "string",
});

    example, err := octopusdeploy.NewTenantProject(ctx, "tenantProjectResource", &octopusdeploy.TenantProjectArgs{
	ProjectId: pulumi.String("string"),
	TenantId:  pulumi.String("string"),
	EnvironmentIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SpaceId: pulumi.String("string"),
})

    var tenantProjectResource = new TenantProject("tenantProjectResource", TenantProjectArgs.builder()
    .projectId("string")
    .tenantId("string")
    .environmentIds("string")
    .spaceId("string")
    .build());

    tenant_project_resource = octopusdeploy.TenantProject("tenantProjectResource",
    project_id="string",
    tenant_id="string",
    environment_ids=["string"],
    space_id="string")

    const tenantProjectResource = new octopusdeploy.TenantProject("tenantProjectResource", {
    projectId: "string",
    tenantId: "string",
    environmentIds: ["string"],
    spaceId: "string",
});

    type: octopusdeploy:TenantProject
properties:
    environmentIds:
        - string
    projectId: string
    spaceId: string
    tenantId: string

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

    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.
    SpaceId string
    The space ID associated with this project tenant.
    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.
    SpaceId string
    The space ID associated with this project tenant.
    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.
    spaceId String
    The space ID associated with this project tenant.
    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.
    spaceId string
    The space ID associated with this project tenant.
    project_id str
    The project ID associated with this tenant.
    tenant_id str
    The tenant ID associated with this tenant.
    environment_ids Sequence[str]
    The environment IDs associated with this tenant.
    space_id str
    The space ID associated with this project tenant.
    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.
    spaceId String
    The space ID associated with this project tenant.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TenantProject 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 TenantProject Resource

    Get an existing TenantProject 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?: TenantProjectState, opts?: CustomResourceOptions): TenantProject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        environment_ids: Optional[Sequence[str]] = None,
        project_id: Optional[str] = None,
        space_id: Optional[str] = None,
        tenant_id: Optional[str] = None) -> TenantProject
    func GetTenantProject(ctx *Context, name string, id IDInput, state *TenantProjectState, opts ...ResourceOption) (*TenantProject, error)
    public static TenantProject Get(string name, Input<string> id, TenantProjectState? state, CustomResourceOptions? opts = null)
    public static TenantProject get(String name, Output<String> id, TenantProjectState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:TenantProject    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:
    EnvironmentIds List<string>
    The environment IDs associated with this tenant.
    ProjectId string
    The project ID associated with this tenant.
    SpaceId string
    The space ID associated with this project tenant.
    TenantId string
    The tenant ID associated with this tenant.
    EnvironmentIds []string
    The environment IDs associated with this tenant.
    ProjectId string
    The project ID associated with this tenant.
    SpaceId string
    The space ID associated with this project tenant.
    TenantId string
    The tenant ID associated with this tenant.
    environmentIds List<String>
    The environment IDs associated with this tenant.
    projectId String
    The project ID associated with this tenant.
    spaceId String
    The space ID associated with this project tenant.
    tenantId String
    The tenant ID associated with this tenant.
    environmentIds string[]
    The environment IDs associated with this tenant.
    projectId string
    The project ID associated with this tenant.
    spaceId string
    The space ID associated with this project tenant.
    tenantId string
    The tenant ID associated with this tenant.
    environment_ids Sequence[str]
    The environment IDs associated with this tenant.
    project_id str
    The project ID associated with this tenant.
    space_id str
    The space ID associated with this project tenant.
    tenant_id str
    The tenant ID associated with this tenant.
    environmentIds List<String>
    The environment IDs associated with this tenant.
    projectId String
    The project ID associated with this tenant.
    spaceId String
    The space ID associated with this project 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
    octopusdeploylabs/terraform-provider-octopusdeploy