1. Packages
  2. Harness
  3. API Docs
  4. getSshCredential
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

harness.getSshCredential

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

    Data source for retrieving an SSH credential.

    Using getSshCredential

    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 getSshCredential(args: GetSshCredentialArgs, opts?: InvokeOptions): Promise<GetSshCredentialResult>
    function getSshCredentialOutput(args: GetSshCredentialOutputArgs, opts?: InvokeOptions): Output<GetSshCredentialResult>
    def get_ssh_credential(id: Optional[str] = None,
                           name: Optional[str] = None,
                           usage_scopes: Optional[Sequence[GetSshCredentialUsageScope]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSshCredentialResult
    def get_ssh_credential_output(id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           usage_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[GetSshCredentialUsageScopeArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSshCredentialResult]
    func LookupSshCredential(ctx *Context, args *LookupSshCredentialArgs, opts ...InvokeOption) (*LookupSshCredentialResult, error)
    func LookupSshCredentialOutput(ctx *Context, args *LookupSshCredentialOutputArgs, opts ...InvokeOption) LookupSshCredentialResultOutput

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

    public static class GetSshCredential 
    {
        public static Task<GetSshCredentialResult> InvokeAsync(GetSshCredentialArgs args, InvokeOptions? opts = null)
        public static Output<GetSshCredentialResult> Invoke(GetSshCredentialInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSshCredentialResult> getSshCredential(GetSshCredentialArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:index/getSshCredential:getSshCredential
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier of the secret manager
    Name string
    The name of the secret manager
    UsageScopes List<GetSshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    Id string
    Unique identifier of the secret manager
    Name string
    The name of the secret manager
    UsageScopes []GetSshCredentialUsageScope
    This block is used for scoping the resource to a specific set of applications or environments.
    id String
    Unique identifier of the secret manager
    name String
    The name of the secret manager
    usageScopes List<GetSshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    id string
    Unique identifier of the secret manager
    name string
    The name of the secret manager
    usageScopes GetSshCredentialUsageScope[]
    This block is used for scoping the resource to a specific set of applications or environments.
    id str
    Unique identifier of the secret manager
    name str
    The name of the secret manager
    usage_scopes Sequence[GetSshCredentialUsageScope]
    This block is used for scoping the resource to a specific set of applications or environments.
    id String
    Unique identifier of the secret manager
    name String
    The name of the secret manager
    usageScopes List<Property Map>
    This block is used for scoping the resource to a specific set of applications or environments.

    getSshCredential Result

    The following output properties are available:

    Id string
    Unique identifier of the secret manager
    Name string
    The name of the secret manager
    UsageScopes List<GetSshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    Id string
    Unique identifier of the secret manager
    Name string
    The name of the secret manager
    UsageScopes []GetSshCredentialUsageScope
    This block is used for scoping the resource to a specific set of applications or environments.
    id String
    Unique identifier of the secret manager
    name String
    The name of the secret manager
    usageScopes List<GetSshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    id string
    Unique identifier of the secret manager
    name string
    The name of the secret manager
    usageScopes GetSshCredentialUsageScope[]
    This block is used for scoping the resource to a specific set of applications or environments.
    id str
    Unique identifier of the secret manager
    name str
    The name of the secret manager
    usage_scopes Sequence[GetSshCredentialUsageScope]
    This block is used for scoping the resource to a specific set of applications or environments.
    id String
    Unique identifier of the secret manager
    name String
    The name of the secret manager
    usageScopes List<Property Map>
    This block is used for scoping the resource to a specific set of applications or environments.

    Supporting Types

    GetSshCredentialUsageScope

    ApplicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    EnvironmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    EnvironmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    ApplicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    EnvironmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    EnvironmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId String
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType String
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId String
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    application_id str
    Id of the application to scope to. If empty then this scope applies to all applications.
    environment_filter_type str
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environment_id str
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId String
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType String
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId String
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.

    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.3.2 published on Monday, Sep 16, 2024 by Pulumi