Ssh
Specifies information about the SSH public key. Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01. Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
Example Usage
Create a new SSH public key resource.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var sshPublicKey = new AzureNative.Compute.SshPublicKey("sshPublicKey", new()
{
Location = "westus",
PublicKey = "{ssh-rsa public key}",
ResourceGroupName = "myResourceGroup",
SshPublicKeyName = "mySshPublicKeyName",
});
});package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSshPublicKey(ctx, "sshPublicKey", &compute.SshPublicKeyArgs{
Location: pulumi.String("westus"),
PublicKey: pulumi.String("{ssh-rsa public key}"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SshPublicKeyName: pulumi.String("mySshPublicKeyName"),
})
if err != nil {
return err
}
return nil
})
}package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.SshPublicKey;
import com.pulumi.azurenative.compute.SshPublicKeyArgs;
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) {
var sshPublicKey = new SshPublicKey("sshPublicKey", SshPublicKeyArgs.builder()
.location("westus")
.publicKey("{ssh-rsa public key}")
.resourceGroupName("myResourceGroup")
.sshPublicKeyName("mySshPublicKeyName")
.build());
}
}Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:SshPublicKey mySshPublicKeyName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}Constructors
Properties
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.
The name of the resource group.
The name of the SSH public key.