1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getGitopsRepository
Harness v0.2.0 published on Wednesday, Jul 24, 2024 by Pulumi

harness.platform.getGitopsRepository

Explore with Pulumi AI

harness logo
Harness v0.2.0 published on Wednesday, Jul 24, 2024 by Pulumi

    Data source for fetching a Harness GitOps Repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getGitopsRepository({
        identifier: "identifier",
        accountId: "account_id",
        projectId: "project_id",
        orgId: "org_id",
        agentId: "agent_id",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_gitops_repository(identifier="identifier",
        account_id="account_id",
        project_id="project_id",
        org_id="org_id",
        agent_id="agent_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.GetGitopsRepository(ctx, &platform.GetGitopsRepositoryArgs{
    			Identifier: "identifier",
    			AccountId:  "account_id",
    			ProjectId:  pulumi.StringRef("project_id"),
    			OrgId:      pulumi.StringRef("org_id"),
    			AgentId:    "agent_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetGitopsRepository.Invoke(new()
        {
            Identifier = "identifier",
            AccountId = "account_id",
            ProjectId = "project_id",
            OrgId = "org_id",
            AgentId = "agent_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetGitopsRepositoryArgs;
    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 example = PlatformFunctions.getGitopsRepository(GetGitopsRepositoryArgs.builder()
                .identifier("identifier")
                .accountId("account_id")
                .projectId("project_id")
                .orgId("org_id")
                .agentId("agent_id")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getGitopsRepository
          Arguments:
            identifier: identifier
            accountId: account_id
            projectId: project_id
            orgId: org_id
            agentId: agent_id
    

    Using getGitopsRepository

    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 getGitopsRepository(args: GetGitopsRepositoryArgs, opts?: InvokeOptions): Promise<GetGitopsRepositoryResult>
    function getGitopsRepositoryOutput(args: GetGitopsRepositoryOutputArgs, opts?: InvokeOptions): Output<GetGitopsRepositoryResult>
    def get_gitops_repository(account_id: Optional[str] = None,
                              agent_id: Optional[str] = None,
                              enable_oci: Optional[bool] = None,
                              identifier: Optional[str] = None,
                              org_id: Optional[str] = None,
                              project_id: Optional[str] = None,
                              update_masks: Optional[Sequence[GetGitopsRepositoryUpdateMask]] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGitopsRepositoryResult
    def get_gitops_repository_output(account_id: Optional[pulumi.Input[str]] = None,
                              agent_id: Optional[pulumi.Input[str]] = None,
                              enable_oci: Optional[pulumi.Input[bool]] = None,
                              identifier: Optional[pulumi.Input[str]] = None,
                              org_id: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              update_masks: Optional[pulumi.Input[Sequence[pulumi.Input[GetGitopsRepositoryUpdateMaskArgs]]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGitopsRepositoryResult]
    func GetGitopsRepository(ctx *Context, args *GetGitopsRepositoryArgs, opts ...InvokeOption) (*GetGitopsRepositoryResult, error)
    func GetGitopsRepositoryOutput(ctx *Context, args *GetGitopsRepositoryOutputArgs, opts ...InvokeOption) GetGitopsRepositoryResultOutput

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

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

    The following arguments are supported:

    AccountId string
    Account identifier of the GitOps repository.
    AgentId string
    Agent identifier of the GitOps repository.
    Identifier string
    Identifier of the GitOps repository.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    OrgId string
    Organization identifier of the GitOps repository.
    ProjectId string
    Project identifier of the GitOps repository.
    UpdateMasks List<GetGitopsRepositoryUpdateMask>
    Update mask of the repository.
    AccountId string
    Account identifier of the GitOps repository.
    AgentId string
    Agent identifier of the GitOps repository.
    Identifier string
    Identifier of the GitOps repository.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    OrgId string
    Organization identifier of the GitOps repository.
    ProjectId string
    Project identifier of the GitOps repository.
    UpdateMasks []GetGitopsRepositoryUpdateMask
    Update mask of the repository.
    accountId String
    Account identifier of the GitOps repository.
    agentId String
    Agent identifier of the GitOps repository.
    identifier String
    Identifier of the GitOps repository.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    orgId String
    Organization identifier of the GitOps repository.
    projectId String
    Project identifier of the GitOps repository.
    updateMasks List<GetGitopsRepositoryUpdateMask>
    Update mask of the repository.
    accountId string
    Account identifier of the GitOps repository.
    agentId string
    Agent identifier of the GitOps repository.
    identifier string
    Identifier of the GitOps repository.
    enableOci boolean
    Indicates if helm-oci support must be enabled for this repo.
    orgId string
    Organization identifier of the GitOps repository.
    projectId string
    Project identifier of the GitOps repository.
    updateMasks GetGitopsRepositoryUpdateMask[]
    Update mask of the repository.
    account_id str
    Account identifier of the GitOps repository.
    agent_id str
    Agent identifier of the GitOps repository.
    identifier str
    Identifier of the GitOps repository.
    enable_oci bool
    Indicates if helm-oci support must be enabled for this repo.
    org_id str
    Organization identifier of the GitOps repository.
    project_id str
    Project identifier of the GitOps repository.
    update_masks Sequence[GetGitopsRepositoryUpdateMask]
    Update mask of the repository.
    accountId String
    Account identifier of the GitOps repository.
    agentId String
    Agent identifier of the GitOps repository.
    identifier String
    Identifier of the GitOps repository.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    orgId String
    Organization identifier of the GitOps repository.
    projectId String
    Project identifier of the GitOps repository.
    updateMasks List<Property Map>
    Update mask of the repository.

    getGitopsRepository Result

    The following output properties are available:

    AccountId string
    Account identifier of the GitOps repository.
    AgentId string
    Agent identifier of the GitOps repository.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identifier of the GitOps repository.
    Repos List<GetGitopsRepositoryRepo>
    Repo details holding application configurations.
    UpdateMasks List<GetGitopsRepositoryUpdateMask>
    Update mask of the repository.
    OrgId string
    Organization identifier of the GitOps repository.
    ProjectId string
    Project identifier of the GitOps repository.
    AccountId string
    Account identifier of the GitOps repository.
    AgentId string
    Agent identifier of the GitOps repository.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identifier of the GitOps repository.
    Repos []GetGitopsRepositoryRepo
    Repo details holding application configurations.
    UpdateMasks []GetGitopsRepositoryUpdateMask
    Update mask of the repository.
    OrgId string
    Organization identifier of the GitOps repository.
    ProjectId string
    Project identifier of the GitOps repository.
    accountId String
    Account identifier of the GitOps repository.
    agentId String
    Agent identifier of the GitOps repository.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identifier of the GitOps repository.
    repos List<GetGitopsRepositoryRepo>
    Repo details holding application configurations.
    updateMasks List<GetGitopsRepositoryUpdateMask>
    Update mask of the repository.
    orgId String
    Organization identifier of the GitOps repository.
    projectId String
    Project identifier of the GitOps repository.
    accountId string
    Account identifier of the GitOps repository.
    agentId string
    Agent identifier of the GitOps repository.
    enableOci boolean
    Indicates if helm-oci support must be enabled for this repo.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Identifier of the GitOps repository.
    repos GetGitopsRepositoryRepo[]
    Repo details holding application configurations.
    updateMasks GetGitopsRepositoryUpdateMask[]
    Update mask of the repository.
    orgId string
    Organization identifier of the GitOps repository.
    projectId string
    Project identifier of the GitOps repository.
    account_id str
    Account identifier of the GitOps repository.
    agent_id str
    Agent identifier of the GitOps repository.
    enable_oci bool
    Indicates if helm-oci support must be enabled for this repo.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Identifier of the GitOps repository.
    repos Sequence[GetGitopsRepositoryRepo]
    Repo details holding application configurations.
    update_masks Sequence[GetGitopsRepositoryUpdateMask]
    Update mask of the repository.
    org_id str
    Organization identifier of the GitOps repository.
    project_id str
    Project identifier of the GitOps repository.
    accountId String
    Account identifier of the GitOps repository.
    agentId String
    Agent identifier of the GitOps repository.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identifier of the GitOps repository.
    repos List<Property Map>
    Repo details holding application configurations.
    updateMasks List<Property Map>
    Update mask of the repository.
    orgId String
    Organization identifier of the GitOps repository.
    projectId String
    Project identifier of the GitOps repository.

    Supporting Types

    GetGitopsRepositoryRepo

    Project string
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    Type_ string
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    ConnectionType string
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    EnableLfs bool
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    GithubAppEnterpriseBaseUrl string
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    GithubAppId string
    Id of the GitHub app used to access the repo.
    GithubAppInstallationId string
    Installation id of the GitHub app used to access the repo.
    GithubAppPrivateKey string
    GitHub app private key PEM data.
    InheritedCreds bool
    Indicates if the credentials were inherited from a repository credential.
    Insecure bool
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    InsecureIgnoreHostKey bool
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    Name string
    Name to be used for this repo. Only used with Helm repos.
    Password string
    Password or PAT to be used for authenticating the remote repository.
    Proxy string
    The HTTP/HTTPS proxy used to access the repo.
    Repo string
    URL to the remote repository.
    SshPrivateKey string
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    TlsClientCertData string
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    TlsClientCertKey string
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    Username string
    Username to be used for authenticating the remote repository.
    Project string
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    Type_ string
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    ConnectionType string
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    EnableLfs bool
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    EnableOci bool
    Indicates if helm-oci support must be enabled for this repo.
    GithubAppEnterpriseBaseUrl string
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    GithubAppId string
    Id of the GitHub app used to access the repo.
    GithubAppInstallationId string
    Installation id of the GitHub app used to access the repo.
    GithubAppPrivateKey string
    GitHub app private key PEM data.
    InheritedCreds bool
    Indicates if the credentials were inherited from a repository credential.
    Insecure bool
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    InsecureIgnoreHostKey bool
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    Name string
    Name to be used for this repo. Only used with Helm repos.
    Password string
    Password or PAT to be used for authenticating the remote repository.
    Proxy string
    The HTTP/HTTPS proxy used to access the repo.
    Repo string
    URL to the remote repository.
    SshPrivateKey string
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    TlsClientCertData string
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    TlsClientCertKey string
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    Username string
    Username to be used for authenticating the remote repository.
    project String
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    type_ String
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    connectionType String
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    enableLfs Boolean
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    githubAppEnterpriseBaseUrl String
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    githubAppId String
    Id of the GitHub app used to access the repo.
    githubAppInstallationId String
    Installation id of the GitHub app used to access the repo.
    githubAppPrivateKey String
    GitHub app private key PEM data.
    inheritedCreds Boolean
    Indicates if the credentials were inherited from a repository credential.
    insecure Boolean
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    insecureIgnoreHostKey Boolean
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    name String
    Name to be used for this repo. Only used with Helm repos.
    password String
    Password or PAT to be used for authenticating the remote repository.
    proxy String
    The HTTP/HTTPS proxy used to access the repo.
    repo String
    URL to the remote repository.
    sshPrivateKey String
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    tlsClientCertData String
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    tlsClientCertKey String
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    username String
    Username to be used for authenticating the remote repository.
    project string
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    type_ string
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    connectionType string
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    enableLfs boolean
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    enableOci boolean
    Indicates if helm-oci support must be enabled for this repo.
    githubAppEnterpriseBaseUrl string
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    githubAppId string
    Id of the GitHub app used to access the repo.
    githubAppInstallationId string
    Installation id of the GitHub app used to access the repo.
    githubAppPrivateKey string
    GitHub app private key PEM data.
    inheritedCreds boolean
    Indicates if the credentials were inherited from a repository credential.
    insecure boolean
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    insecureIgnoreHostKey boolean
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    name string
    Name to be used for this repo. Only used with Helm repos.
    password string
    Password or PAT to be used for authenticating the remote repository.
    proxy string
    The HTTP/HTTPS proxy used to access the repo.
    repo string
    URL to the remote repository.
    sshPrivateKey string
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    tlsClientCertData string
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    tlsClientCertKey string
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    username string
    Username to be used for authenticating the remote repository.
    project str
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    type_ str
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    connection_type str
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    enable_lfs bool
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    enable_oci bool
    Indicates if helm-oci support must be enabled for this repo.
    github_app_enterprise_base_url str
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    github_app_id str
    Id of the GitHub app used to access the repo.
    github_app_installation_id str
    Installation id of the GitHub app used to access the repo.
    github_app_private_key str
    GitHub app private key PEM data.
    inherited_creds bool
    Indicates if the credentials were inherited from a repository credential.
    insecure bool
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    insecure_ignore_host_key bool
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    name str
    Name to be used for this repo. Only used with Helm repos.
    password str
    Password or PAT to be used for authenticating the remote repository.
    proxy str
    The HTTP/HTTPS proxy used to access the repo.
    repo str
    URL to the remote repository.
    ssh_private_key str
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    tls_client_cert_data str
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    tls_client_cert_key str
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    username str
    Username to be used for authenticating the remote repository.
    project String
    The ArgoCD project name corresponding to this GitOps repository. An empty string means that the GitOps repository belongs to the default project created by Harness.
    type_ String
    Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
    connectionType String
    Identifies the authentication method used to connect to the repository. Possible values: "HTTPS" "SSH" "GITHUB" "HTTPS_ANONYMOUS_CONNECTION_TYPE"
    enableLfs Boolean
    Indicates if git-lfs support must be enabled for this repo. This is valid only for Git repositories.
    enableOci Boolean
    Indicates if helm-oci support must be enabled for this repo.
    githubAppEnterpriseBaseUrl String
    Base URL of GitHub Enterprise installation. If left empty, this defaults to https://api.github.com.
    githubAppId String
    Id of the GitHub app used to access the repo.
    githubAppInstallationId String
    Installation id of the GitHub app used to access the repo.
    githubAppPrivateKey String
    GitHub app private key PEM data.
    inheritedCreds Boolean
    Indicates if the credentials were inherited from a repository credential.
    insecure Boolean
    Indicates if the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys.
    insecureIgnoreHostKey Boolean
    Indicates if InsecureIgnoreHostKey should be used. Insecure is favored used only for git repos. Deprecated.
    name String
    Name to be used for this repo. Only used with Helm repos.
    password String
    Password or PAT to be used for authenticating the remote repository.
    proxy String
    The HTTP/HTTPS proxy used to access the repo.
    repo String
    URL to the remote repository.
    sshPrivateKey String
    SSH Key in PEM format for authenticating the repository. Used only for Git repository.
    tlsClientCertData String
    Certificate in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    tlsClientCertKey String
    Private key in PEM format for authenticating at the repo server. This is used for mTLS. The value should be base64 encoded.
    username String
    Username to be used for authenticating the remote repository.

    GetGitopsRepositoryUpdateMask

    Paths List<string>
    The set of field mask paths.
    Paths []string
    The set of field mask paths.
    paths List<String>
    The set of field mask paths.
    paths string[]
    The set of field mask paths.
    paths Sequence[str]
    The set of field mask paths.
    paths List<String>
    The set of field mask paths.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.2.0 published on Wednesday, Jul 24, 2024 by Pulumi