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

ibm.getCdToolchainToolGithubconsolidated

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a cd_toolchain_tool_githubconsolidated. 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 cdToolchainToolGithubconsolidated = ibm.getCdToolchainToolGithubconsolidated({
    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_githubconsolidated = ibm.get_cd_toolchain_tool_githubconsolidated(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.LookupCdToolchainToolGithubconsolidated(ctx, &ibm.LookupCdToolchainToolGithubconsolidatedArgs{
			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 cdToolchainToolGithubconsolidated = Ibm.GetCdToolchainToolGithubconsolidated.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.GetCdToolchainToolGithubconsolidatedArgs;
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 cdToolchainToolGithubconsolidated = IbmFunctions.getCdToolchainToolGithubconsolidated(GetCdToolchainToolGithubconsolidatedArgs.builder()
            .toolId("9603dcd4-3c86-44f8-8d0a-9427369878cf")
            .toolchainId(data.ibm_cd_toolchain().cd_toolchain().id())
            .build());

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

Using getCdToolchainToolGithubconsolidated

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 getCdToolchainToolGithubconsolidated(args: GetCdToolchainToolGithubconsolidatedArgs, opts?: InvokeOptions): Promise<GetCdToolchainToolGithubconsolidatedResult>
function getCdToolchainToolGithubconsolidatedOutput(args: GetCdToolchainToolGithubconsolidatedOutputArgs, opts?: InvokeOptions): Output<GetCdToolchainToolGithubconsolidatedResult>
Copy
def get_cd_toolchain_tool_githubconsolidated(id: Optional[str] = None,
                                             tool_id: Optional[str] = None,
                                             toolchain_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCdToolchainToolGithubconsolidatedResult
def get_cd_toolchain_tool_githubconsolidated_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[GetCdToolchainToolGithubconsolidatedResult]
Copy
func LookupCdToolchainToolGithubconsolidated(ctx *Context, args *LookupCdToolchainToolGithubconsolidatedArgs, opts ...InvokeOption) (*LookupCdToolchainToolGithubconsolidatedResult, error)
func LookupCdToolchainToolGithubconsolidatedOutput(ctx *Context, args *LookupCdToolchainToolGithubconsolidatedOutputArgs, opts ...InvokeOption) LookupCdToolchainToolGithubconsolidatedResultOutput
Copy

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

public static class GetCdToolchainToolGithubconsolidated 
{
    public static Task<GetCdToolchainToolGithubconsolidatedResult> InvokeAsync(GetCdToolchainToolGithubconsolidatedArgs args, InvokeOptions? opts = null)
    public static Output<GetCdToolchainToolGithubconsolidatedResult> Invoke(GetCdToolchainToolGithubconsolidatedInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCdToolchainToolGithubconsolidatedResult> getCdToolchainToolGithubconsolidated(GetCdToolchainToolGithubconsolidatedArgs args, InvokeOptions options)
public static Output<GetCdToolchainToolGithubconsolidatedResult> getCdToolchainToolGithubconsolidated(GetCdToolchainToolGithubconsolidatedArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCdToolchainToolGithubconsolidated:getCdToolchainToolGithubconsolidated
  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_githubconsolidated.
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_githubconsolidated.
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_githubconsolidated.
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_githubconsolidated.
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_githubconsolidated.
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_githubconsolidated.

getCdToolchainToolGithubconsolidated 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_githubconsolidated.
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<GetCdToolchainToolGithubconsolidatedParameter>
(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<GetCdToolchainToolGithubconsolidatedReferent>
(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_githubconsolidated.
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 []GetCdToolchainToolGithubconsolidatedParameter
(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 []GetCdToolchainToolGithubconsolidatedReferent
(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_githubconsolidated.
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<GetCdToolchainToolGithubconsolidatedParameter>
(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<GetCdToolchainToolGithubconsolidatedReferent>
(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_githubconsolidated.
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 GetCdToolchainToolGithubconsolidatedParameter[]
(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 GetCdToolchainToolGithubconsolidatedReferent[]
(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_githubconsolidated.
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[GetCdToolchainToolGithubconsolidatedParameter]
(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[GetCdToolchainToolGithubconsolidatedReferent]
(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_githubconsolidated.
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

GetCdToolchainToolGithubconsolidatedParameter

ApiRootUrl This property is required. string
(String) The API root URL for the GitHub server.
ApiToken This property is required. string
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
AuthType This property is required. string
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
AutoInit This property is required. bool
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
BlindConnection This property is required. bool
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
DefaultBranch This property is required. string
(String) The default branch of the git repository.
EnableTraceability This property is required. bool
(Boolean) Set this value to 'true' to 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.
GitId This property is required. string
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
IntegrationOwner This property is required. string
(String) Select the user which git operations will be performed as.
OwnerId This property is required. string
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
PrivateRepo This property is required. bool
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
RepoId This property is required. string
(String) The ID of the GitHub repository.
RepoName This property is required. string
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
RepoUrl This property is required. string
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
RootUrl This property is required. string
(String) The Root URL of the server. e.g. https://github.example.com.
SourceRepoUrl This property is required. string
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
Title This property is required. string
(String) The title of the server. e.g. My GitHub Enterprise Server.
TokenUrl This property is required. string
(String) The token URL used for authorizing with the GitHub server.
ToolchainIssuesEnabled This property is required. bool
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
Type This property is required. string
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.
ApiRootUrl This property is required. string
(String) The API root URL for the GitHub server.
ApiToken This property is required. string
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
AuthType This property is required. string
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
AutoInit This property is required. bool
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
BlindConnection This property is required. bool
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
DefaultBranch This property is required. string
(String) The default branch of the git repository.
EnableTraceability This property is required. bool
(Boolean) Set this value to 'true' to 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.
GitId This property is required. string
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
IntegrationOwner This property is required. string
(String) Select the user which git operations will be performed as.
OwnerId This property is required. string
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
PrivateRepo This property is required. bool
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
RepoId This property is required. string
(String) The ID of the GitHub repository.
RepoName This property is required. string
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
RepoUrl This property is required. string
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
RootUrl This property is required. string
(String) The Root URL of the server. e.g. https://github.example.com.
SourceRepoUrl This property is required. string
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
Title This property is required. string
(String) The title of the server. e.g. My GitHub Enterprise Server.
TokenUrl This property is required. string
(String) The token URL used for authorizing with the GitHub server.
ToolchainIssuesEnabled This property is required. bool
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
Type This property is required. string
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.
apiRootUrl This property is required. String
(String) The API root URL for the GitHub server.
apiToken This property is required. String
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
authType This property is required. String
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
autoInit This property is required. Boolean
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
blindConnection This property is required. Boolean
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
defaultBranch This property is required. String
(String) The default branch of the git repository.
enableTraceability This property is required. Boolean
(Boolean) Set this value to 'true' to 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.
gitId This property is required. String
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
integrationOwner This property is required. String
(String) Select the user which git operations will be performed as.
ownerId This property is required. String
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
privateRepo This property is required. Boolean
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
repoId This property is required. String
(String) The ID of the GitHub repository.
repoName This property is required. String
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
repoUrl This property is required. String
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
rootUrl This property is required. String
(String) The Root URL of the server. e.g. https://github.example.com.
sourceRepoUrl This property is required. String
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
title This property is required. String
(String) The title of the server. e.g. My GitHub Enterprise Server.
tokenUrl This property is required. String
(String) The token URL used for authorizing with the GitHub server.
toolchainIssuesEnabled This property is required. Boolean
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
type This property is required. String
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.
apiRootUrl This property is required. string
(String) The API root URL for the GitHub server.
apiToken This property is required. string
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
authType This property is required. string
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
autoInit This property is required. boolean
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
blindConnection This property is required. boolean
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
defaultBranch This property is required. string
(String) The default branch of the git repository.
enableTraceability This property is required. boolean
(Boolean) Set this value to 'true' to 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.
gitId This property is required. string
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
integrationOwner This property is required. string
(String) Select the user which git operations will be performed as.
ownerId This property is required. string
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
privateRepo This property is required. boolean
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
repoId This property is required. string
(String) The ID of the GitHub repository.
repoName This property is required. string
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
repoUrl This property is required. string
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
rootUrl This property is required. string
(String) The Root URL of the server. e.g. https://github.example.com.
sourceRepoUrl This property is required. string
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
title This property is required. string
(String) The title of the server. e.g. My GitHub Enterprise Server.
tokenUrl This property is required. string
(String) The token URL used for authorizing with the GitHub server.
toolchainIssuesEnabled This property is required. boolean
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
type This property is required. string
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.
api_root_url This property is required. str
(String) The API root URL for the GitHub server.
api_token This property is required. str
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
auth_type This property is required. str
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
auto_init This property is required. bool
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
blind_connection This property is required. bool
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
default_branch This property is required. str
(String) The default branch of the git repository.
enable_traceability This property is required. bool
(Boolean) Set this value to 'true' to 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.
git_id This property is required. str
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
integration_owner This property is required. str
(String) Select the user which git operations will be performed as.
owner_id This property is required. str
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
private_repo This property is required. bool
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
repo_id This property is required. str
(String) The ID of the GitHub repository.
repo_name This property is required. str
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
repo_url This property is required. str
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
root_url This property is required. str
(String) The Root URL of the server. e.g. https://github.example.com.
source_repo_url This property is required. str
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
title This property is required. str
(String) The title of the server. e.g. My GitHub Enterprise Server.
token_url This property is required. str
(String) The token URL used for authorizing with the GitHub server.
toolchain_issues_enabled This property is required. bool
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
type This property is required. str
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.
apiRootUrl This property is required. String
(String) The API root URL for the GitHub server.
apiToken This property is required. String
(String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
authType This property is required. String
(String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.

  • Constraints: Allowable values are: oauth, pat.
autoInit This property is required. Boolean
(Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.

  • Constraints: The default value is false.
blindConnection This property is required. Boolean
(Boolean) Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.

  • Constraints: The default value is false.
defaultBranch This property is required. String
(String) The default branch of the git repository.
enableTraceability This property is required. Boolean
(Boolean) Set this value to 'true' to 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.
gitId This property is required. String
(String) Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
integrationOwner This property is required. String
(String) Select the user which git operations will be performed as.
ownerId This property is required. String
(String) The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
privateRepo This property is required. Boolean
(Boolean) Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.

  • Constraints: The default value is false.
repoId This property is required. String
(String) The ID of the GitHub repository.
repoName This property is required. String
(String) The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
repoUrl This property is required. String
(String) The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
rootUrl This property is required. String
(String) The Root URL of the server. e.g. https://github.example.com.
sourceRepoUrl This property is required. String
(String) The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
title This property is required. String
(String) The title of the server. e.g. My GitHub Enterprise Server.
tokenUrl This property is required. String
(String) The token URL used for authorizing with the GitHub server.
toolchainIssuesEnabled This property is required. Boolean
(Boolean) Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.

  • Constraints: The default value is true.
type This property is required. String
(String) The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.

  • Constraints: Allowable values are: new, fork, clone, link, new_if_not_exists, clone_if_not_exists, fork_if_not_exists.

GetCdToolchainToolGithubconsolidatedReferent

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.