harness.platform.getGithubConnector

Datasource for looking up a Github connector.

Using getGithubConnector

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 getGithubConnector(args: GetGithubConnectorArgs, opts?: InvokeOptions): Promise<GetGithubConnectorResult>
function getGithubConnectorOutput(args: GetGithubConnectorOutputArgs, opts?: InvokeOptions): Output<GetGithubConnectorResult>
def get_github_connector(identifier: Optional[str] = None,
                         name: Optional[str] = None,
                         org_id: Optional[str] = None,
                         project_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGithubConnectorResult
def get_github_connector_output(identifier: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         org_id: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetGithubConnectorResult]
func LookupGithubConnector(ctx *Context, args *LookupGithubConnectorArgs, opts ...InvokeOption) (*LookupGithubConnectorResult, error)
func LookupGithubConnectorOutput(ctx *Context, args *LookupGithubConnectorOutputArgs, opts ...InvokeOption) LookupGithubConnectorResultOutput

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

public static class GetGithubConnector 
{
    public static Task<GetGithubConnectorResult> InvokeAsync(GetGithubConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetGithubConnectorResult> Invoke(GetGithubConnectorInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGithubConnectorResult> getGithubConnector(GetGithubConnectorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: harness:platform/getGithubConnector:getGithubConnector
  arguments:
    # arguments dictionary

The following arguments are supported:

Identifier string

Unique identifier of the resource.

Name string

Name of the resource.

OrgId string

Unique identifier of the Organization.

ProjectId string

Unique identifier of the Project.

Identifier string

Unique identifier of the resource.

Name string

Name of the resource.

OrgId string

Unique identifier of the Organization.

ProjectId string

Unique identifier of the Project.

identifier String

Unique identifier of the resource.

name String

Name of the resource.

orgId String

Unique identifier of the Organization.

projectId String

Unique identifier of the Project.

identifier string

Unique identifier of the resource.

name string

Name of the resource.

orgId string

Unique identifier of the Organization.

projectId string

Unique identifier of the Project.

identifier str

Unique identifier of the resource.

name str

Name of the resource.

org_id str

Unique identifier of the Organization.

project_id str

Unique identifier of the Project.

identifier String

Unique identifier of the resource.

name String

Name of the resource.

orgId String

Unique identifier of the Organization.

projectId String

Unique identifier of the Project.

getGithubConnector Result

The following output properties are available:

ApiAuthentications List<Lbrlabs.PulumiPackage.Harness.Platform.Outputs.GetGithubConnectorApiAuthentication>

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

ConnectionType string

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

Credentials List<Lbrlabs.PulumiPackage.Harness.Platform.Outputs.GetGithubConnectorCredential>

Credentials to use for the connection.

DelegateSelectors List<string>

Connect using only the delegates which have these tags.

Description string

Description of the resource.

Id string

The provider-assigned unique ID for this managed resource.

Tags List<string>

Tags to associate with the resource. Tags should be in the form name:value.

Url string

Url of the github repository or account.

ValidationRepo string

Repository to test the connection with. This is only used when connection_type is Account.

Identifier string

Unique identifier of the resource.

Name string

Name of the resource.

OrgId string

Unique identifier of the Organization.

ProjectId string

Unique identifier of the Project.

ApiAuthentications []GetGithubConnectorApiAuthentication

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

ConnectionType string

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

Credentials []GetGithubConnectorCredential

Credentials to use for the connection.

DelegateSelectors []string

Connect using only the delegates which have these tags.

Description string

Description of the resource.

Id string

The provider-assigned unique ID for this managed resource.

Tags []string

Tags to associate with the resource. Tags should be in the form name:value.

Url string

Url of the github repository or account.

ValidationRepo string

Repository to test the connection with. This is only used when connection_type is Account.

Identifier string

Unique identifier of the resource.

Name string

Name of the resource.

OrgId string

Unique identifier of the Organization.

ProjectId string

Unique identifier of the Project.

apiAuthentications List<GetGithubConnectorApiAuthentication>

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

connectionType String

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

credentials List<GetGithubConnectorCredential>

Credentials to use for the connection.

delegateSelectors List<String>

Connect using only the delegates which have these tags.

description String

Description of the resource.

id String

The provider-assigned unique ID for this managed resource.

tags List<String>

Tags to associate with the resource. Tags should be in the form name:value.

url String

Url of the github repository or account.

validationRepo String

Repository to test the connection with. This is only used when connection_type is Account.

identifier String

Unique identifier of the resource.

name String

Name of the resource.

orgId String

Unique identifier of the Organization.

projectId String

Unique identifier of the Project.

apiAuthentications GetGithubConnectorApiAuthentication[]

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

connectionType string

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

credentials GetGithubConnectorCredential[]

Credentials to use for the connection.

delegateSelectors string[]

Connect using only the delegates which have these tags.

description string

Description of the resource.

id string

The provider-assigned unique ID for this managed resource.

tags string[]

Tags to associate with the resource. Tags should be in the form name:value.

url string

Url of the github repository or account.

validationRepo string

Repository to test the connection with. This is only used when connection_type is Account.

identifier string

Unique identifier of the resource.

name string

Name of the resource.

orgId string

Unique identifier of the Organization.

projectId string

Unique identifier of the Project.

api_authentications Sequence[GetGithubConnectorApiAuthentication]

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

connection_type str

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

credentials Sequence[GetGithubConnectorCredential]

Credentials to use for the connection.

delegate_selectors Sequence[str]

Connect using only the delegates which have these tags.

description str

Description of the resource.

id str

The provider-assigned unique ID for this managed resource.

tags Sequence[str]

Tags to associate with the resource. Tags should be in the form name:value.

url str

Url of the github repository or account.

validation_repo str

Repository to test the connection with. This is only used when connection_type is Account.

identifier str

Unique identifier of the resource.

name str

Name of the resource.

org_id str

Unique identifier of the Organization.

project_id str

Unique identifier of the Project.

apiAuthentications List<Property Map>

Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.

connectionType String

Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.

credentials List<Property Map>

Credentials to use for the connection.

delegateSelectors List<String>

Connect using only the delegates which have these tags.

description String

Description of the resource.

id String

The provider-assigned unique ID for this managed resource.

tags List<String>

Tags to associate with the resource. Tags should be in the form name:value.

url String

Url of the github repository or account.

validationRepo String

Repository to test the connection with. This is only used when connection_type is Account.

identifier String

Unique identifier of the resource.

name String

Name of the resource.

orgId String

Unique identifier of the Organization.

projectId String

Unique identifier of the Project.

Supporting Types

GetGithubConnectorApiAuthentication

GetGithubConnectorApiAuthenticationGithubApp

GetGithubConnectorCredential

GetGithubConnectorCredentialHttp

TokenRef string
Username string
UsernameRef string
TokenRef string
Username string
UsernameRef string
tokenRef String
username String
usernameRef String
tokenRef string
username string
usernameRef string
tokenRef String
username String
usernameRef String

GetGithubConnectorCredentialSsh

SshKeyRef string
SshKeyRef string
sshKeyRef String
sshKeyRef string
sshKeyRef String

Package Details

Repository
harness lbrlabs/pulumi-harness
License
Apache-2.0
Notes

This Pulumi package is based on the harness Terraform Provider.