Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. ListeningTentacleWorker
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.ListeningTentacleWorker

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a listening tentacle worker in Octopus Deploy.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  minimum:
    type: octopusdeploy:ListeningTentacleWorker
    properties:
      machinePolicyId: machine-policy-1
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      uri: https://tentacle.listening/
      workerPools:
        - worker-pools-1
        - worker-pools-2
  optionals:
    type: octopusdeploy:ListeningTentacleWorker
    properties:
      isDisabled: true
      machinePolicyId: machine-policy-1
      proxyId: proxys-1
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      uri: https://tentacle.listening/
      workerPools:
        - worker-pools-1

    Create ListeningTentacleWorker Resource

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

    Constructor syntax

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

@overload
def ListeningTentacleWorker(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            machine_policy_id: Optional[str] = None,
                            thumbprint: Optional[str] = None,
                            uri: Optional[str] = None,
                            worker_pool_ids: Optional[Sequence[str]] = None,
                            is_disabled: Optional[bool] = None,
                            name: Optional[str] = None,
                            proxy_id: Optional[str] = None,
                            space_id: Optional[str] = None)
    func NewListeningTentacleWorker(ctx *Context, name string, args ListeningTentacleWorkerArgs, opts ...ResourceOption) (*ListeningTentacleWorker, error)
    public ListeningTentacleWorker(string name, ListeningTentacleWorkerArgs args, CustomResourceOptions? opts = null)
    public ListeningTentacleWorker(String name, ListeningTentacleWorkerArgs args)
public ListeningTentacleWorker(String name, ListeningTentacleWorkerArgs args, CustomResourceOptions options)

    type: octopusdeploy:ListeningTentacleWorker
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 ListeningTentacleWorkerArgs
    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 ListeningTentacleWorkerArgs
    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 ListeningTentacleWorkerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListeningTentacleWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListeningTentacleWorkerArgs
    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 listeningTentacleWorkerResource = new Octopusdeploy.ListeningTentacleWorker("listeningTentacleWorkerResource", new()
{
    MachinePolicyId = "string",
    Thumbprint = "string",
    Uri = "string",
    WorkerPoolIds = new[]
    {
        "string",
    },
    IsDisabled = false,
    Name = "string",
    ProxyId = "string",
    SpaceId = "string",
});

    example, err := octopusdeploy.NewListeningTentacleWorker(ctx, "listeningTentacleWorkerResource", &octopusdeploy.ListeningTentacleWorkerArgs{
MachinePolicyId: pulumi.String("string"),
Thumbprint: pulumi.String("string"),
Uri: pulumi.String("string"),
WorkerPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
IsDisabled: pulumi.Bool(false),
Name: pulumi.String("string"),
ProxyId: pulumi.String("string"),
SpaceId: pulumi.String("string"),
})

    var listeningTentacleWorkerResource = new ListeningTentacleWorker("listeningTentacleWorkerResource", ListeningTentacleWorkerArgs.builder()
    .machinePolicyId("string")
    .thumbprint("string")
    .uri("string")
    .workerPoolIds("string")
    .isDisabled(false)
    .name("string")
    .proxyId("string")
    .spaceId("string")
    .build());

    listening_tentacle_worker_resource = octopusdeploy.ListeningTentacleWorker("listeningTentacleWorkerResource",
    machine_policy_id="string",
    thumbprint="string",
    uri="string",
    worker_pool_ids=["string"],
    is_disabled=False,
    name="string",
    proxy_id="string",
    space_id="string")

    const listeningTentacleWorkerResource = new octopusdeploy.ListeningTentacleWorker("listeningTentacleWorkerResource", {
    machinePolicyId: "string",
    thumbprint: "string",
    uri: "string",
    workerPoolIds: ["string"],
    isDisabled: false,
    name: "string",
    proxyId: "string",
    spaceId: "string",
});

    type: octopusdeploy:ListeningTentacleWorker
