DevBoxDefinitionArgs

data class DevBoxDefinitionArgs(val devBoxDefinitionName: Output<String>? = null, val devCenterName: Output<String>? = null, val hibernateSupport: Output<Either<String, HibernateSupport>>? = null, val imageReference: Output<ImageReferenceArgs>? = null, val location: Output<String>? = null, val osStorageType: Output<String>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<SkuArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DevBoxDefinitionArgs>

Represents a definition for a Developer Machine. Uses Azure REST API version 2024-02-01. In version 2.x of the Azure Native provider, it used API version 2023-04-01. Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native devcenter [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

DevBoxDefinitions_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var devBoxDefinition = new AzureNative.DevCenter.DevBoxDefinition("devBoxDefinition", new()
{
DevBoxDefinitionName = "WebDevBox",
DevCenterName = "Contoso",
HibernateSupport = AzureNative.DevCenter.HibernateSupport.Enabled,
ImageReference = new AzureNative.DevCenter.Inputs.ImageReferenceArgs
{
Id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0",
},
Location = "centralus",
ResourceGroupName = "rg1",
Sku = new AzureNative.DevCenter.Inputs.SkuArgs
{
Name = "Preview",
},
});
});
package main
import (
devcenter "github.com/pulumi/pulumi-azure-native-sdk/devcenter/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := devcenter.NewDevBoxDefinition(ctx, "devBoxDefinition", &devcenter.DevBoxDefinitionArgs{
DevBoxDefinitionName: pulumi.String("WebDevBox"),
DevCenterName: pulumi.String("Contoso"),
HibernateSupport: pulumi.String(devcenter.HibernateSupportEnabled),
ImageReference: &devcenter.ImageReferenceArgs{
Id: pulumi.String("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"),
},
Location: pulumi.String("centralus"),
ResourceGroupName: pulumi.String("rg1"),
Sku: &devcenter.SkuArgs{
Name: pulumi.String("Preview"),
},
})
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.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.

$ pulumi import azure-native:devcenter:DevBoxDefinition WebDevBox /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}

Constructors

Link copied to clipboard
constructor(devBoxDefinitionName: Output<String>? = null, devCenterName: Output<String>? = null, hibernateSupport: Output<Either<String, HibernateSupport>>? = null, imageReference: Output<ImageReferenceArgs>? = null, location: Output<String>? = null, osStorageType: Output<String>? = null, resourceGroupName: Output<String>? = null, sku: Output<SkuArgs>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val devBoxDefinitionName: Output<String>? = null

The name of the Dev Box definition.

Link copied to clipboard
val devCenterName: Output<String>? = null

The name of the devcenter.

Link copied to clipboard
val hibernateSupport: Output<Either<String, HibernateSupport>>? = null

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

Link copied to clipboard
val imageReference: Output<ImageReferenceArgs>? = null

Image reference information.

Link copied to clipboard
val location: Output<String>? = null

The geo-location where the resource lives

Link copied to clipboard
val osStorageType: Output<String>? = null

The storage type used for the Operating System disk of Dev Boxes created using this definition.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val sku: Output<SkuArgs>? = null

The SKU for Dev Boxes created using this definition.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Functions

Link copied to clipboard
open override fun toJava(): DevBoxDefinitionArgs