1. Packages
  2. Azure Classic
  3. API Docs
  4. devcenter
  5. getDevBoxDefinition

We recommend using Azure Native.

Azure v6.24.0 published on Wednesday, Jun 18, 2025 by Pulumi

azure.devcenter.getDevBoxDefinition

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.24.0 published on Wednesday, Jun 18, 2025 by Pulumi

    Use this data source to access information about an existing Dev Center Dev Box Definition.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.devcenter.getDevBoxDefinition({
        name: exampleAzurermDevCenterDevBoxDefinition.name,
        devCenterId: exampleAzurermDevCenterDevBoxDefinition.devCenterId,
    });
    export const id = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.devcenter.get_dev_box_definition(name=example_azurerm_dev_center_dev_box_definition["name"],
        dev_center_id=example_azurerm_dev_center_dev_box_definition["devCenterId"])
    pulumi.export("id", example.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/devcenter"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := devcenter.LookupDevBoxDefinition(ctx, &devcenter.LookupDevBoxDefinitionArgs{
    			Name:        exampleAzurermDevCenterDevBoxDefinition.Name,
    			DevCenterId: exampleAzurermDevCenterDevBoxDefinition.DevCenterId,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("id", example.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.DevCenter.GetDevBoxDefinition.Invoke(new()
        {
            Name = exampleAzurermDevCenterDevBoxDefinition.Name,
            DevCenterId = exampleAzurermDevCenterDevBoxDefinition.DevCenterId,
        });
    
        return new Dictionary<string, object?>
        {
            ["id"] = example.Apply(getDevBoxDefinitionResult => getDevBoxDefinitionResult.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.devcenter.DevcenterFunctions;
    import com.pulumi.azure.devcenter.inputs.GetDevBoxDefinitionArgs;
    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) {
            final var example = DevcenterFunctions.getDevBoxDefinition(GetDevBoxDefinitionArgs.builder()
                .name(exampleAzurermDevCenterDevBoxDefinition.name())
                .devCenterId(exampleAzurermDevCenterDevBoxDefinition.devCenterId())
                .build());
    
            ctx.export("id", example.id());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: azure:devcenter:getDevBoxDefinition
          arguments:
            name: ${exampleAzurermDevCenterDevBoxDefinition.name}
            devCenterId: ${exampleAzurermDevCenterDevBoxDefinition.devCenterId}
    outputs:
      id: ${example.id}
    

    API Providers

    This data source uses the following Azure API Providers:

    • Microsoft.DevCenter: 2025-02-01

    Using getDevBoxDefinition

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDevBoxDefinition(args: GetDevBoxDefinitionArgs, opts?: InvokeOptions): Promise<GetDevBoxDefinitionResult>
    function getDevBoxDefinitionOutput(args: GetDevBoxDefinitionOutputArgs, opts?: InvokeOptions): Output<GetDevBoxDefinitionResult>
    def get_dev_box_definition(dev_center_id: Optional[str] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDevBoxDefinitionResult
    def get_dev_box_definition_output(dev_center_id: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDevBoxDefinitionResult]
    func LookupDevBoxDefinition(ctx *Context, args *LookupDevBoxDefinitionArgs, opts ...InvokeOption) (*LookupDevBoxDefinitionResult, error)
    func LookupDevBoxDefinitionOutput(ctx *Context, args *LookupDevBoxDefinitionOutputArgs, opts ...InvokeOption) LookupDevBoxDefinitionResultOutput

    > Note: This function is named LookupDevBoxDefinition in the Go SDK.

    public static class GetDevBoxDefinition 
    {
        public static Task<GetDevBoxDefinitionResult> InvokeAsync(GetDevBoxDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetDevBoxDefinitionResult> Invoke(GetDevBoxDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDevBoxDefinitionResult> getDevBoxDefinition(GetDevBoxDefinitionArgs args, InvokeOptions options)
    public static Output<GetDevBoxDefinitionResult> getDevBoxDefinition(GetDevBoxDefinitionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure:devcenter/getDevBoxDefinition:getDevBoxDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DevCenterId string
    The ID of the associated Dev Center.
    Name string
    The name of this Dev Center Dev Box Definition.
    DevCenterId string
    The ID of the associated Dev Center.
    Name string
    The name of this Dev Center Dev Box Definition.
    devCenterId String
    The ID of the associated Dev Center.
    name String
    The name of this Dev Center Dev Box Definition.
    devCenterId string
    The ID of the associated Dev Center.
    name string
    The name of this Dev Center Dev Box Definition.
    dev_center_id str
    The ID of the associated Dev Center.
    name str
    The name of this Dev Center Dev Box Definition.
    devCenterId String
    The ID of the associated Dev Center.
    name String
    The name of this Dev Center Dev Box Definition.

    getDevBoxDefinition Result

    The following output properties are available:

    DevCenterId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageReferenceId string
    The ID of the image for the Dev Center Dev Box Definition.
    Location string
    The Azure Region where the Dev Center Dev Box Definition exists.
    Name string
    SkuName string
    The name of the SKU for the Dev Center Dev Box Definition.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Dev Center Dev Box Definition.
    DevCenterId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageReferenceId string
    The ID of the image for the Dev Center Dev Box Definition.
    Location string
    The Azure Region where the Dev Center Dev Box Definition exists.
    Name string
    SkuName string
    The name of the SKU for the Dev Center Dev Box Definition.
    Tags map[string]string
    A mapping of tags assigned to the Dev Center Dev Box Definition.
    devCenterId String
    id String
    The provider-assigned unique ID for this managed resource.
    imageReferenceId String
    The ID of the image for the Dev Center Dev Box Definition.
    location String
    The Azure Region where the Dev Center Dev Box Definition exists.
    name String
    skuName String
    The name of the SKU for the Dev Center Dev Box Definition.
    tags Map<String,String>
    A mapping of tags assigned to the Dev Center Dev Box Definition.
    devCenterId string
    id string
    The provider-assigned unique ID for this managed resource.
    imageReferenceId string
    The ID of the image for the Dev Center Dev Box Definition.
    location string
    The Azure Region where the Dev Center Dev Box Definition exists.
    name string
    skuName string
    The name of the SKU for the Dev Center Dev Box Definition.
    tags {[key: string]: string}
    A mapping of tags assigned to the Dev Center Dev Box Definition.
    dev_center_id str
    id str
    The provider-assigned unique ID for this managed resource.
    image_reference_id str
    The ID of the image for the Dev Center Dev Box Definition.
    location str
    The Azure Region where the Dev Center Dev Box Definition exists.
    name str
    sku_name str
    The name of the SKU for the Dev Center Dev Box Definition.
    tags Mapping[str, str]
    A mapping of tags assigned to the Dev Center Dev Box Definition.
    devCenterId String
    id String
    The provider-assigned unique ID for this managed resource.
    imageReferenceId String
    The ID of the image for the Dev Center Dev Box Definition.
    location String
    The Azure Region where the Dev Center Dev Box Definition exists.
    name String
    skuName String
    The name of the SKU for the Dev Center Dev Box Definition.
    tags Map<String>
    A mapping of tags assigned to the Dev Center Dev Box Definition.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.24.0 published on Wednesday, Jun 18, 2025 by Pulumi