com.pulumi.azurenative.compute.SshPublicKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azurenative.compute;

import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.compute.SshPublicKeyArgs;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Specifies information about the SSH public key.
 * Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
 * 
 * Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.
 * 
 * ## Example Usage
 * ### Create a new SSH public key resource.
 * 
 *  * {@code
 * 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.
 * 
 * ```sh
 * $ pulumi import azure-native:compute:SshPublicKey mySshPublicKeyName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName} 
 * ```
 * 
 */
@ResourceType(type="azure-native:compute:SshPublicKey")
public class SshPublicKey extends com.pulumi.resources.CustomResource {
    /**
     * Resource location
     * 
     */
    @Export(name="location", refs={String.class}, tree="[0]")
    private Output location;

    /**
     * @return Resource location
     * 
     */
    public Output location() {
        return this.location;
    }
    /**
     * Resource name
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return Resource name
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * 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.
     * 
     */
    @Export(name="publicKey", refs={String.class}, tree="[0]")
    private Output publicKey;

    /**
     * @return 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.
     * 
     */
    public Output> publicKey() {
        return Codegen.optional(this.publicKey);
    }
    /**
     * Resource tags
     * 
     */
    @Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> tags;

    /**
     * @return Resource tags
     * 
     */
    public Output>> tags() {
        return Codegen.optional(this.tags);
    }
    /**
     * Resource type
     * 
     */
    @Export(name="type", refs={String.class}, tree="[0]")
    private Output type;

    /**
     * @return Resource type
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public SshPublicKey(java.lang.String name) {
        this(name, SshPublicKeyArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public SshPublicKey(java.lang.String name, SshPublicKeyArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public SshPublicKey(java.lang.String name, SshPublicKeyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:compute:SshPublicKey", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private SshPublicKey(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:compute:SshPublicKey", name, null, makeResourceOptions(options, id), false);
    }

    private static SshPublicKeyArgs makeArgs(SshPublicKeyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? SshPublicKeyArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .aliases(List.of(
                Output.of(Alias.builder().type("azure-native:compute/v20191201:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20200601:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20201201:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20210301:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20210401:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20210701:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20211101:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20220301:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20220801:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20221101:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20230301:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20230701:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20230901:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20240301:SshPublicKey").build()),
                Output.of(Alias.builder().type("azure-native:compute/v20240701:SshPublicKey").build())
            ))
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static SshPublicKey get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new SshPublicKey(name, id, options);
    }
}