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

ibm.getCdToolchainToolJira

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a cd_toolchain_tool_jira. 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 cdToolchainToolJira = ibm.getCdToolchainToolJira({
    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_jira = ibm.get_cd_toolchain_tool_jira(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.LookupCdToolchainToolJira(ctx, &ibm.LookupCdToolchainToolJiraArgs{
			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 cdToolchainToolJira = Ibm.GetCdToolchainToolJira.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.GetCdToolchainToolJiraArgs;
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 cdToolchainToolJira = IbmFunctions.getCdToolchainToolJira(GetCdToolchainToolJiraArgs.builder()
            .toolId("9603dcd4-3c86-44f8-8d0a-9427369878cf")
            .toolchainId(data.ibm_cd_toolchain().cd_toolchain().id())
            .build());

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

Using getCdToolchainToolJira

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 getCdToolchainToolJira(args: GetCdToolchainToolJiraArgs, opts?: InvokeOptions): Promise<GetCdToolchainToolJiraResult>
function getCdToolchainToolJiraOutput(args: GetCdToolchainToolJiraOutputArgs, opts?: InvokeOptions): Output<GetCdToolchainToolJiraResult>
Copy
def get_cd_toolchain_tool_jira(id: Optional[str] = None,
                               tool_id: Optional[str] = None,
                               toolchain_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCdToolchainToolJiraResult
def get_cd_toolchain_tool_jira_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[GetCdToolchainToolJiraResult]
Copy
func LookupCdToolchainToolJira(ctx *Context, args *LookupCdToolchainToolJiraArgs, opts ...InvokeOption) (*LookupCdToolchainToolJiraResult, error)
func LookupCdToolchainToolJiraOutput(ctx *Context, args *LookupCdToolchainToolJiraOutputArgs, opts ...InvokeOption) LookupCdToolchainToolJiraResultOutput
Copy

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

public static class GetCdToolchainToolJira 
{
    public static Task<GetCdToolchainToolJiraResult> InvokeAsync(GetCdToolchainToolJiraArgs args, InvokeOptions? opts = null)
    public static Output<GetCdToolchainToolJiraResult> Invoke(GetCdToolchainToolJiraInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCdToolchainToolJiraResult> getCdToolchainToolJira(GetCdToolchainToolJiraArgs args, InvokeOptions options)
public static Output<GetCdToolchainToolJiraResult> getCdToolchainToolJira(GetCdToolchainToolJiraArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCdToolchainToolJira:getCdToolchainToolJira
  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_jira.
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_jira.
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_jira.
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_jira.
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_jira.
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_jira.

getCdToolchainToolJira 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_jira.
Name string
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
Parameters List<GetCdToolchainToolJiraParameter>
(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<GetCdToolchainToolJiraReferent>
(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_jira.
Name string
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
Parameters []GetCdToolchainToolJiraParameter
(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 []GetCdToolchainToolJiraReferent
(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_jira.
name String
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
parameters List<GetCdToolchainToolJiraParameter>
(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<GetCdToolchainToolJiraReferent>
(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_jira.
name string
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
parameters GetCdToolchainToolJiraParameter[]
(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 GetCdToolchainToolJiraReferent[]
(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_jira.
name str
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
parameters Sequence[GetCdToolchainToolJiraParameter]
(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[GetCdToolchainToolJiraReferent]
(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_jira.
name String
(String) Name of the tool.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/.
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

GetCdToolchainToolJiraParameter

ApiToken This property is required. string
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
ApiUrl This property is required. string
(String) The base API URL for your JIRA instance.
EnableTraceability This property is required. bool
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
ProjectKey This property is required. string
(String) The project key of your JIRA project.
Username This property is required. string
(String) The user name for your JIRA account. Optional for public projects.
ApiToken This property is required. string
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
ApiUrl This property is required. string
(String) The base API URL for your JIRA instance.
EnableTraceability This property is required. bool
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
ProjectKey This property is required. string
(String) The project key of your JIRA project.
Username This property is required. string
(String) The user name for your JIRA account. Optional for public projects.
apiToken This property is required. String
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
apiUrl This property is required. String
(String) The base API URL for your JIRA instance.
enableTraceability This property is required. Boolean
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
projectKey This property is required. String
(String) The project key of your JIRA project.
username This property is required. String
(String) The user name for your JIRA account. Optional for public projects.
apiToken This property is required. string
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
apiUrl This property is required. string
(String) The base API URL for your JIRA instance.
enableTraceability This property is required. boolean
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
projectKey This property is required. string
(String) The project key of your JIRA project.
username This property is required. string
(String) The user name for your JIRA account. Optional for public projects.
api_token This property is required. str
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
api_url This property is required. str
(String) The base API URL for your JIRA instance.
enable_traceability This property is required. bool
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
project_key This property is required. str
(String) The project key of your JIRA project.
username This property is required. str
(String) The user name for your JIRA account. Optional for public projects.
apiToken This property is required. String
(String) The api token for your JIRA account. Optional for public projects. You can use a toolchain secret reference for this parameter. For more information, see Protecting your sensitive data in Continuous Delivery.
apiUrl This property is required. String
(String) The base API URL for your JIRA instance.
enableTraceability This property is required. Boolean
(Boolean) Track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.

  • Constraints: The default value is false.
projectKey This property is required. String
(String) The project key of your JIRA project.
username This property is required. String
(String) The user name for your JIRA account. Optional for public projects.

GetCdToolchainToolJiraReferent

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.