1. Packages
  2. Civo Provider
  3. API Docs
  4. getSshKey
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo

civo.getSshKey

Explore with Pulumi AI

civo 1.1.5 published on Thursday, Feb 6, 2025 by civo

Get information on a SSH key. This data source provides the name, and fingerprint as configured on your Civo account.

An error will be raised if the provided SSH key name does not exist in your Civo account.

Using getSshKey

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 getSshKey(args: GetSshKeyArgs, opts?: InvokeOptions): Promise<GetSshKeyResult>
function getSshKeyOutput(args: GetSshKeyOutputArgs, opts?: InvokeOptions): Output<GetSshKeyResult>
Copy
def get_ssh_key(id: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetSshKeyResult
def get_ssh_key_output(id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSshKeyResult]
Copy
func LookupSshKey(ctx *Context, args *LookupSshKeyArgs, opts ...InvokeOption) (*LookupSshKeyResult, error)
func LookupSshKeyOutput(ctx *Context, args *LookupSshKeyOutputArgs, opts ...InvokeOption) LookupSshKeyResultOutput
Copy

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

public static class GetSshKey 
{
    public static Task<GetSshKeyResult> InvokeAsync(GetSshKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetSshKeyResult> Invoke(GetSshKeyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSshKeyResult> getSshKey(GetSshKeyArgs args, InvokeOptions options)
public static Output<GetSshKeyResult> getSshKey(GetSshKeyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: civo:index/getSshKey:getSshKey
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of this resource.
Name string
The name of the SSH key
Id string
The ID of this resource.
Name string
The name of the SSH key
id String
The ID of this resource.
name String
The name of the SSH key
id string
The ID of this resource.
name string
The name of the SSH key
id str
The ID of this resource.
name str
The name of the SSH key
id String
The ID of this resource.
name String
The name of the SSH key

getSshKey Result

The following output properties are available:

Fingerprint string
The fingerprint of the public key of the SSH key
Id string
The ID of this resource.
Name string
The name of the SSH key
Fingerprint string
The fingerprint of the public key of the SSH key
Id string
The ID of this resource.
Name string
The name of the SSH key
fingerprint String
The fingerprint of the public key of the SSH key
id String
The ID of this resource.
name String
The name of the SSH key
fingerprint string
The fingerprint of the public key of the SSH key
id string
The ID of this resource.
name string
The name of the SSH key
fingerprint str
The fingerprint of the public key of the SSH key
id str
The ID of this resource.
name str
The name of the SSH key
fingerprint String
The fingerprint of the public key of the SSH key
id String
The ID of this resource.
name String
The name of the SSH key

Package Details

Repository
Civo civo/terraform-provider-civo
License
Notes
This Pulumi package is based on the civo Terraform Provider.
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo