Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudbuild
  5. cloudbuild/v1
  6. getGithubEnterpriseConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudbuild/v1.getGithubEnterpriseConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Retrieve a GitHubEnterpriseConfig.

Using getGithubEnterpriseConfig

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 getGithubEnterpriseConfig(args: GetGithubEnterpriseConfigArgs, opts?: InvokeOptions): Promise<GetGithubEnterpriseConfigResult>
function getGithubEnterpriseConfigOutput(args: GetGithubEnterpriseConfigOutputArgs, opts?: InvokeOptions): Output<GetGithubEnterpriseConfigResult>
Copy
def get_github_enterprise_config(config_id: Optional[str] = None,
                                 github_enterprise_config_id: Optional[str] = None,
                                 location: Optional[str] = None,
                                 project: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetGithubEnterpriseConfigResult
def get_github_enterprise_config_output(config_id: Optional[pulumi.Input[str]] = None,
                                 github_enterprise_config_id: Optional[pulumi.Input[str]] = None,
                                 location: Optional[pulumi.Input[str]] = None,
                                 project: Optional[pulumi.Input[str]] = None,
                                 project_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetGithubEnterpriseConfigResult]
Copy
func LookupGithubEnterpriseConfig(ctx *Context, args *LookupGithubEnterpriseConfigArgs, opts ...InvokeOption) (*LookupGithubEnterpriseConfigResult, error)
func LookupGithubEnterpriseConfigOutput(ctx *Context, args *LookupGithubEnterpriseConfigOutputArgs, opts ...InvokeOption) LookupGithubEnterpriseConfigResultOutput
Copy

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

public static class GetGithubEnterpriseConfig 
{
    public static Task<GetGithubEnterpriseConfigResult> InvokeAsync(GetGithubEnterpriseConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetGithubEnterpriseConfigResult> Invoke(GetGithubEnterpriseConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGithubEnterpriseConfigResult> getGithubEnterpriseConfig(GetGithubEnterpriseConfigArgs args, InvokeOptions options)
public static Output<GetGithubEnterpriseConfigResult> getGithubEnterpriseConfig(GetGithubEnterpriseConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:cloudbuild/v1:getGithubEnterpriseConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GithubEnterpriseConfigId This property is required. string
Location This property is required. string
ConfigId string
Project string
ProjectId string
GithubEnterpriseConfigId This property is required. string
Location This property is required. string
ConfigId string
Project string
ProjectId string
githubEnterpriseConfigId This property is required. String
location This property is required. String
configId String
project String
projectId String
githubEnterpriseConfigId This property is required. string
location This property is required. string
configId string
project string
projectId string
github_enterprise_config_id This property is required. str
location This property is required. str
config_id str
project str
project_id str
githubEnterpriseConfigId This property is required. String
location This property is required. String
configId String
project String
projectId String

getGithubEnterpriseConfig Result

The following output properties are available:

AppId string
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
CreateTime string
Time when the installation was associated with the project.
DisplayName string
Name to display for this config.
HostUrl string
The URL of the github enterprise host the configuration is for.
Name string
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
PeeredNetwork string
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
Secrets Pulumi.GoogleNative.CloudBuild.V1.Outputs.GitHubEnterpriseSecretsResponse
Names of secrets in Secret Manager.
SslCa string
Optional. SSL certificate to use for requests to GitHub Enterprise.
WebhookKey string
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
AppId string
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
CreateTime string
Time when the installation was associated with the project.
DisplayName string
Name to display for this config.
HostUrl string
The URL of the github enterprise host the configuration is for.
Name string
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
PeeredNetwork string
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
Secrets GitHubEnterpriseSecretsResponse
Names of secrets in Secret Manager.
SslCa string
Optional. SSL certificate to use for requests to GitHub Enterprise.
WebhookKey string
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
appId String
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
createTime String
Time when the installation was associated with the project.
displayName String
Name to display for this config.
hostUrl String
The URL of the github enterprise host the configuration is for.
name String
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork String
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secrets GitHubEnterpriseSecretsResponse
Names of secrets in Secret Manager.
sslCa String
Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey String
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
appId string
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
createTime string
Time when the installation was associated with the project.
displayName string
Name to display for this config.
hostUrl string
The URL of the github enterprise host the configuration is for.
name string
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork string
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secrets GitHubEnterpriseSecretsResponse
Names of secrets in Secret Manager.
sslCa string
Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey string
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
app_id str
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
create_time str
Time when the installation was associated with the project.
display_name str
Name to display for this config.
host_url str
The URL of the github enterprise host the configuration is for.
name str
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peered_network str
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secrets GitHubEnterpriseSecretsResponse
Names of secrets in Secret Manager.
ssl_ca str
Optional. SSL certificate to use for requests to GitHub Enterprise.
webhook_key str
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
appId String
The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
createTime String
Time when the installation was associated with the project.
displayName String
Name to display for this config.
hostUrl String
The URL of the github enterprise host the configuration is for.
name String
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork String
Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secrets Property Map
Names of secrets in Secret Manager.
sslCa String
Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey String
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

Supporting Types

GitHubEnterpriseSecretsResponse

OauthClientIdName This property is required. string
The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName This property is required. string
The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName This property is required. string
The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName This property is required. string
The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName This property is required. string
The resource name for the private key secret.
PrivateKeyVersionName This property is required. string
The resource name for the private key secret version.
WebhookSecretName This property is required. string
The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName This property is required. string
The resource name for the webhook secret secret version in Secret Manager.
OauthClientIdName This property is required. string
The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName This property is required. string
The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName This property is required. string
The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName This property is required. string
The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName This property is required. string
The resource name for the private key secret.
PrivateKeyVersionName This property is required. string
The resource name for the private key secret version.
WebhookSecretName This property is required. string
The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName This property is required. string
The resource name for the webhook secret secret version in Secret Manager.
oauthClientIdName This property is required. String
The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName This property is required. String
The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName This property is required. String
The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName This property is required. String
The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName This property is required. String
The resource name for the private key secret.
privateKeyVersionName This property is required. String
The resource name for the private key secret version.
webhookSecretName This property is required. String
The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName This property is required. String
The resource name for the webhook secret secret version in Secret Manager.
oauthClientIdName This property is required. string
The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName This property is required. string
The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName This property is required. string
The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName This property is required. string
The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName This property is required. string
The resource name for the private key secret.
privateKeyVersionName This property is required. string
The resource name for the private key secret version.
webhookSecretName This property is required. string
The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName This property is required. string
The resource name for the webhook secret secret version in Secret Manager.
oauth_client_id_name This property is required. str
The resource name for the OAuth client ID secret in Secret Manager.
oauth_client_id_version_name This property is required. str
The resource name for the OAuth client ID secret version in Secret Manager.
oauth_secret_name This property is required. str
The resource name for the OAuth secret in Secret Manager.
oauth_secret_version_name This property is required. str
The resource name for the OAuth secret secret version in Secret Manager.
private_key_name This property is required. str
The resource name for the private key secret.
private_key_version_name This property is required. str
The resource name for the private key secret version.
webhook_secret_name This property is required. str
The resource name for the webhook secret in Secret Manager.
webhook_secret_version_name This property is required. str
The resource name for the webhook secret secret version in Secret Manager.
oauthClientIdName This property is required. String
The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName This property is required. String
The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName This property is required. String
The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName This property is required. String
The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName This property is required. String
The resource name for the private key secret.
privateKeyVersionName This property is required. String
The resource name for the private key secret version.
webhookSecretName This property is required. String
The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName This property is required. String
The resource name for the webhook secret secret version in Secret Manager.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native