com.pulumi.azurenative.devcenter.DevBoxDefinition 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
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** 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.devcenter;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.devcenter.DevBoxDefinitionArgs;
import com.pulumi.azurenative.devcenter.outputs.ImageReferenceResponse;
import com.pulumi.azurenative.devcenter.outputs.ImageValidationErrorDetailsResponse;
import com.pulumi.azurenative.devcenter.outputs.SkuResponse;
import com.pulumi.azurenative.devcenter.outputs.SystemDataResponse;
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;
/**
* Represents a definition for a Developer Machine.
* Azure REST API version: 2023-04-01. Prior API version in Azure Native 1.x: 2022-09-01-preview.
*
* Other available API versions: 2022-11-11-preview, 2023-08-01-preview, 2023-10-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview.
*
* ## Example Usage
* ### DevBoxDefinitions_Create
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.devcenter.DevBoxDefinition;
* import com.pulumi.azurenative.devcenter.DevBoxDefinitionArgs;
* import com.pulumi.azurenative.devcenter.inputs.ImageReferenceArgs;
* import com.pulumi.azurenative.devcenter.inputs.SkuArgs;
* 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 devBoxDefinition = new DevBoxDefinition("devBoxDefinition", DevBoxDefinitionArgs.builder()
* .devBoxDefinitionName("WebDevBox")
* .devCenterName("Contoso")
* .hibernateSupport("Enabled")
* .imageReference(ImageReferenceArgs.builder()
* .id("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0")
* .build())
* .location("centralus")
* .resourceGroupName("rg1")
* .sku(SkuArgs.builder()
* .name("Preview")
* .build())
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:devcenter:DevBoxDefinition WebDevBox /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}
* ```
*
*/
@ResourceType(type="azure-native:devcenter:DevBoxDefinition")
public class DevBoxDefinition extends com.pulumi.resources.CustomResource {
/**
* Image reference information for the currently active image (only populated during updates).
*
*/
@Export(name="activeImageReference", refs={ImageReferenceResponse.class}, tree="[0]")
private Output activeImageReference;
/**
* @return Image reference information for the currently active image (only populated during updates).
*
*/
public Output activeImageReference() {
return this.activeImageReference;
}
/**
* Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate
*
*/
@Export(name="hibernateSupport", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> hibernateSupport;
/**
* @return Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate
*
*/
public Output> hibernateSupport() {
return Codegen.optional(this.hibernateSupport);
}
/**
* Image reference information.
*
*/
@Export(name="imageReference", refs={ImageReferenceResponse.class}, tree="[0]")
private Output imageReference;
/**
* @return Image reference information.
*
*/
public Output imageReference() {
return this.imageReference;
}
/**
* Details for image validator error. Populated when the image validation is not successful.
*
*/
@Export(name="imageValidationErrorDetails", refs={ImageValidationErrorDetailsResponse.class}, tree="[0]")
private Output imageValidationErrorDetails;
/**
* @return Details for image validator error. Populated when the image validation is not successful.
*
*/
public Output imageValidationErrorDetails() {
return this.imageValidationErrorDetails;
}
/**
* Validation status of the configured image.
*
*/
@Export(name="imageValidationStatus", refs={String.class}, tree="[0]")
private Output imageValidationStatus;
/**
* @return Validation status of the configured image.
*
*/
public Output imageValidationStatus() {
return this.imageValidationStatus;
}
/**
* The geo-location where the resource lives
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return The geo-location where the resource lives
*
*/
public Output location() {
return this.location;
}
/**
* The name of the resource
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource
*
*/
public Output name() {
return this.name;
}
/**
* The storage type used for the Operating System disk of Dev Boxes created using this definition.
*
*/
@Export(name="osStorageType", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> osStorageType;
/**
* @return The storage type used for the Operating System disk of Dev Boxes created using this definition.
*
*/
public Output> osStorageType() {
return Codegen.optional(this.osStorageType);
}
/**
* The provisioning state of the resource.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the resource.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The SKU for Dev Boxes created using this definition.
*
*/
@Export(name="sku", refs={SkuResponse.class}, tree="[0]")
private Output sku;
/**
* @return The SKU for Dev Boxes created using this definition.
*
*/
public Output sku() {
return this.sku;
}
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
public Output systemData() {
return this.systemData;
}
/**
* Resource tags.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output* @Nullable */ Map> tags;
/**
* @return Resource tags.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DevBoxDefinition(java.lang.String name) {
this(name, DevBoxDefinitionArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DevBoxDefinition(java.lang.String name, DevBoxDefinitionArgs 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 DevBoxDefinition(java.lang.String name, DevBoxDefinitionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:devcenter:DevBoxDefinition", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private DevBoxDefinition(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:devcenter:DevBoxDefinition", name, null, makeResourceOptions(options, id), false);
}
private static DevBoxDefinitionArgs makeArgs(DevBoxDefinitionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? DevBoxDefinitionArgs.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:devcenter/v20220801preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20220901preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20221012preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20221111preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20230101preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20230401:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20230801preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20231001preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20240201:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20240501preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20240601preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20240701preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20240801preview:DevBoxDefinition").build()),
Output.of(Alias.builder().type("azure-native:devcenter/v20241001preview:DevBoxDefinition").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 DevBoxDefinition get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DevBoxDefinition(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy