1. Packages
  2. Harness Provider
  3. API Docs
  4. autostopping
  5. getRuleVm
Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

harness.autostopping.getRuleVm

harness logo
Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

    Data source for retrieving a Harness AutoStopping rule for VMs.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    variables:
  example:
    fn::invoke:
      function: harness:autostopping:getRuleVm
      arguments:
        identifier: identifier

    Using getRuleVm

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRuleVm(args: GetRuleVmArgs, opts?: InvokeOptions): Promise<GetRuleVmResult>
function getRuleVmOutput(args: GetRuleVmOutputArgs, opts?: InvokeOptions): Output<GetRuleVmResult>
    def get_rule_vm(cloud_connector_id: Optional[str] = None,
                custom_domains: Optional[Sequence[str]] = None,
                depends: Optional[Sequence[GetRuleVmDepend]] = None,
                filter: Optional[GetRuleVmFilter] = None,
                https: Optional[Sequence[GetRuleVmHttp]] = None,
                idle_time_mins: Optional[int] = None,
                name: Optional[str] = None,
                tcps: Optional[Sequence[GetRuleVmTcp]] = None,
                use_spot: Optional[bool] = None,
                opts: Optional[InvokeOptions] = None) -> GetRuleVmResult
def get_rule_vm_output(cloud_connector_id: Optional[pulumi.Input[str]] = None,
                custom_domains: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                depends: Optional[pulumi.Input[Sequence[pulumi.Input[GetRuleVmDependArgs]]]] = None,
                filter: Optional[pulumi.Input[GetRuleVmFilterArgs]] = None,
                https: Optional[pulumi.Input[Sequence[pulumi.Input[GetRuleVmHttpArgs]]]] = None,
                idle_time_mins: Optional[pulumi.Input[int]] = None,
                name: Optional[pulumi.Input[str]] = None,
                tcps: Optional[pulumi.Input[Sequence[pulumi.Input[GetRuleVmTcpArgs]]]] = None,
                use_spot: Optional[pulumi.Input[bool]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRuleVmResult]
    func LookupRuleVm(ctx *Context, args *LookupRuleVmArgs, opts ...InvokeOption) (*LookupRuleVmResult, error)
func LookupRuleVmOutput(ctx *Context, args *LookupRuleVmOutputArgs, opts ...InvokeOption) LookupRuleVmResultOutput

    > Note: This function is named LookupRuleVm in the Go SDK.

    public static class GetRuleVm 
{
    public static Task<GetRuleVmResult> InvokeAsync(GetRuleVmArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleVmResult> Invoke(GetRuleVmInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleVmResult> getRuleVm(GetRuleVmArgs args, InvokeOptions options)
public static Output<GetRuleVmResult> getRuleVm(GetRuleVmArgs args, InvokeOptions options)

    fn::invoke:
  function: harness:autostopping/getRuleVm:getRuleVm
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CloudConnectorId string
    Id of the cloud connector
    Filter GetRuleVmFilter
    Name string
    Name of the rule
    CustomDomains List<string>
    Custom URLs used to access the instances
    Depends List<GetRuleVmDepend>
    Dependent rules
    Https List<GetRuleVmHttp>
    Http routing configuration
    IdleTimeMins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    Tcps List<GetRuleVmTcp>
    TCP routing configuration
    UseSpot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    CloudConnectorId string
    Id of the cloud connector
    Filter GetRuleVmFilter
    Name string
    Name of the rule
    CustomDomains []string
    Custom URLs used to access the instances
    Depends []GetRuleVmDepend
    Dependent rules
    Https []GetRuleVmHttp
    Http routing configuration
    IdleTimeMins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    Tcps []GetRuleVmTcp
    TCP routing configuration
    UseSpot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId String
    Id of the cloud connector
    filter GetRuleVmFilter
    name String
    Name of the rule
    customDomains List<String>
    Custom URLs used to access the instances
    depends List<GetRuleVmDepend>
    Dependent rules
    https List<GetRuleVmHttp>
    Http routing configuration
    idleTimeMins Integer
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps List<GetRuleVmTcp>
    TCP routing configuration
    useSpot Boolean
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId string
    Id of the cloud connector
    filter GetRuleVmFilter
    name string
    Name of the rule
    customDomains string[]
    Custom URLs used to access the instances
    depends GetRuleVmDepend[]
    Dependent rules
    https GetRuleVmHttp[]
    Http routing configuration
    idleTimeMins number
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps GetRuleVmTcp[]
    TCP routing configuration
    useSpot boolean
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloud_connector_id str
    Id of the cloud connector
    filter GetRuleVmFilter
    name str
    Name of the rule
    custom_domains Sequence[str]
    Custom URLs used to access the instances
    depends Sequence[GetRuleVmDepend]
    Dependent rules
    https Sequence[GetRuleVmHttp]
    Http routing configuration
    idle_time_mins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps Sequence[GetRuleVmTcp]
    TCP routing configuration
    use_spot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId String
    Id of the cloud connector
    filter Property Map
    name String
    Name of the rule
    customDomains List<String>
    Custom URLs used to access the instances
    depends List<Property Map>
    Dependent rules
    https List<Property Map>
    Http routing configuration
    idleTimeMins Number
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps List<Property Map>
    TCP routing configuration
    useSpot Boolean
    Boolean that indicates whether the selected instances should be converted to spot vm

    getRuleVm Result

    The following output properties are available:

    CloudConnectorId string
    Id of the cloud connector
    Connect Dictionary<string, int>
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    Filter GetRuleVmFilter
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource
    Name string
    Name of the rule
    CustomDomains List<string>
    Custom URLs used to access the instances
    Depends List<GetRuleVmDepend>
    Dependent rules
    Https List<GetRuleVmHttp>
    Http routing configuration
    IdleTimeMins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    Tcps List<GetRuleVmTcp>
    TCP routing configuration
    UseSpot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    CloudConnectorId string
    Id of the cloud connector
    Connect map[string]int
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    Filter GetRuleVmFilter
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource
    Name string
    Name of the rule
    CustomDomains []string
    Custom URLs used to access the instances
    Depends []GetRuleVmDepend
    Dependent rules
    Https []GetRuleVmHttp
    Http routing configuration
    IdleTimeMins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    Tcps []GetRuleVmTcp
    TCP routing configuration
    UseSpot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId String
    Id of the cloud connector
    connect Map<String,Integer>
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    filter GetRuleVmFilter
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource
    name String
    Name of the rule
    customDomains List<String>
    Custom URLs used to access the instances
    depends List<GetRuleVmDepend>
    Dependent rules
    https List<GetRuleVmHttp>
    Http routing configuration
    idleTimeMins Integer
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps List<GetRuleVmTcp>
    TCP routing configuration
    useSpot Boolean
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId string
    Id of the cloud connector
    connect {[key: string]: number}
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    filter GetRuleVmFilter
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource
    name string
    Name of the rule
    customDomains string[]
    Custom URLs used to access the instances
    depends GetRuleVmDepend[]
    Dependent rules
    https GetRuleVmHttp[]
    Http routing configuration
    idleTimeMins number
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps GetRuleVmTcp[]
    TCP routing configuration
    useSpot boolean
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloud_connector_id str
    Id of the cloud connector
    connect Mapping[str, int]
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    filter GetRuleVmFilter
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource
    name str
    Name of the rule
    custom_domains Sequence[str]
    Custom URLs used to access the instances
    depends Sequence[GetRuleVmDepend]
    Dependent rules
    https Sequence[GetRuleVmHttp]
    Http routing configuration
    idle_time_mins int
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps Sequence[GetRuleVmTcp]
    TCP routing configuration
    use_spot bool
    Boolean that indicates whether the selected instances should be converted to spot vm
    cloudConnectorId String
    Id of the cloud connector
    connect Map<Number>
    Connection information (source ports on the proxy). Keys: "ssh" and "rdp" for SSH/RDP; other keys are target port as string (e.g. "80") for forward_rule, value is the proxy source port.
    filter Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource
    name String
    Name of the rule
    customDomains List<String>
    Custom URLs used to access the instances
    depends List<Property Map>
    Dependent rules
    https List<Property Map>
    Http routing configuration
    idleTimeMins Number
    Idle time in minutes. This is the time that the AutoStopping rule waits before stopping the idle instances.
    tcps List<Property Map>
    TCP routing configuration
    useSpot Boolean
    Boolean that indicates whether the selected instances should be converted to spot vm

    Supporting Types

    GetRuleVmDepend

    RuleId int
    Rule id of the dependent rule
    DelayInSec int
    Number of seconds the rule should wait after warming up the dependent rule
    RuleId int
    Rule id of the dependent rule
    DelayInSec int
    Number of seconds the rule should wait after warming up the dependent rule
    ruleId Integer
    Rule id of the dependent rule
    delayInSec Integer
    Number of seconds the rule should wait after warming up the dependent rule
    ruleId number
    Rule id of the dependent rule
    delayInSec number
    Number of seconds the rule should wait after warming up the dependent rule
    rule_id int
    Rule id of the dependent rule
    delay_in_sec int
    Number of seconds the rule should wait after warming up the dependent rule
    ruleId Number
    Rule id of the dependent rule
    delayInSec Number
    Number of seconds the rule should wait after warming up the dependent rule

    GetRuleVmFilter

    Regions List<string>
    Regions of instances that needs to be managed using the AutoStopping rules
    Tags List<GetRuleVmFilterTag>
    Tags of instances that needs to be managed using the AutoStopping rules
    VmIds List<string>
    Ids of instances that needs to be managed using the AutoStopping rules
    Zones List<string>
    Zones of instances that needs to be managed using the AutoStopping rules
    Regions []string
    Regions of instances that needs to be managed using the AutoStopping rules
    Tags []GetRuleVmFilterTag
    Tags of instances that needs to be managed using the AutoStopping rules
    VmIds []string
    Ids of instances that needs to be managed using the AutoStopping rules
    Zones []string
    Zones of instances that needs to be managed using the AutoStopping rules
    regions List<String>
    Regions of instances that needs to be managed using the AutoStopping rules
    tags List<GetRuleVmFilterTag>
    Tags of instances that needs to be managed using the AutoStopping rules
    vmIds List<String>
    Ids of instances that needs to be managed using the AutoStopping rules
    zones List<String>
    Zones of instances that needs to be managed using the AutoStopping rules
    regions string[]
    Regions of instances that needs to be managed using the AutoStopping rules
    tags GetRuleVmFilterTag[]
    Tags of instances that needs to be managed using the AutoStopping rules
    vmIds string[]
    Ids of instances that needs to be managed using the AutoStopping rules
    zones string[]
    Zones of instances that needs to be managed using the AutoStopping rules
    regions Sequence[str]
    Regions of instances that needs to be managed using the AutoStopping rules
    tags Sequence[GetRuleVmFilterTag]
    Tags of instances that needs to be managed using the AutoStopping rules
    vm_ids Sequence[str]
    Ids of instances that needs to be managed using the AutoStopping rules
    zones Sequence[str]
    Zones of instances that needs to be managed using the AutoStopping rules
    regions List<String>
    Regions of instances that needs to be managed using the AutoStopping rules
    tags List<Property Map>
    Tags of instances that needs to be managed using the AutoStopping rules
    vmIds List<String>
    Ids of instances that needs to be managed using the AutoStopping rules
    zones List<String>
    Zones of instances that needs to be managed using the AutoStopping rules

    GetRuleVmFilterTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetRuleVmHttp

    ProxyId string
    Id of the proxy
    Healths List<GetRuleVmHttpHealth>
    Health Check Details
    Routings List<GetRuleVmHttpRouting>
    Routing configuration used to access the instances
    ProxyId string
    Id of the proxy
    Healths []GetRuleVmHttpHealth
    Health Check Details
    Routings []GetRuleVmHttpRouting
    Routing configuration used to access the instances
    proxyId String
    Id of the proxy
    healths List<GetRuleVmHttpHealth>
    Health Check Details
    routings List<GetRuleVmHttpRouting>
    Routing configuration used to access the instances
    proxyId string
    Id of the proxy
    healths GetRuleVmHttpHealth[]
    Health Check Details
    routings GetRuleVmHttpRouting[]
    Routing configuration used to access the instances
    proxy_id str
    Id of the proxy
    healths Sequence[GetRuleVmHttpHealth]
    Health Check Details
    routings Sequence[GetRuleVmHttpRouting]
    Routing configuration used to access the instances
    proxyId String
    Id of the proxy
    healths List<Property Map>
    Health Check Details
    routings List<Property Map>
    Routing configuration used to access the instances

    GetRuleVmHttpHealth

    Port int
    Health check port on the VM
    Protocol string
    Protocol can be http or https
    Path string
    API path to use for health check
    StatusCodeFrom int
    Lower limit for acceptable status code
    StatusCodeTo int
    Upper limit for acceptable status code
    Timeout int
    Health check timeout
    Port int
    Health check port on the VM
    Protocol string
    Protocol can be http or https
    Path string
    API path to use for health check
    StatusCodeFrom int
    Lower limit for acceptable status code
    StatusCodeTo int
    Upper limit for acceptable status code
    Timeout int
    Health check timeout
    port Integer
    Health check port on the VM
    protocol String
    Protocol can be http or https
    path String
    API path to use for health check
    statusCodeFrom Integer
    Lower limit for acceptable status code
    statusCodeTo Integer
    Upper limit for acceptable status code
    timeout Integer
    Health check timeout
    port number
    Health check port on the VM
    protocol string
    Protocol can be http or https
    path string
    API path to use for health check
    statusCodeFrom number
    Lower limit for acceptable status code
    statusCodeTo number
    Upper limit for acceptable status code
    timeout number
    Health check timeout
    port int
    Health check port on the VM
    protocol str
    Protocol can be http or https
    path str
    API path to use for health check
    status_code_from int
    Lower limit for acceptable status code
    status_code_to int
    Upper limit for acceptable status code
    timeout int
    Health check timeout
    port Number
    Health check port on the VM
    protocol String
    Protocol can be http or https
    path String
    API path to use for health check
    statusCodeFrom Number
    Lower limit for acceptable status code
    statusCodeTo Number
    Upper limit for acceptable status code
    timeout Number
    Health check timeout

    GetRuleVmHttpRouting

    SourceProtocol string
    Source protocol of the proxy can be http or https
    TargetProtocol string
    Target protocol of the instance can be http or https
    Action string
    Action to take for the routing rule
    Path string
    Path to use for the proxy
    SourcePort int
    Port on the proxy
    TargetPort int
    Port on the VM
    SourceProtocol string
    Source protocol of the proxy can be http or https
    TargetProtocol string
    Target protocol of the instance can be http or https
    Action string
    Action to take for the routing rule
    Path string
    Path to use for the proxy
    SourcePort int
    Port on the proxy
    TargetPort int
    Port on the VM
    sourceProtocol String
    Source protocol of the proxy can be http or https
    targetProtocol String
    Target protocol of the instance can be http or https
    action String
    Action to take for the routing rule
    path String
    Path to use for the proxy
    sourcePort Integer
    Port on the proxy
    targetPort Integer
    Port on the VM
    sourceProtocol string
    Source protocol of the proxy can be http or https
    targetProtocol string
    Target protocol of the instance can be http or https
    action string
    Action to take for the routing rule
    path string
    Path to use for the proxy
    sourcePort number
    Port on the proxy
    targetPort number
    Port on the VM
    source_protocol str
    Source protocol of the proxy can be http or https
    target_protocol str
    Target protocol of the instance can be http or https
    action str
    Action to take for the routing rule
    path str
    Path to use for the proxy
    source_port int
    Port on the proxy
    target_port int
    Port on the VM
    sourceProtocol String
    Source protocol of the proxy can be http or https
    targetProtocol String
    Target protocol of the instance can be http or https
    action String
    Action to take for the routing rule
    path String
    Path to use for the proxy
    sourcePort Number
    Port on the proxy
    targetPort Number
    Port on the VM

    GetRuleVmTcp

    ProxyId string
    Id of the Proxy
    ForwardRules List<GetRuleVmTcpForwardRule>
    Additional tcp forwarding rules
    Rdps List<GetRuleVmTcpRdp>
    RDP configuration
    Sshes List<GetRuleVmTcpSsh>
    SSH configuration
    ProxyId string
    Id of the Proxy
    ForwardRules []GetRuleVmTcpForwardRule
    Additional tcp forwarding rules
    Rdps []GetRuleVmTcpRdp
    RDP configuration
    Sshes []GetRuleVmTcpSsh
    SSH configuration
    proxyId String
    Id of the Proxy
    forwardRules List<GetRuleVmTcpForwardRule>
    Additional tcp forwarding rules
    rdps List<GetRuleVmTcpRdp>
    RDP configuration
    sshes List<GetRuleVmTcpSsh>
    SSH configuration
    proxyId string
    Id of the Proxy
    forwardRules GetRuleVmTcpForwardRule[]
    Additional tcp forwarding rules
    rdps GetRuleVmTcpRdp[]
    RDP configuration
    sshes GetRuleVmTcpSsh[]
    SSH configuration
    proxy_id str
    Id of the Proxy
    forward_rules Sequence[GetRuleVmTcpForwardRule]
    Additional tcp forwarding rules
    rdps Sequence[GetRuleVmTcpRdp]
    RDP configuration
    sshes Sequence[GetRuleVmTcpSsh]
    SSH configuration
    proxyId String
    Id of the Proxy
    forwardRules List<Property Map>
    Additional tcp forwarding rules
    rdps List<Property Map>
    RDP configuration
    sshes List<Property Map>
    SSH configuration

    GetRuleVmTcpForwardRule

    Port int
    Port to listen on the vm
    ConnectOn int
    Port to listen on the proxy
    Port int
    Port to listen on the vm
    ConnectOn int
    Port to listen on the proxy
    port Integer
    Port to listen on the vm
    connectOn Integer
    Port to listen on the proxy
    port number
    Port to listen on the vm
    connectOn number
    Port to listen on the proxy
    port int
    Port to listen on the vm
    connect_on int
    Port to listen on the proxy
    port Number
    Port to listen on the vm
    connectOn Number
    Port to listen on the proxy

    GetRuleVmTcpRdp

    ConnectOn int
    Port to listen on the proxy
    Port int
    Port to listen on the vm
    ConnectOn int
    Port to listen on the proxy
    Port int
    Port to listen on the vm
    connectOn Integer
    Port to listen on the proxy
    port Integer
    Port to listen on the vm
    connectOn number
    Port to listen on the proxy
    port number
    Port to listen on the vm
    connect_on int
    Port to listen on the proxy
    port int
    Port to listen on the vm
    connectOn Number
    Port to listen on the proxy
    port Number
    Port to listen on the vm

    GetRuleVmTcpSsh

    ConnectOn int
    Port to listen on the proxy
    Port int
    Port to listen on the vm
    ConnectOn int
    Port to listen on the proxy
    Port int
    Port to listen on the vm
    connectOn Integer
    Port to listen on the proxy
    port Integer
    Port to listen on the vm
    connectOn number
    Port to listen on the proxy
    port number
    Port to listen on the vm
    connect_on int
    Port to listen on the proxy
    port int
    Port to listen on the vm
    connectOn Number
    Port to listen on the proxy
    port Number
    Port to listen on the vm

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.11.6
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-harness
      Try Pulumi Cloud free. Your team will thank you.