Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. databoxedge
  5. getDevice

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

azure.databoxedge.getDevice

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

    Get information about a Databox Edge Device.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.databoxedge.getDevice({
    name: "example-device",
    resourceGroupName: "example-rg",
});

    import pulumi
import pulumi_azure as azure

example = azure.databoxedge.get_device(name="example-device",
    resource_group_name="example-rg")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/databoxedge"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databoxedge.LookupDevice(ctx, &databoxedge.LookupDeviceArgs{
			Name:              "example-device",
			ResourceGroupName: "example-rg",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.DataboxEdge.GetDevice.Invoke(new()
    {
        Name = "example-device",
        ResourceGroupName = "example-rg",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.databoxedge.DataboxedgeFunctions;
import com.pulumi.azure.databoxedge.inputs.GetDeviceArgs;
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 = DataboxedgeFunctions.getDevice(GetDeviceArgs.builder()
            .name("example-device")
            .resourceGroupName("example-rg")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: azure:databoxedge:getDevice
      arguments:
        name: example-device
        resourceGroupName: example-rg

    API Providers

    This data source uses the following Azure API Providers:

    • Microsoft.DataBoxEdge: 2022-03-01

    Using getDevice

    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 getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>
    def get_device(name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
    func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput

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

    public static class GetDevice 
{
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
public static Output<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:databoxedge/getDevice:getDevice
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    ResourceGroupName string
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.
    Name string
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    ResourceGroupName string
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.
    name String
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    resourceGroupName String
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.
    name string
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    resourceGroupName string
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.
    name str
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    resource_group_name str
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.
    name String
    The name which should be used for this Databox Edge Device. Changing this forces a new Databox Edge Device to be created.
    resourceGroupName String
    The name of the Resource Group where the Databox Edge Device should exist. Changing this forces a new Databox Edge Device to be created.

    getDevice Result

    The following output properties are available:

    DeviceProperties List<GetDeviceDeviceProperty>
    A device_properties block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The Azure Region where the Databox Edge Device should exist.
    Name string
    ResourceGroupName string
    SkuName string
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Databox Edge Device.
    DeviceProperties []GetDeviceDeviceProperty
    A device_properties block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The Azure Region where the Databox Edge Device should exist.
    Name string
    ResourceGroupName string
    SkuName string
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    Tags map[string]string
    A mapping of tags which should be assigned to the Databox Edge Device.
    deviceProperties List<GetDeviceDeviceProperty>
    A device_properties block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The Azure Region where the Databox Edge Device should exist.
    name String
    resourceGroupName String
    skuName String
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Databox Edge Device.
    deviceProperties GetDeviceDeviceProperty[]
    A device_properties block as defined below.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The Azure Region where the Databox Edge Device should exist.
    name string
    resourceGroupName string
    skuName string
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Databox Edge Device.
    device_properties Sequence[GetDeviceDeviceProperty]
    A device_properties block as defined below.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The Azure Region where the Databox Edge Device should exist.
    name str
    resource_group_name str
    sku_name str
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Databox Edge Device.
    deviceProperties List<Property Map>
    A device_properties block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The Azure Region where the Databox Edge Device should exist.
    name String
    resourceGroupName String
    skuName String
    The sku_name is comprised of two segments separated by a hyphen (e.g. TEA_1Node_UPS_Heater-Standard). The first segment of the sku_name defines the name of the SKU. The second segment defines the tier of the sku_name. For more information see the product documentation.
    tags Map<String>
    A mapping of tags which should be assigned to the Databox Edge Device.

    Supporting Types

    GetDeviceDeviceProperty

    Capacity int
    The Data Box Edge/Gateway device local capacity in MB.
    ConfiguredRoleTypes List<string>
    Type of compute roles configured.
    Culture string
    The Data Box Edge/Gateway device culture.
    HcsVersion string
    The device software version number of the device (e.g. 1.2.18105.6).
    Model string
    The Data Box Edge/Gateway device model.
    NodeCount int
    The number of nodes in the cluster.
    SerialNumber string
    The Serial Number of Data Box Edge/Gateway device.
    SoftwareVersion string
    The Data Box Edge/Gateway device software version.
    Status string
    The status of the Data Box Edge/Gateway device.
    TimeZone string
    The Data Box Edge/Gateway device timezone.
    Type string
    The type of the Data Box Edge/Gateway device.
    Capacity int
    The Data Box Edge/Gateway device local capacity in MB.
    ConfiguredRoleTypes []string
    Type of compute roles configured.
    Culture string
    The Data Box Edge/Gateway device culture.
    HcsVersion string
    The device software version number of the device (e.g. 1.2.18105.6).
    Model string
    The Data Box Edge/Gateway device model.
    NodeCount int
    The number of nodes in the cluster.
    SerialNumber string
    The Serial Number of Data Box Edge/Gateway device.
    SoftwareVersion string
    The Data Box Edge/Gateway device software version.
    Status string
    The status of the Data Box Edge/Gateway device.
    TimeZone string
    The Data Box Edge/Gateway device timezone.
    Type string
    The type of the Data Box Edge/Gateway device.
    capacity Integer
    The Data Box Edge/Gateway device local capacity in MB.
    configuredRoleTypes List<String>
    Type of compute roles configured.
    culture String
    The Data Box Edge/Gateway device culture.
    hcsVersion String
    The device software version number of the device (e.g. 1.2.18105.6).
    model String
    The Data Box Edge/Gateway device model.
    nodeCount Integer
    The number of nodes in the cluster.
    serialNumber String
    The Serial Number of Data Box Edge/Gateway device.
    softwareVersion String
    The Data Box Edge/Gateway device software version.
    status String
    The status of the Data Box Edge/Gateway device.
    timeZone String
    The Data Box Edge/Gateway device timezone.
    type String
    The type of the Data Box Edge/Gateway device.
    capacity number
    The Data Box Edge/Gateway device local capacity in MB.
    configuredRoleTypes string[]
    Type of compute roles configured.
    culture string
    The Data Box Edge/Gateway device culture.
    hcsVersion string
    The device software version number of the device (e.g. 1.2.18105.6).
    model string
    The Data Box Edge/Gateway device model.
    nodeCount number
    The number of nodes in the cluster.
    serialNumber string
    The Serial Number of Data Box Edge/Gateway device.
    softwareVersion string
    The Data Box Edge/Gateway device software version.
    status string
    The status of the Data Box Edge/Gateway device.
    timeZone string
    The Data Box Edge/Gateway device timezone.
    type string
    The type of the Data Box Edge/Gateway device.
    capacity int
    The Data Box Edge/Gateway device local capacity in MB.
    configured_role_types Sequence[str]
    Type of compute roles configured.
    culture str
    The Data Box Edge/Gateway device culture.
    hcs_version str
    The device software version number of the device (e.g. 1.2.18105.6).
    model str
    The Data Box Edge/Gateway device model.
    node_count int
    The number of nodes in the cluster.
    serial_number str
    The Serial Number of Data Box Edge/Gateway device.
    software_version str
    The Data Box Edge/Gateway device software version.
    status str
    The status of the Data Box Edge/Gateway device.
    time_zone str
    The Data Box Edge/Gateway device timezone.
    type str
    The type of the Data Box Edge/Gateway device.
    capacity Number
    The Data Box Edge/Gateway device local capacity in MB.
    configuredRoleTypes List<String>
    Type of compute roles configured.
    culture String
    The Data Box Edge/Gateway device culture.
    hcsVersion String
    The device software version number of the device (e.g. 1.2.18105.6).
    model String
    The Data Box Edge/Gateway device model.
    nodeCount Number
    The number of nodes in the cluster.
    serialNumber String
    The Serial Number of Data Box Edge/Gateway device.
    softwareVersion String
    The Data Box Edge/Gateway device software version.
    status String
    The status of the Data Box Edge/Gateway device.
    timeZone String
    The Data Box Edge/Gateway device timezone.
    type String
    The type of the Data Box Edge/Gateway device.

    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.23.0 published on Thursday, May 22, 2025 by Pulumi
    pulumi/pulumi-azure