1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCdToolchainToolCustom
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCdToolchainToolCustom

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a cd_toolchain_tool_custom. 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 cdToolchainToolCustom = ibm.getCdToolchainToolCustom({
    toolId: "9603dcd4-3c86-44f8-8d0a-9427369878cf",
    toolchainId: data.ibm_cd_toolchain.cd_toolchain.id,
});
Copy
import pulumi
import pulumi_ibm as ibm

cd_toolchain_tool_custom = ibm.get_cd_toolchain_tool_custom(tool_id="9603dcd4-3c86-44f8-8d0a-9427369878cf",
    toolchain_id=data["ibm_cd_toolchain"]["cd_toolchain"]["id"])
Copy
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.LookupCdToolchainToolCustom(ctx, &ibm.LookupCdToolchainToolCustomArgs{
			ToolId:      "9603dcd4-3c86-44f8-8d0a-9427369878cf",
			ToolchainId: data.Ibm_cd_toolchain.Cd_toolchain.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var cdToolchainToolCustom = Ibm.GetCdToolchainToolCustom.Invoke(new()
    {
        ToolId = "9603dcd4-3c86-44f8-8d0a-9427369878cf",
        ToolchainId = data.Ibm_cd_toolchain.Cd_toolchain.Id,
    });

});
Copy
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.GetCdToolchainToolCustomArgs;
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 cdToolchainToolCustom = IbmFunctions.getCdToolchainToolCustom(GetCdToolchainToolCustomArgs.builder()
            .toolId("9603dcd4-3c86-44f8-8d0a-9427369878cf")
            .toolchainId(data.ibm_cd_toolchain().cd_toolchain().id())
            .build());

    }
}
Copy
variables:
  cdToolchainToolCustom:
    fn::invoke:
      function: ibm:getCdToolchainToolCustom
      arguments:
        toolId: 9603dcd4-3c86-44f8-8d0a-9427369878cf
        toolchainId: ${data.ibm_cd_toolchain.cd_toolchain.id}
Copy

Using getCdToolchainToolCustom

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 getCdToolchainToolCustom(args: GetCdToolchainToolCustomArgs, opts?: InvokeOptions): Promise<GetCdToolchainToolCustomResult>
function getCdToolchainToolCustomOutput(args: GetCdToolchainToolCustomOutputArgs, opts?: InvokeOptions): Output<GetCdToolchainToolCustomResult>
Copy
def get_cd_toolchain_tool_custom(id: Optional[str] = None,
                                 tool_id: Optional[str] = None,
                                 toolchain_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCdToolchainToolCustomResult
def get_cd_toolchain_tool_custom_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[GetCdToolchainToolCustomResult]
Copy
func LookupCdToolchainToolCustom(ctx *Context, args *LookupCdToolchainToolCustomArgs, opts ...InvokeOption) (*LookupCdToolchainToolCustomResult, error)
func LookupCdToolchainToolCustomOutput(ctx *Context, args *LookupCdToolchainToolCustomOutputArgs, opts ...InvokeOption) LookupCdToolchainToolCustomResultOutput
Copy

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

public static class GetCdToolchainToolCustom 
{
    public static Task<GetCdToolchainToolCustomResult> InvokeAsync(GetCdToolchainToolCustomArgs args, InvokeOptions? opts = null)
    public static Output<GetCdToolchainToolCustomResult> Invoke(GetCdToolchainToolCustomInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCdToolchainToolCustomResult> getCdToolchainToolCustom(GetCdToolchainToolCustomArgs args, InvokeOptions options)
public static Output<GetCdToolchainToolCustomResult> getCdToolchainToolCustom(GetCdToolchainToolCustomArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCdToolchainToolCustom:getCdToolchainToolCustom
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ToolId This property is required. 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 This property is required. 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_custom.
ToolId This property is required. 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 This property is required. 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_custom.
toolId This property is required. 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 This property is required. 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_custom.
toolId This property is required. 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 This property is required. 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_custom.
tool_id This property is required. 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 This property is required. 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_custom.
toolId This property is required. 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 This property is required. 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_custom.

getCdToolchainToolCustom 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_custom.
Name string
(String) The name for this tool integration.
Parameters List<GetCdToolchainToolCustomParameter>
(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<GetCdToolchainToolCustomReferent>
(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_custom.
Name string
(String) The name for this tool integration.
Parameters []GetCdToolchainToolCustomParameter
(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 []GetCdToolchainToolCustomReferent
(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_custom.
name String
(String) The name for this tool integration.
parameters List<GetCdToolchainToolCustomParameter>
(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<GetCdToolchainToolCustomReferent>
(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_custom.
name string
(String) The name for this tool integration.
parameters GetCdToolchainToolCustomParameter[]
(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 GetCdToolchainToolCustomReferent[]
(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_custom.
name str
(String) The name for this tool integration.
parameters Sequence[GetCdToolchainToolCustomParameter]
(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[GetCdToolchainToolCustomReferent]
(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_custom.
name String
(String) The name 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

GetCdToolchainToolCustomParameter

AdditionalProperties This property is required. string
(String) Any information that is needed to integrate with other tools in the toolchain.
DashboardUrl This property is required. string
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
Description This property is required. string
(String) A description outlining the function of this tool.
DocumentationUrl This property is required. string
(String) The URL for this tool's documentation.
ImageUrl This property is required. string
(String) The URL of the icon shown on the tool integration card in the graphical UI.
LifecyclePhase This property is required. string
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
Name This property is required. string
(String) The name for this tool integration.
Type This property is required. string
(String) The type of tool that this custom tool is integrating with.
AdditionalProperties This property is required. string
(String) Any information that is needed to integrate with other tools in the toolchain.
DashboardUrl This property is required. string
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
Description This property is required. string
(String) A description outlining the function of this tool.
DocumentationUrl This property is required. string
(String) The URL for this tool's documentation.
ImageUrl This property is required. string
(String) The URL of the icon shown on the tool integration card in the graphical UI.
LifecyclePhase This property is required. string
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
Name This property is required. string
(String) The name for this tool integration.
Type This property is required. string
(String) The type of tool that this custom tool is integrating with.
additionalProperties This property is required. String
(String) Any information that is needed to integrate with other tools in the toolchain.
dashboardUrl This property is required. String
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
description This property is required. String
(String) A description outlining the function of this tool.
documentationUrl This property is required. String
(String) The URL for this tool's documentation.
imageUrl This property is required. String
(String) The URL of the icon shown on the tool integration card in the graphical UI.
lifecyclePhase This property is required. String
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
name This property is required. String
(String) The name for this tool integration.
type This property is required. String
(String) The type of tool that this custom tool is integrating with.
additionalProperties This property is required. string
(String) Any information that is needed to integrate with other tools in the toolchain.
dashboardUrl This property is required. string
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
description This property is required. string
(String) A description outlining the function of this tool.
documentationUrl This property is required. string
(String) The URL for this tool's documentation.
imageUrl This property is required. string
(String) The URL of the icon shown on the tool integration card in the graphical UI.
lifecyclePhase This property is required. string
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
name This property is required. string
(String) The name for this tool integration.
type This property is required. string
(String) The type of tool that this custom tool is integrating with.
additional_properties This property is required. str
(String) Any information that is needed to integrate with other tools in the toolchain.
dashboard_url This property is required. str
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
description This property is required. str
(String) A description outlining the function of this tool.
documentation_url This property is required. str
(String) The URL for this tool's documentation.
image_url This property is required. str
(String) The URL of the icon shown on the tool integration card in the graphical UI.
lifecycle_phase This property is required. str
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
name This property is required. str
(String) The name for this tool integration.
type This property is required. str
(String) The type of tool that this custom tool is integrating with.
additionalProperties This property is required. String
(String) Any information that is needed to integrate with other tools in the toolchain.
dashboardUrl This property is required. String
(String) The URL of the dashboard for this integration. In the graphical UI, this is the dashboard that the browser will navigate to when you click the integration tile.
description This property is required. String
(String) A description outlining the function of this tool.
documentationUrl This property is required. String
(String) The URL for this tool's documentation.
imageUrl This property is required. String
(String) The URL of the icon shown on the tool integration card in the graphical UI.
lifecyclePhase This property is required. String
(String) The lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.

  • Constraints: Allowable values are: THINK, CODE, DELIVER, RUN, MANAGE, LEARN, CULTURE.
name This property is required. String
(String) The name for this tool integration.
type This property is required. String
(String) The type of tool that this custom tool is integrating with.

GetCdToolchainToolCustomReferent

ApiHref This property is required. string
(String) URI representing this resource through an API.
UiHref This property is required. string
(String) URI representing this resource through the UI.
ApiHref This property is required. string
(String) URI representing this resource through an API.
UiHref This property is required. string
(String) URI representing this resource through the UI.
apiHref This property is required. String
(String) URI representing this resource through an API.
uiHref This property is required. String
(String) URI representing this resource through the UI.
apiHref This property is required. string
(String) URI representing this resource through an API.
uiHref This property is required. string
(String) URI representing this resource through the UI.
api_href This property is required. str
(String) URI representing this resource through an API.
ui_href This property is required. str
(String) URI representing this resource through the UI.
apiHref This property is required. String
(String) URI representing this resource through an API.
uiHref This property is required. 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.