1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsSshKeys
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsSshKeys

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source for KeyCollection. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsSshKeys({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_ssh_keys()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetIsSshKeys(ctx, &ibm.GetIsSshKeysArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ibm.GetIsSshKeys.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetIsSshKeysArgs;
    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 = IbmFunctions.getIsSshKeys();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsSshKeys
          arguments: {}
    

    Using getIsSshKeys

    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 getIsSshKeys(args: GetIsSshKeysArgs, opts?: InvokeOptions): Promise<GetIsSshKeysResult>
    function getIsSshKeysOutput(args: GetIsSshKeysOutputArgs, opts?: InvokeOptions): Output<GetIsSshKeysResult>
    def get_is_ssh_keys(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIsSshKeysResult
    def get_is_ssh_keys_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIsSshKeysResult]
    func GetIsSshKeys(ctx *Context, args *GetIsSshKeysArgs, opts ...InvokeOption) (*GetIsSshKeysResult, error)
    func GetIsSshKeysOutput(ctx *Context, args *GetIsSshKeysOutputArgs, opts ...InvokeOption) GetIsSshKeysResultOutput

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

    public static class GetIsSshKeys 
    {
        public static Task<GetIsSshKeysResult> InvokeAsync(GetIsSshKeysArgs args, InvokeOptions? opts = null)
        public static Output<GetIsSshKeysResult> Invoke(GetIsSshKeysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsSshKeysResult> getIsSshKeys(GetIsSshKeysArgs args, InvokeOptions options)
    public static Output<GetIsSshKeysResult> getIsSshKeys(GetIsSshKeysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsSshKeys:getIsSshKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    id str
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.

    getIsSshKeys Result

    The following output properties are available:

    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Keys List<GetIsSshKeysKey>
    (List) Collection of keys. Nested scheme for keys:
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Keys []GetIsSshKeysKey
    (List) Collection of keys. Nested scheme for keys:
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    keys List<GetIsSshKeysKey>
    (List) Collection of keys. Nested scheme for keys:
    id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    keys GetIsSshKeysKey[]
    (List) Collection of keys. Nested scheme for keys:
    id str
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    keys Sequence[GetIsSshKeysKey]
    (List) Collection of keys. Nested scheme for keys:
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    keys List<Property Map>
    (List) Collection of keys. Nested scheme for keys:

    Supporting Types

    GetIsSshKeysKey

    AccessTags List<string>
    (List) Access management tags associated for the ssh key.
    CreatedAt string
    (String) The date and time that the key was created.
    Crn string
    (String) The CRN for this key.
    Fingerprint string
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    Href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Length double
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    Name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    PublicKey string
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    ResourceGroups List<GetIsSshKeysKeyResourceGroup>
    (List) The resource group object, for this key. Nested scheme for resource_group:
    Tags List<string>
    (List) User tags associated for the ssh key.
    Type string
    (String) The crypto-system used by this key.
    AccessTags []string
    (List) Access management tags associated for the ssh key.
    CreatedAt string
    (String) The date and time that the key was created.
    Crn string
    (String) The CRN for this key.
    Fingerprint string
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    Href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Length float64
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    Name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    PublicKey string
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    ResourceGroups []GetIsSshKeysKeyResourceGroup
    (List) The resource group object, for this key. Nested scheme for resource_group:
    Tags []string
    (List) User tags associated for the ssh key.
    Type string
    (String) The crypto-system used by this key.
    accessTags List<String>
    (List) Access management tags associated for the ssh key.
    createdAt String
    (String) The date and time that the key was created.
    crn String
    (String) The CRN for this key.
    fingerprint String
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    href String
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    length Double
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    name String
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    publicKey String
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    resourceGroups List<GetIsSshKeysKeyResourceGroup>
    (List) The resource group object, for this key. Nested scheme for resource_group:
    tags List<String>
    (List) User tags associated for the ssh key.
    type String
    (String) The crypto-system used by this key.
    accessTags string[]
    (List) Access management tags associated for the ssh key.
    createdAt string
    (String) The date and time that the key was created.
    crn string
    (String) The CRN for this key.
    fingerprint string
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    length number
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    publicKey string
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    resourceGroups GetIsSshKeysKeyResourceGroup[]
    (List) The resource group object, for this key. Nested scheme for resource_group:
    tags string[]
    (List) User tags associated for the ssh key.
    type string
    (String) The crypto-system used by this key.
    access_tags Sequence[str]
    (List) Access management tags associated for the ssh key.
    created_at str
    (String) The date and time that the key was created.
    crn str
    (String) The CRN for this key.
    fingerprint str
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    href str
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id str
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    length float
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    name str
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    public_key str
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    resource_groups Sequence[GetIsSshKeysKeyResourceGroup]
    (List) The resource group object, for this key. Nested scheme for resource_group:
    tags Sequence[str]
    (List) User tags associated for the ssh key.
    type str
    (String) The crypto-system used by this key.
    accessTags List<String>
    (List) Access management tags associated for the ssh key.
    createdAt String
    (String) The date and time that the key was created.
    crn String
    (String) The CRN for this key.
    fingerprint String
    (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm.
    href String
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    length Number
    (Integer) The length of this key (in bits).

    • Constraints: Allowable values are: 2048, 4096.
    name String
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    publicKey String
    (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
    resourceGroups List<Property Map>
    (List) The resource group object, for this key. Nested scheme for resource_group:
    tags List<String>
    (List) User tags associated for the ssh key.
    type String
    (String) The crypto-system used by this key.

    GetIsSshKeysKeyResourceGroup

    Href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    Href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    Name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    href String
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    name String
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    href string
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id string
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    name string
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    href str
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id str
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    name str
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.
    href String
    (String) The URL for this resource group.

    • Constraints: The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    (String) The unique identifier for this resource group.

    • Constraints: The value must match regular expression /^[0-9a-f]{32}$/.
    name String
    (String) The user-defined name for this resource group.

    • Constraints: The maximum length is 40 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-_ ]+$/.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud