DevBoxDefinition

class DevBoxDefinition : KotlinCustomResource

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. 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/v2"
"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}

Properties

Link copied to clipboard

Image reference information for the currently active image (only populated during updates).

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val hibernateSupport: Output<String>?

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 id: Output<String>
Link copied to clipboard

Image reference information.

Link copied to clipboard

Details for image validator error. Populated when the image validation is not successful.

Link copied to clipboard

Validation status of the configured image.

Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val name: Output<String>

The name of the resource

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

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

Link copied to clipboard

The provisioning state of the resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val sku: Output<SkuResponse>

The SKU for Dev Boxes created using this definition.

Link copied to clipboard

Azure Resource Manager metadata containing createdBy and modifiedBy information.

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

Resource tags.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

Validation status for the Dev Box Definition.