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

octopusdeploy.getMachineProxies

Explore with Pulumi AI

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

    Provides information about existing Octopus Deploy machine proxies.

    Using getMachineProxies

    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 getMachineProxies(args: GetMachineProxiesArgs, opts?: InvokeOptions): Promise<GetMachineProxiesResult>
function getMachineProxiesOutput(args: GetMachineProxiesOutputArgs, opts?: InvokeOptions): Output<GetMachineProxiesResult>
    def get_machine_proxies(ids: Optional[Sequence[str]] = None,
                        partial_name: Optional[str] = None,
                        skip: Optional[float] = None,
                        space_id: Optional[str] = None,
                        take: Optional[float] = None,
                        opts: Optional[InvokeOptions] = None) -> GetMachineProxiesResult
def get_machine_proxies_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        partial_name: Optional[pulumi.Input[str]] = None,
                        skip: Optional[pulumi.Input[float]] = None,
                        space_id: Optional[pulumi.Input[str]] = None,
                        take: Optional[pulumi.Input[float]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetMachineProxiesResult]
    func GetMachineProxies(ctx *Context, args *GetMachineProxiesArgs, opts ...InvokeOption) (*GetMachineProxiesResult, error)
func GetMachineProxiesOutput(ctx *Context, args *GetMachineProxiesOutputArgs, opts ...InvokeOption) GetMachineProxiesResultOutput

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

    public static class GetMachineProxies 
{
    public static Task<GetMachineProxiesResult> InvokeAsync(GetMachineProxiesArgs args, InvokeOptions? opts = null)
    public static Output<GetMachineProxiesResult> Invoke(GetMachineProxiesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMachineProxiesResult> getMachineProxies(GetMachineProxiesArgs args, InvokeOptions options)
public static Output<GetMachineProxiesResult> getMachineProxies(GetMachineProxiesArgs args, InvokeOptions options)

    fn::invoke:
  function: octopusdeploy:index/getMachineProxies:getMachineProxies
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by a partial name.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by a partial name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by a partial name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Double
    A filter to specify the number of items to take (or return) in the response.
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by a partial name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take number
    A filter to specify the number of items to take (or return) in the response.
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by a partial name.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take float
    A filter to specify the number of items to take (or return) in the response.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by a partial name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getMachineProxies Result

    The following output properties are available:

    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    MachineProxies List<GetMachineProxiesMachineProxy>
    A list of machine proxies that match the filter(s).
    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by a partial name.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    MachineProxies []GetMachineProxiesMachineProxy
    A list of machine proxies that match the filter(s).
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by a partial name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    machineProxies List<GetMachineProxiesMachineProxy>
    A list of machine proxies that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by a partial name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    machineProxies GetMachineProxiesMachineProxy[]
    A list of machine proxies that match the filter(s).
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by a partial name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    machine_proxies Sequence[GetMachineProxiesMachineProxy]
    A list of machine proxies that match the filter(s).
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by a partial name.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    machineProxies List<Property Map>
    A list of machine proxies that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by a partial name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetMachineProxiesMachineProxy

    Host string
    DNS hostname of the proxy server
    Id string
    Name string
    Port double
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine proxy.
    Username string
    Username for the proxy server
    Host string
    DNS hostname of the proxy server
    Id string
    Name string
    Port float64
    The port number for the proxy server.
    SpaceId string
    The space ID associated with this machine proxy.
    Username string
    Username for the proxy server
    host String
    DNS hostname of the proxy server
    id String
    name String
    port Double
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine proxy.
    username String
    Username for the proxy server
    host string
    DNS hostname of the proxy server
    id string
    name string
    port number
    The port number for the proxy server.
    spaceId string
    The space ID associated with this machine proxy.
    username string
    Username for the proxy server
    host str
    DNS hostname of the proxy server
    id str
    name str
    port float
    The port number for the proxy server.
    space_id str
    The space ID associated with this machine proxy.
    username str
    Username for the proxy server
    host String
    DNS hostname of the proxy server
    id String
    name String
    port Number
    The port number for the proxy server.
    spaceId String
    The space ID associated with this machine proxy.
    username String
    Username for 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