Azure Native v1.102.0, May 2 23

azure-native.compute.getSshPublicKey

Explore with Pulumi AI

Retrieves information about an SSH public key. API Version: 2020-12-01.

Using getSshPublicKey

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 getSshPublicKey(args: GetSshPublicKeyArgs, opts?: InvokeOptions): Promise<GetSshPublicKeyResult>
function getSshPublicKeyOutput(args: GetSshPublicKeyOutputArgs, opts?: InvokeOptions): Output<GetSshPublicKeyResult>

def get_ssh_public_key(resource_group_name: Optional[str] = None,
                       ssh_public_key_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSshPublicKeyResult
def get_ssh_public_key_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                       ssh_public_key_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSshPublicKeyResult]

func LookupSshPublicKey(ctx *Context, args *LookupSshPublicKeyArgs, opts ...InvokeOption) (*LookupSshPublicKeyResult, error)
func LookupSshPublicKeyOutput(ctx *Context, args *LookupSshPublicKeyOutputArgs, opts ...InvokeOption) LookupSshPublicKeyResultOutput

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

public static class GetSshPublicKey 
{
    public static Task<GetSshPublicKeyResult> InvokeAsync(GetSshPublicKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetSshPublicKeyResult> Invoke(GetSshPublicKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSshPublicKeyResult> getSshPublicKey(GetSshPublicKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:compute:getSshPublicKey
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group.
SshPublicKeyName string: The name of the SSH public key.

ResourceGroupName string: The name of the resource group.
SshPublicKeyName string: The name of the SSH public key.

resourceGroupName String: The name of the resource group.
sshPublicKeyName String: The name of the SSH public key.

resourceGroupName string: The name of the resource group.
sshPublicKeyName string: The name of the SSH public key.

resource_group_name str: The name of the resource group.
ssh_public_key_name str: The name of the SSH public key.

resourceGroupName String: The name of the resource group.
sshPublicKeyName String: The name of the SSH public key.

getSshPublicKey Result

The following output properties are available:

Id string: Resource Id
Location string: Resource location
Name string: Resource name
Type string: Resource type
PublicKey string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
Tags Dictionary<string, string>: Resource tags

Id string: Resource Id
Location string: Resource location
Name string: Resource name
Type string: Resource type
PublicKey string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
Tags map[string]string: Resource tags

id String: Resource Id
location String: Resource location
name String: Resource name
type String: Resource type
publicKey String: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
tags Map<String,String>: Resource tags

id string: Resource Id
location string: Resource location
name string: Resource name
type string: Resource type
publicKey string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
tags {[key: string]: string}: Resource tags

id str: Resource Id
location str: Resource location
name str: Resource name
type str: Resource type
public_key str: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
tags Mapping[str, str]: Resource tags

id String: Resource Id
location String: Resource location
name String: Resource name
type String: Resource type
publicKey String: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
tags Map<String>: Resource tags

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

azure-native.compute.getSshPublicKey

Using getSshPublicKey

getSshPublicKey Result

Package Details

On this page

On this page