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

octopusdeploy.TenantProjectVariable

Explore with Pulumi AI

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

    Manages a tenant project variable in Octopus Deploy.

    Create TenantProjectVariable Resource

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

    Constructor syntax

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

@overload
def TenantProjectVariable(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          environment_id: Optional[str] = None,
                          project_id: Optional[str] = None,
                          template_id: Optional[str] = None,
                          tenant_id: Optional[str] = None,
                          space_id: Optional[str] = None,
                          value: Optional[str] = None)
    func NewTenantProjectVariable(ctx *Context, name string, args TenantProjectVariableArgs, opts ...ResourceOption) (*TenantProjectVariable, error)
    public TenantProjectVariable(string name, TenantProjectVariableArgs args, CustomResourceOptions? opts = null)
    public TenantProjectVariable(String name, TenantProjectVariableArgs args)
public TenantProjectVariable(String name, TenantProjectVariableArgs args, CustomResourceOptions options)

    type: octopusdeploy:TenantProjectVariable
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 TenantProjectVariableArgs
    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 TenantProjectVariableArgs
    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 TenantProjectVariableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantProjectVariableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantProjectVariableArgs
    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 tenantProjectVariableResource = new Octopusdeploy.TenantProjectVariable("tenantProjectVariableResource", new()
{
    EnvironmentId = "string",
    ProjectId = "string",
    TemplateId = "string",
    TenantId = "string",
    SpaceId = "string",
    Value = "string",
});

    example, err := octopusdeploy.NewTenantProjectVariable(ctx, "tenantProjectVariableResource", &octopusdeploy.TenantProjectVariableArgs{
	EnvironmentId: pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	TemplateId:    pulumi.String("string"),
	TenantId:      pulumi.String("string"),
	SpaceId:       pulumi.String("string"),
	Value:         pulumi.String("string"),
})

    var tenantProjectVariableResource = new TenantProjectVariable("tenantProjectVariableResource", TenantProjectVariableArgs.builder()
    .environmentId("string")
    .projectId("string")
    .templateId("string")
    .tenantId("string")
    .spaceId("string")
    .value("string")
    .build());

    tenant_project_variable_resource = octopusdeploy.TenantProjectVariable("tenantProjectVariableResource",
    environment_id="string",
    project_id="string",
    template_id="string",
    tenant_id="string",
    space_id="string",
    value="string")

    const tenantProjectVariableResource = new octopusdeploy.TenantProjectVariable("tenantProjectVariableResource", {
    environmentId: "string",
    projectId: "string",
    templateId: "string",
    tenantId: "string",
    spaceId: "string",
    value: "string",
});

    type: octopusdeploy:TenantProjectVariable
properties:
    environmentId: string
    projectId: string
    spaceId: string
    templateId: string
    tenantId: string
    value: string

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

    EnvironmentId string
    The ID of the environment.
    ProjectId string
    The ID of the project.
    TemplateId string
    The ID of the variable template.
    TenantId string
    The ID of the tenant.
    SpaceId string
    The space ID associated with this Tenant Project Variable.
    Value string
    The value of the variable.
    EnvironmentId string
    The ID of the environment.
    ProjectId string
    The ID of the project.
    TemplateId string
    The ID of the variable template.
    TenantId string
    The ID of the tenant.
    SpaceId string
    The space ID associated with this Tenant Project Variable.
    Value string
    The value of the variable.
    environmentId String
    The ID of the environment.
    projectId String
    The ID of the project.
    templateId String
    The ID of the variable template.
    tenantId String
    The ID of the tenant.
    spaceId String
    The space ID associated with this Tenant Project Variable.
    value String
    The value of the variable.
    environmentId string
    The ID of the environment.
    projectId string
    The ID of the project.
    templateId string
    The ID of the variable template.
    tenantId string
    The ID of the tenant.
    spaceId string
    The space ID associated with this Tenant Project Variable.
    value string
    The value of the variable.
    environment_id str
    The ID of the environment.
    project_id str
    The ID of the project.
    template_id str
    The ID of the variable template.
    tenant_id str
    The ID of the tenant.
    space_id str
    The space ID associated with this Tenant Project Variable.
    value str
    The value of the variable.
    environmentId String
    The ID of the environment.
    projectId String
    The ID of the project.
    templateId String
    The ID of the variable template.
    tenantId String
    The ID of the tenant.
    spaceId String
    The space ID associated with this Tenant Project Variable.
    value String
    The value of the variable.

    Outputs

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

    Get an existing TenantProjectVariable 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?: TenantProjectVariableState, opts?: CustomResourceOptions): TenantProjectVariable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        environment_id: Optional[str] = None,
        project_id: Optional[str] = None,
        space_id: Optional[str] = None,
        template_id: Optional[str] = None,
        tenant_id: Optional[str] = None,
        value: Optional[str] = None) -> TenantProjectVariable
    func GetTenantProjectVariable(ctx *Context, name string, id IDInput, state *TenantProjectVariableState, opts ...ResourceOption) (*TenantProjectVariable, error)
    public static TenantProjectVariable Get(string name, Input<string> id, TenantProjectVariableState? state, CustomResourceOptions? opts = null)
    public static TenantProjectVariable get(String name, Output<String> id, TenantProjectVariableState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:TenantProjectVariable    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:
    EnvironmentId string
    The ID of the environment.
    ProjectId string
    The ID of the project.
    SpaceId string
    The space ID associated with this Tenant Project Variable.
    TemplateId string
    The ID of the variable template.
    TenantId string
    The ID of the tenant.
    Value string
    The value of the variable.
    EnvironmentId string
    The ID of the environment.
    ProjectId string
    The ID of the project.
    SpaceId string
    The space ID associated with this Tenant Project Variable.
    TemplateId string
    The ID of the variable template.
    TenantId string
    The ID of the tenant.
    Value string
    The value of the variable.
    environmentId String
    The ID of the environment.
    projectId String
    The ID of the project.
    spaceId String
    The space ID associated with this Tenant Project Variable.
    templateId String
    The ID of the variable template.
    tenantId String
    The ID of the tenant.
    value String
    The value of the variable.
    environmentId string
    The ID of the environment.
    projectId string
    The ID of the project.
    spaceId string
    The space ID associated with this Tenant Project Variable.
    templateId string
    The ID of the variable template.
    tenantId string
    The ID of the tenant.
    value string
    The value of the variable.
    environment_id str
    The ID of the environment.
    project_id str
    The ID of the project.
    space_id str
    The space ID associated with this Tenant Project Variable.
    template_id str
    The ID of the variable template.
    tenant_id str
    The ID of the tenant.
    value str
    The value of the variable.
    environmentId String
    The ID of the environment.
    projectId String
    The ID of the project.
    spaceId String
    The space ID associated with this Tenant Project Variable.
    templateId String
    The ID of the variable template.
    tenantId String
    The ID of the tenant.
    value String
    The value of the variable.

    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