properties:
    isDisabled: false
    machinePolicyId: string
    name: string
    proxyId: string
    spaceId: string
    thumbprint: string
    uri: string
    workerPoolIds:
        - string

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

    MachinePolicyId string
    Select the machine policy
    Thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    Uri string
    The network address at which the Tentacle can be reached
    WorkerPoolIds List<string>
    Select at least one worker pool for the worker
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    MachinePolicyId string
    Select the machine policy
    Thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    Uri string
    The network address at which the Tentacle can be reached
    WorkerPoolIds []string
    Select at least one worker pool for the worker
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    machinePolicyId String
    Select the machine policy
    thumbprint String
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri String
    The network address at which the Tentacle can be reached
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    machinePolicyId string
    Select the machine policy
    thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri string
    The network address at which the Tentacle can be reached
    workerPoolIds string[]
    Select at least one worker pool for the worker
    isDisabled boolean
    When disabled, worker will not be included in any deployments
    name string
    The name of this resource.
    proxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId string
    The space ID associated with this Listening tentacle worker.
    machine_policy_id str
    Select the machine policy
    thumbprint str
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri str
    The network address at which the Tentacle can be reached
    worker_pool_ids Sequence[str]
    Select at least one worker pool for the worker
    is_disabled bool
    When disabled, worker will not be included in any deployments
    name str
    The name of this resource.
    proxy_id str
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    space_id str
    The space ID associated with this Listening tentacle worker.
    machinePolicyId String
    Select the machine policy
    thumbprint String
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri String
    The network address at which the Tentacle can be reached
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.

    Outputs

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

    Get an existing ListeningTentacleWorker 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?: ListeningTentacleWorkerState, opts?: CustomResourceOptions): ListeningTentacleWorker
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_disabled: Optional[bool] = None,
        machine_policy_id: Optional[str] = None,
        name: Optional[str] = None,
        proxy_id: Optional[str] = None,
        space_id: Optional[str] = None,
        thumbprint: Optional[str] = None,
        uri: Optional[str] = None,
        worker_pool_ids: Optional[Sequence[str]] = None) -> ListeningTentacleWorker
    func GetListeningTentacleWorker(ctx *Context, name string, id IDInput, state *ListeningTentacleWorkerState, opts ...ResourceOption) (*ListeningTentacleWorker, error)
    public static ListeningTentacleWorker Get(string name, Input<string> id, ListeningTentacleWorkerState? state, CustomResourceOptions? opts = null)
    public static ListeningTentacleWorker get(String name, Output<String> id, ListeningTentacleWorkerState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:ListeningTentacleWorker    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:
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    MachinePolicyId string
    Select the machine policy
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    Thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    Uri string
    The network address at which the Tentacle can be reached
    WorkerPoolIds List<string>
    Select at least one worker pool for the worker
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    MachinePolicyId string
    Select the machine policy
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    Thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    Uri string
    The network address at which the Tentacle can be reached
    WorkerPoolIds []string
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId String
    Select the machine policy
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    thumbprint String
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri String
    The network address at which the Tentacle can be reached
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    isDisabled boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId string
    Select the machine policy
    name string
    The name of this resource.
    proxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId string
    The space ID associated with this Listening tentacle worker.
    thumbprint string
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri string
    The network address at which the Tentacle can be reached
    workerPoolIds string[]
    Select at least one worker pool for the worker
    is_disabled bool
    When disabled, worker will not be included in any deployments
    machine_policy_id str
    Select the machine policy
    name str
    The name of this resource.
    proxy_id str
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    space_id str
    The space ID associated with this Listening tentacle worker.
    thumbprint str
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri str
    The network address at which the Tentacle can be reached
    worker_pool_ids Sequence[str]
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId String
    Select the machine policy
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    thumbprint String
    The X509 certificate thumbprint that securely identifies the Tentacle
    uri String
    The network address at which the Tentacle can be reached
    workerPoolIds List<String>
    Select at least one worker pool for the worker

    Import

    $ pulumi import octopusdeploy:index/listeningTentacleWorker:ListeningTentacleWorker [options] octopusdeploy_listening_tentacle_worker.<name> <machine-id>

    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 logo
    octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy