1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCdToolchainToolPrivateworker
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCdToolchainToolPrivateworker

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about a cd_toolchain_tool_privateworker. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    See the tool integration page for more information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const cdToolchainToolPrivateworker = ibm.getCdToolchainToolPrivateworker({
        toolId: "9603dcd4-3c86-44f8-8d0a-9427369878cf",
        toolchainId: data.ibm_cd_toolchain.cd_toolchain.id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    cd_toolchain_tool_privateworker = ibm.get_cd_toolchain_tool_privateworker(tool_id="9603dcd4-3c86-44f8-8d0a-9427369878cf",
        toolchain_id=data["ibm_cd_toolchain"]["cd_toolchain"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupCdToolchainToolPrivateworker(ctx, &ibm.LookupCdToolchainToolPrivateworkerArgs{
    			ToolId:      "9603dcd4-3c86-44f8-8d0a-9427369878cf",
    			ToolchainId: data.Ibm_cd_toolchain.Cd_toolchain.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var cdToolchainToolPrivateworker = Ibm.GetCdToolchainToolPrivateworker.Invoke(new()
        {
            ToolId = "9603dcd4-3c86-44f8-8d0a-9427369878cf",
            ToolchainId = data.Ibm_cd_toolchain.Cd_toolchain.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetCdToolchainToolPrivateworkerArgs;
    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) {
            final var cdToolchainToolPrivateworker = IbmFunctions.getCdToolchainToolPrivateworker(GetCdToolchainToolPrivateworkerArgs.builder()
                .toolId("9603dcd4-3c86-44f8-8d0a-9427369878cf")
                .toolchainId(data.ibm_cd_toolchain().cd_toolchain().id())
                .build());
    
        }
    }
    
    variables:
      cdToolchainToolPrivateworker:
        fn::invoke:
          function: ibm:getCdToolchainToolPrivateworker
          arguments:
            toolId: 9603dcd4-3c86-44f8-8d0a-9427369878cf
            toolchainId: ${data.ibm_cd_toolchain.cd_toolchain.id}
    

    Using getCdToolchainToolPrivateworker

    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 getCdToolchainToolPrivateworker(args: GetCdToolchainToolPrivateworkerArgs, opts?: InvokeOptions): Promise<GetCdToolchainToolPrivateworkerResult>
    function getCdToolchainToolPrivateworkerOutput(args: GetCdToolchainToolPrivateworkerOutputArgs, opts?: InvokeOptions): Output<GetCdToolchainToolPrivateworkerResult>
    def get_cd_toolchain_tool_privateworker(id: Optional[str] = None,
                                            tool_id: Optional[str] = None,
                                            toolchain_id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetCdToolchainToolPrivateworkerResult
    def get_cd_toolchain_tool_privateworker_output(id: Optional[pulumi.Input[str]] = None,
                                            tool_id: Optional[pulumi.Input[str]] = None,
                                            toolchain_id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetCdToolchainToolPrivateworkerResult]
    func LookupCdToolchainToolPrivateworker(ctx *Context, args *LookupCdToolchainToolPrivateworkerArgs, opts ...InvokeOption) (*LookupCdToolchainToolPrivateworkerResult, error)
    func LookupCdToolchainToolPrivateworkerOutput(ctx *Context, args *LookupCdToolchainToolPrivateworkerOutputArgs, opts ...InvokeOption) LookupCdToolchainToolPrivateworkerResultOutput

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

    public static class GetCdToolchainToolPrivateworker 
    {
        public static Task<GetCdToolchainToolPrivateworkerResult> InvokeAsync(GetCdToolchainToolPrivateworkerArgs args, InvokeOptions? opts = null)
        public static Output<GetCdToolchainToolPrivateworkerResult> Invoke(GetCdToolchainToolPrivateworkerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCdToolchainToolPrivateworkerResult> getCdToolchainToolPrivateworker(GetCdToolchainToolPrivateworkerArgs args, InvokeOptions options)
    public static Output<GetCdToolchainToolPrivateworkerResult> getCdToolchainToolPrivateworker(GetCdToolchainToolPrivateworkerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCdToolchainToolPrivateworker:getCdToolchainToolPrivateworker
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ToolId string
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    ToolchainId string
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    Id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    ToolId string
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    ToolchainId string
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    Id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    toolId String
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    toolchainId String
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    id String
    The unique identifier of the cd_toolchain_tool_privateworker.
    toolId string
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    toolchainId string
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    tool_id str
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    toolchain_id str
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    id str
    The unique identifier of the cd_toolchain_tool_privateworker.
    toolId String
    ID of the tool bound to the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    toolchainId String
    ID of the toolchain.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/.
    id String
    The unique identifier of the cd_toolchain_tool_privateworker.

    getCdToolchainToolPrivateworker Result

    The following output properties are available:

    Crn string
    (String) Tool CRN.
    Href string
    (String) URI representing the tool.
    Id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    Name string
    (String) The name used for this tool integration.
    Parameters List<GetCdToolchainToolPrivateworkerParameter>
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    Referents List<GetCdToolchainToolPrivateworkerReferent>
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    ResourceGroupId string
    (String) Resource group where the tool is located.
    State string
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    ToolId string
    ToolchainCrn string
    (String) CRN of toolchain which the tool is bound to.
    ToolchainId string
    UpdatedAt string
    (String) Latest tool update timestamp.
    Crn string
    (String) Tool CRN.
    Href string
    (String) URI representing the tool.
    Id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    Name string
    (String) The name used for this tool integration.
    Parameters []GetCdToolchainToolPrivateworkerParameter
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    Referents []GetCdToolchainToolPrivateworkerReferent
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    ResourceGroupId string
    (String) Resource group where the tool is located.
    State string
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    ToolId string
    ToolchainCrn string
    (String) CRN of toolchain which the tool is bound to.
    ToolchainId string
    UpdatedAt string
    (String) Latest tool update timestamp.
    crn String
    (String) Tool CRN.
    href String
    (String) URI representing the tool.
    id String
    The unique identifier of the cd_toolchain_tool_privateworker.
    name String
    (String) The name used for this tool integration.
    parameters List<GetCdToolchainToolPrivateworkerParameter>
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    referents List<GetCdToolchainToolPrivateworkerReferent>
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    resourceGroupId String
    (String) Resource group where the tool is located.
    state String
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    toolId String
    toolchainCrn String
    (String) CRN of toolchain which the tool is bound to.
    toolchainId String
    updatedAt String
    (String) Latest tool update timestamp.
    crn string
    (String) Tool CRN.
    href string
    (String) URI representing the tool.
    id string
    The unique identifier of the cd_toolchain_tool_privateworker.
    name string
    (String) The name used for this tool integration.
    parameters GetCdToolchainToolPrivateworkerParameter[]
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    referents GetCdToolchainToolPrivateworkerReferent[]
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    resourceGroupId string
    (String) Resource group where the tool is located.
    state string
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    toolId string
    toolchainCrn string
    (String) CRN of toolchain which the tool is bound to.
    toolchainId string
    updatedAt string
    (String) Latest tool update timestamp.
    crn str
    (String) Tool CRN.
    href str
    (String) URI representing the tool.
    id str
    The unique identifier of the cd_toolchain_tool_privateworker.
    name str
    (String) The name used for this tool integration.
    parameters Sequence[GetCdToolchainToolPrivateworkerParameter]
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    referents Sequence[GetCdToolchainToolPrivateworkerReferent]
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    resource_group_id str
    (String) Resource group where the tool is located.
    state str
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    tool_id str
    toolchain_crn str
    (String) CRN of toolchain which the tool is bound to.
    toolchain_id str
    updated_at str
    (String) Latest tool update timestamp.
    crn String
    (String) Tool CRN.
    href String
    (String) URI representing the tool.
    id String
    The unique identifier of the cd_toolchain_tool_privateworker.
    name String
    (String) The name used for this tool integration.
    parameters List<Property Map>
    (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
    referents List<Property Map>
    (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
    resourceGroupId String
    (String) Resource group where the tool is located.
    state String
    (String) Current configuration state of the tool.

    • Constraints: Allowable values are: configured, configuring, misconfigured, unconfigured.
    toolId String
    toolchainCrn String
    (String) CRN of toolchain which the tool is bound to.
    toolchainId String
    updatedAt String
    (String) Latest tool update timestamp.

    Supporting Types

    GetCdToolchainToolPrivateworkerParameter

    Name string
    (String) The name used for this tool integration.
    WorkerQueueCredentials string
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    WorkerQueueIdentifier string
    (String) The service ID which identifies this private workers run request queue.
    Name string
    (String) The name used for this tool integration.
    WorkerQueueCredentials string
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    WorkerQueueIdentifier string
    (String) The service ID which identifies this private workers run request queue.
    name String
    (String) The name used for this tool integration.
    workerQueueCredentials String
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    workerQueueIdentifier String
    (String) The service ID which identifies this private workers run request queue.
    name string
    (String) The name used for this tool integration.
    workerQueueCredentials string
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    workerQueueIdentifier string
    (String) The service ID which identifies this private workers run request queue.
    name str
    (String) The name used for this tool integration.
    worker_queue_credentials str
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    worker_queue_identifier str
    (String) The service ID which identifies this private workers run request queue.
    name String
    (String) The name used for this tool integration.
    workerQueueCredentials String
    (String) The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
    workerQueueIdentifier String
    (String) The service ID which identifies this private workers run request queue.

    GetCdToolchainToolPrivateworkerReferent

    ApiHref string
    (String) URI representing this resource through an API.
    UiHref string
    (String) URI representing this resource through the UI.
    ApiHref string
    (String) URI representing this resource through an API.
    UiHref string
    (String) URI representing this resource through the UI.
    apiHref String
    (String) URI representing this resource through an API.
    uiHref String
    (String) URI representing this resource through the UI.
    apiHref string
    (String) URI representing this resource through an API.
    uiHref string
    (String) URI representing this resource through the UI.
    api_href str
    (String) URI representing this resource through an API.
    ui_href str
    (String) URI representing this resource through the UI.
    apiHref String
    (String) URI representing this resource through an API.
    uiHref String
    (String) URI representing this resource through the UI.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud