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

octopusdeploy.MachineProxy

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 machine proxies in Octopus Deploy.

    Create MachineProxy Resource

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

    Constructor syntax

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

@overload
def MachineProxy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 host: Optional[str] = None,
                 password: Optional[str] = None,
                 username: Optional[str] = None,
                 name: Optional[str] = None,
                 port: Optional[float] = None,
                 space_id: Optional[str] = None)
    func NewMachineProxy(ctx *Context, name string, args MachineProxyArgs, opts ...ResourceOption) (*MachineProxy, error)
    public MachineProxy(string name, MachineProxyArgs args, CustomResourceOptions? opts = null)
    public MachineProxy(String name, MachineProxyArgs args)
public MachineProxy(String name, MachineProxyArgs args, CustomResourceOptions options)

    type: octopusdeploy:MachineProxy
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 MachineProxyArgs
    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 MachineProxyArgs
    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 MachineProxyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MachineProxyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MachineProxyArgs
    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 machineProxyResource = new Octopusdeploy.MachineProxy("machineProxyResource", new()
{
    Host = "string",
    Password = "string",
    Username = "string",
    Name = "string",
    Port = 0,
    SpaceId = "string",
});

    example, err := octopusdeploy.NewMachineProxy(ctx, "machineProxyResource", &octopusdeploy.MachineProxyArgs{
	Host:     pulumi.String("string"),
	Password: pulumi.String("string"),
	Username: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Port:     pulumi.Float64(0),
	SpaceId:  pulumi.String("string"),
})

    var machineProxyResource = new MachineProxy("machineProxyResource", MachineProxyArgs.builder()
    .host("string")
    .password("string")
    .username("string")
    .name("string")
    .port(0)
    .spaceId("string")
    .build());

    machine_proxy_resource = octopusdeploy.MachineProxy("machineProxyResource",
    host="string",
    password="string",
    username="string",
    name="string",
    port=0,
    space_id="string")

    const machineProxyResource = new octopusdeploy.MachineProxy("machineProxyResource", {
    host: "string",
    password: "string",
    username: "string",
    name: "string",
    port: 0,
    spaceId: "string",
});

    type: octopusdeploy:MachineProxy
properties:
    host: string
    name: string
    password: string
    port: 0
    spaceId: string
    username: string

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

    Host string
    DNS hostname of the proxy server
    Password string
    Password of the proxy server
    Username string
    Username of the proxy server
    Name string
    The name of this resource.
    Port double
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine_proxy.
    Host string
    DNS hostname of the proxy server
    Password string
    Password of the proxy server
    Username string
    Username of the proxy server
    Name string
    The name of this resource.
    Port float64
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine_proxy.
    host String
    DNS hostname of the proxy server
    password String
    Password of the proxy server
    username String
    Username of the proxy server
    name String
    The name of this resource.
    port Double
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine_proxy.
    host string
    DNS hostname of the proxy server
    password string
    Password of the proxy server
    username string
    Username of the proxy server
    name string
    The name of this resource.
    port number
    The port number for the proxy server.
    spaceId string
    The space ID associated with this machine_proxy.
    host str
    DNS hostname of the proxy server
    password str
    Password of the proxy server
    username str
    Username of the proxy server
    name str
    The name of this resource.
    port float
    The port number for the proxy server.
    space_id str
    The space ID associated with this machine_proxy.
    host String
    DNS hostname of the proxy server
    password String
    Password of the proxy server
    username String
    Username of the proxy server
    name String
    The name of this resource.
    port Number
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine_proxy.

    Outputs

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

    Get an existing MachineProxy 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?: MachineProxyState, opts?: CustomResourceOptions): MachineProxy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        space_id: Optional[str] = None,
        username: Optional[str] = None) -> MachineProxy
    func GetMachineProxy(ctx *Context, name string, id IDInput, state *MachineProxyState, opts ...ResourceOption) (*MachineProxy, error)
    public static MachineProxy Get(string name, Input<string> id, MachineProxyState? state, CustomResourceOptions? opts = null)
    public static MachineProxy get(String name, Output<String> id, MachineProxyState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:MachineProxy    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:
    Host string
    DNS hostname of the proxy server
    Name string
    The name of this resource.
    Password string
    Password of the proxy server
    Port double
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine_proxy.
    Username string
    Username of the proxy server
    Host string
    DNS hostname of the proxy server
    Name string
    The name of this resource.
    Password string
    Password of the proxy server
    Port float64
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine_proxy.
    Username string
    Username of the proxy server
    host String
    DNS hostname of the proxy server
    name String
    The name of this resource.
    password String
    Password of the proxy server
    port Double
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine_proxy.
    username String
    Username of the proxy server
    host string
    DNS hostname of the proxy server
    name string
    The name of this resource.
    password string
    Password of the proxy server
    port number
    The port number for the proxy server.
    spaceId string
    The space ID associated with this machine_proxy.
    username string
    Username of the proxy server
    host str
    DNS hostname of the proxy server
    name str
    The name of this resource.
    password str
    Password of the proxy server
    port float
    The port number for the proxy server.
    space_id str
    The space ID associated with this machine_proxy.
    username str
    Username of the proxy server
    host String
    DNS hostname of the proxy server
    name String
    The name of this resource.
    password String
    Password of the proxy server
    port Number
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine_proxy.
    username String
    Username of the proxy server

    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