harness.platform.getGitopsAgent

Explore with Pulumi AI

Harness v0.7.0 published on Friday, Mar 28, 2025 by Pulumi

Using getGitopsAgent

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 getGitopsAgent(args: GetGitopsAgentArgs, opts?: InvokeOptions): Promise<GetGitopsAgentResult>
function getGitopsAgentOutput(args: GetGitopsAgentOutputArgs, opts?: InvokeOptions): Output<GetGitopsAgentResult>

def get_gitops_agent(account_id: Optional[str] = None,
                     identifier: Optional[str] = None,
                     org_id: Optional[str] = None,
                     project_id: Optional[str] = None,
                     with_credentials: Optional[bool] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGitopsAgentResult
def get_gitops_agent_output(account_id: Optional[pulumi.Input[str]] = None,
                     identifier: Optional[pulumi.Input[str]] = None,
                     org_id: Optional[pulumi.Input[str]] = None,
                     project_id: Optional[pulumi.Input[str]] = None,
                     with_credentials: Optional[pulumi.Input[bool]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGitopsAgentResult]

func GetGitopsAgent(ctx *Context, args *GetGitopsAgentArgs, opts ...InvokeOption) (*GetGitopsAgentResult, error)
func GetGitopsAgentOutput(ctx *Context, args *GetGitopsAgentOutputArgs, opts ...InvokeOption) GetGitopsAgentResultOutput

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

public static class GetGitopsAgent 
{
    public static Task<GetGitopsAgentResult> InvokeAsync(GetGitopsAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetGitopsAgentResult> Invoke(GetGitopsAgentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGitopsAgentResult> getGitopsAgent(GetGitopsAgentArgs args, InvokeOptions options)
public static Output<GetGitopsAgentResult> getGitopsAgent(GetGitopsAgentArgs args, InvokeOptions options)

fn::invoke:
  function: harness:platform/getGitopsAgent:getGitopsAgent
  arguments:
    # arguments dictionary

The following arguments are supported:

Identifier string: Identifier of the GitOps agent.
AccountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
OrgId string: Organization identifier of the GitOps agent.
ProjectId string: Project identifier of the GitOps agent.
WithCredentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

Identifier string: Identifier of the GitOps agent.
AccountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
OrgId string: Organization identifier of the GitOps agent.
ProjectId string: Project identifier of the GitOps agent.
WithCredentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

identifier String: Identifier of the GitOps agent.
accountId String: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
orgId String: Organization identifier of the GitOps agent.
projectId String: Project identifier of the GitOps agent.
withCredentials Boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

identifier string: Identifier of the GitOps agent.
accountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
orgId string: Organization identifier of the GitOps agent.
projectId string: Project identifier of the GitOps agent.
withCredentials boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

identifier str: Identifier of the GitOps agent.
account_id str: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
org_id str: Organization identifier of the GitOps agent.
project_id str: Project identifier of the GitOps agent.
with_credentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

identifier String: Identifier of the GitOps agent.
accountId String: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
orgId String: Organization identifier of the GitOps agent.
projectId String: Project identifier of the GitOps agent.
withCredentials Boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

getGitopsAgent Result

The following output properties are available:

AccountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
AgentToken string: Agent token to be used for authentication of the agent with Harness.
Description string: Description of the GitOps agent.
Id string: The provider-assigned unique ID for this managed resource.
Identifier string: Identifier of the GitOps agent.
IsAuthenticated bool: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
Metadatas List<GetGitopsAgentMetadata>: Metadata of the agent.
Name string: Name of the GitOps agent.
Operator string: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
PrefixedIdentifier string: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
Tags Dictionary<string, string>: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
Type string: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
OrgId string: Organization identifier of the GitOps agent.
ProjectId string: Project identifier of the GitOps agent.
WithCredentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

AccountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
AgentToken string: Agent token to be used for authentication of the agent with Harness.
Description string: Description of the GitOps agent.
Id string: The provider-assigned unique ID for this managed resource.
Identifier string: Identifier of the GitOps agent.
IsAuthenticated bool: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
Metadatas []GetGitopsAgentMetadata: Metadata of the agent.
Name string: Name of the GitOps agent.
Operator string: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
PrefixedIdentifier string: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
Tags map[string]string: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
Type string: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
OrgId string: Organization identifier of the GitOps agent.
ProjectId string: Project identifier of the GitOps agent.
WithCredentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

accountId String: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
agentToken String: Agent token to be used for authentication of the agent with Harness.
description String: Description of the GitOps agent.
id String: The provider-assigned unique ID for this managed resource.
identifier String: Identifier of the GitOps agent.
isAuthenticated Boolean: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
metadatas List<GetGitopsAgentMetadata>: Metadata of the agent.
name String: Name of the GitOps agent.
operator String: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
prefixedIdentifier String: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
tags Map<String,String>: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
type String: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
orgId String: Organization identifier of the GitOps agent.
projectId String: Project identifier of the GitOps agent.
withCredentials Boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

accountId string: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
agentToken string: Agent token to be used for authentication of the agent with Harness.
description string: Description of the GitOps agent.
id string: The provider-assigned unique ID for this managed resource.
identifier string: Identifier of the GitOps agent.
isAuthenticated boolean: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
metadatas GetGitopsAgentMetadata[]: Metadata of the agent.
name string: Name of the GitOps agent.
operator string: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
prefixedIdentifier string: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
tags {[key: string]: string}: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
type string: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
orgId string: Organization identifier of the GitOps agent.
projectId string: Project identifier of the GitOps agent.
withCredentials boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

account_id str: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
agent_token str: Agent token to be used for authentication of the agent with Harness.
description str: Description of the GitOps agent.
id str: The provider-assigned unique ID for this managed resource.
identifier str: Identifier of the GitOps agent.
is_authenticated bool: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
metadatas Sequence[GetGitopsAgentMetadata]: Metadata of the agent.
name str: Name of the GitOps agent.
operator str: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
prefixed_identifier str: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
tags Mapping[str, str]: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
type str: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
org_id str: Organization identifier of the GitOps agent.
project_id str: Project identifier of the GitOps agent.
with_credentials bool: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

accountId String: Account identifier of the GitOps agent.
Deprecated: This field is deprecated and will be removed in a future release.
agentToken String: Agent token to be used for authentication of the agent with Harness.
description String: Description of the GitOps agent.
id String: The provider-assigned unique ID for this managed resource.
identifier String: Identifier of the GitOps agent.
isAuthenticated Boolean: This computed field specifies if the referenced agent ever successfully connected and was authenticated to harness. Note that this is different from whether the agent is currently connected. \n\nSet with_credentials to true to allow computing of this field.\n\n For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions
metadatas List<Property Map>: Metadata of the agent.
name String: Name of the GitOps agent.
operator String: The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
prefixedIdentifier String: Prefixed identifier of the GitOps agent. Agent identifier prefixed with scope of the agent
tags Map<String>: Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
type String: Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
orgId String: Organization identifier of the GitOps agent.
projectId String: Project identifier of the GitOps agent.
withCredentials Boolean: Specify whether to retrieve the gitops agent's token. (The field agent_token will be populated only if the agent has never connected to Harness before). For retrieval of this information, the user associated to the token being used must have Gitops Agent Edit permissions

Supporting Types

GetGitopsAgentMetadata

HighAvailability bool: Indicates if the agent is deployed in HA mode.
Namespace string: The kubernetes namespace where the agent should be installed.
IsNamespaced bool: Indicates if the agent is namespaced.

HighAvailability bool: Indicates if the agent is deployed in HA mode.
Namespace string: The kubernetes namespace where the agent should be installed.
IsNamespaced bool: Indicates if the agent is namespaced.

highAvailability Boolean: Indicates if the agent is deployed in HA mode.
namespace String: The kubernetes namespace where the agent should be installed.
isNamespaced Boolean: Indicates if the agent is namespaced.

highAvailability boolean: Indicates if the agent is deployed in HA mode.
namespace string: The kubernetes namespace where the agent should be installed.
isNamespaced boolean: Indicates if the agent is namespaced.

high_availability bool: Indicates if the agent is deployed in HA mode.
namespace str: The kubernetes namespace where the agent should be installed.
is_namespaced bool: Indicates if the agent is namespaced.

highAvailability Boolean: Indicates if the agent is deployed in HA mode.
namespace String: The kubernetes namespace where the agent should be installed.
isNamespaced Boolean: Indicates if the agent is namespaced.

Package Details

Repository: harness pulumi/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Harness v0.7.0 published on Friday, Mar 28, 2025 by Pulumi

pulumi/pulumi-harness

harness.platform.getGitopsAgent

On this page

On this page

Using getGitopsAgent

getGitopsAgent Result

Supporting Types

GetGitopsAgentMetadata

Package Details

On this page

On this page