Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. UsernamePasswordAccount
octopusdeploy 0.42.0 published on Tuesday, Apr 15, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.UsernamePasswordAccount

Explore with Pulumi AI

octopusdeploy 0.42.0 published on Tuesday, Apr 15, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

This resource manages username-password accounts in Octopus Deploy.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = new octopusdeploy.UsernamePasswordAccount("example", {
    password: "###########",
    username: "[username]",
});
Copy
import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.UsernamePasswordAccount("example",
    password="###########",
    username="[username]")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewUsernamePasswordAccount(ctx, "example", &octopusdeploy.UsernamePasswordAccountArgs{
			Password: pulumi.String("###########"),
			Username: pulumi.String("[username]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.UsernamePasswordAccount("example", new()
    {
        Password = "###########",
        Username = "[username]",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.UsernamePasswordAccount;
import com.pulumi.octopusdeploy.UsernamePasswordAccountArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UsernamePasswordAccount("example", UsernamePasswordAccountArgs.builder()
            .password("###########")
            .username("[username]")
            .build());

    }
}
Copy
resources:
  example:
    type: octopusdeploy:UsernamePasswordAccount
    properties:
      password: '###########'
      # get from secure environment/store
      username: '[username]'
Copy

Create UsernamePasswordAccount Resource

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

Constructor syntax

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

@overload
def UsernamePasswordAccount(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            username: Optional[str] = None,
                            description: Optional[str] = None,
                            environments: Optional[Sequence[str]] = None,
                            name: Optional[str] = None,
                            password: Optional[str] = None,
                            space_id: Optional[str] = None,
                            tenant_tags: Optional[Sequence[str]] = None,
                            tenanted_deployment_participation: Optional[str] = None,
                            tenants: Optional[Sequence[str]] = None)
func NewUsernamePasswordAccount(ctx *Context, name string, args UsernamePasswordAccountArgs, opts ...ResourceOption) (*UsernamePasswordAccount, error)
public UsernamePasswordAccount(string name, UsernamePasswordAccountArgs args, CustomResourceOptions? opts = null)
public UsernamePasswordAccount(String name, UsernamePasswordAccountArgs args)
public UsernamePasswordAccount(String name, UsernamePasswordAccountArgs args, CustomResourceOptions options)

type: octopusdeploy:UsernamePasswordAccount
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UsernamePasswordAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UsernamePasswordAccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UsernamePasswordAccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UsernamePasswordAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UsernamePasswordAccountArgs
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 usernamePasswordAccountResource = new Octopusdeploy.UsernamePasswordAccount("usernamePasswordAccountResource", new()
{
    Username = "string",
    Description = "string",
    Environments = new[]
    {
        "string",
    },
    Name = "string",
    Password = "string",
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
    TenantedDeploymentParticipation = "string",
    Tenants = new[]
    {
        "string",
    },
});
Copy
example, err := octopusdeploy.NewUsernamePasswordAccount(ctx, "usernamePasswordAccountResource", &octopusdeploy.UsernamePasswordAccountArgs{
Username: pulumi.String("string"),
Description: pulumi.String("string"),
Environments: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Password: pulumi.String("string"),
SpaceId: pulumi.String("string"),
TenantTags: pulumi.StringArray{
pulumi.String("string"),
},
TenantedDeploymentParticipation: pulumi.String("string"),
Tenants: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var usernamePasswordAccountResource = new UsernamePasswordAccount("usernamePasswordAccountResource", UsernamePasswordAccountArgs.builder()
    .username("string")
    .description("string")
    .environments("string")
    .name("string")
    .password("string")
    .spaceId("string")
    .tenantTags("string")
    .tenantedDeploymentParticipation("string")
    .tenants("string")
    .build());
Copy
username_password_account_resource = octopusdeploy.UsernamePasswordAccount("usernamePasswordAccountResource",
    username="string",
    description="string",
    environments=["string"],
    name="string",
    password="string",
    space_id="string",
    tenant_tags=["string"],
    tenanted_deployment_participation="string",
    tenants=["string"])
Copy
const usernamePasswordAccountResource = new octopusdeploy.UsernamePasswordAccount("usernamePasswordAccountResource", {
    username: "string",
    description: "string",
    environments: ["string"],
    name: "string",
    password: "string",
    spaceId: "string",
    tenantTags: ["string"],
    tenantedDeploymentParticipation: "string",
    tenants: ["string"],
});
Copy
type: octopusdeploy:UsernamePasswordAccount
properties:
    description: string
    environments:
        - string
    name: string
    password: string
    spaceId: string
    tenantTags:
        - string
    tenantedDeploymentParticipation: string
    tenants:
        - string
    username: string
Copy

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

Username This property is required. string
The username associated with this resource.
Description string
The description of this username/password account.
Environments List<string>
A list of environment IDs associated with this resource.
Name string
The name of the username-password account.
Password string
The password associated with this resource.
SpaceId string
The space ID associated with this resource.
TenantTags List<string>
A list of tenant tags associated with this resource.
TenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
Tenants List<string>
A list of tenant IDs associated with this resource.
Username This property is required. string
The username associated with this resource.
Description string
The description of this username/password account.
Environments []string
A list of environment IDs associated with this resource.
Name string
The name of the username-password account.
Password string
The password associated with this resource.
SpaceId string
The space ID associated with this resource.
TenantTags []string
A list of tenant tags associated with this resource.
TenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
Tenants []string
A list of tenant IDs associated with this resource.
username This property is required. String
The username associated with this resource.
description String
The description of this username/password account.
environments List<String>
A list of environment IDs associated with this resource.
name String
The name of the username-password account.
password String
The password associated with this resource.
spaceId String
The space ID associated with this resource.
tenantTags List<String>
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation String
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants List<String>
A list of tenant IDs associated with this resource.
username This property is required. string
The username associated with this resource.
description string
The description of this username/password account.
environments string[]
A list of environment IDs associated with this resource.
name string
The name of the username-password account.
password string
The password associated with this resource.
spaceId string
The space ID associated with this resource.
tenantTags string[]
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants string[]
A list of tenant IDs associated with this resource.
username This property is required. str
The username associated with this resource.
description str
The description of this username/password account.
environments Sequence[str]
A list of environment IDs associated with this resource.
name str
The name of the username-password account.
password str
The password associated with this resource.
space_id str
The space ID associated with this resource.
tenant_tags Sequence[str]
A list of tenant tags associated with this resource.
tenanted_deployment_participation str
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants Sequence[str]
A list of tenant IDs associated with this resource.
username This property is required. String
The username associated with this resource.
description String
The description of this username/password account.
environments List<String>
A list of environment IDs associated with this resource.
name String
The name of the username-password account.
password String
The password associated with this resource.
spaceId String
The space ID associated with this resource.
tenantTags List<String>
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation String
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants List<String>
A list of tenant IDs associated with this resource.

Outputs

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

Get an existing UsernamePasswordAccount 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?: UsernamePasswordAccountState, opts?: CustomResourceOptions): UsernamePasswordAccount
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        environments: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None,
        tenanted_deployment_participation: Optional[str] = None,
        tenants: Optional[Sequence[str]] = None,
        username: Optional[str] = None) -> UsernamePasswordAccount
func GetUsernamePasswordAccount(ctx *Context, name string, id IDInput, state *UsernamePasswordAccountState, opts ...ResourceOption) (*UsernamePasswordAccount, error)
public static UsernamePasswordAccount Get(string name, Input<string> id, UsernamePasswordAccountState? state, CustomResourceOptions? opts = null)
public static UsernamePasswordAccount get(String name, Output<String> id, UsernamePasswordAccountState state, CustomResourceOptions options)
resources:  _:    type: octopusdeploy:UsernamePasswordAccount    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description of this username/password account.
Environments List<string>
A list of environment IDs associated with this resource.
Name string
The name of the username-password account.
Password string
The password associated with this resource.
SpaceId string
The space ID associated with this resource.
TenantTags List<string>
A list of tenant tags associated with this resource.
TenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
Tenants List<string>
A list of tenant IDs associated with this resource.
Username string
The username associated with this resource.
Description string
The description of this username/password account.
Environments []string
A list of environment IDs associated with this resource.
Name string
The name of the username-password account.
Password string
The password associated with this resource.
SpaceId string
The space ID associated with this resource.
TenantTags []string
A list of tenant tags associated with this resource.
TenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
Tenants []string
A list of tenant IDs associated with this resource.
Username string
The username associated with this resource.
description String
The description of this username/password account.
environments List<String>
A list of environment IDs associated with this resource.
name String
The name of the username-password account.
password String
The password associated with this resource.
spaceId String
The space ID associated with this resource.
tenantTags List<String>
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation String
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants List<String>
A list of tenant IDs associated with this resource.
username String
The username associated with this resource.
description string
The description of this username/password account.
environments string[]
A list of environment IDs associated with this resource.
name string
The name of the username-password account.
password string
The password associated with this resource.
spaceId string
The space ID associated with this resource.
tenantTags string[]
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation string
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants string[]
A list of tenant IDs associated with this resource.
username string
The username associated with this resource.
description str
The description of this username/password account.
environments Sequence[str]
A list of environment IDs associated with this resource.
name str
The name of the username-password account.
password str
The password associated with this resource.
space_id str
The space ID associated with this resource.
tenant_tags Sequence[str]
A list of tenant tags associated with this resource.
tenanted_deployment_participation str
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants Sequence[str]
A list of tenant IDs associated with this resource.
username str
The username associated with this resource.
description String
The description of this username/password account.
environments List<String>
A list of environment IDs associated with this resource.
name String
The name of the username-password account.
password String
The password associated with this resource.
spaceId String
The space ID associated with this resource.
tenantTags List<String>
A list of tenant tags associated with this resource.
tenantedDeploymentParticipation String
The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
tenants List<String>
A list of tenant IDs associated with this resource.
username String
The username associated with this resource.

Import

$ pulumi import octopusdeploy:index/usernamePasswordAccount:UsernamePasswordAccount [options] octopusdeploy_username_password_account.<name> <account-id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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