Azure Classic

v4.34.0 published on Tuesday, Jan 18, 2022 by Pulumi

Device

Manages a Databox Edge Device.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleDevice = new Azure.DataboxEdge.Device("exampleDevice", new Azure.DataboxEdge.DeviceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            SkuName = "EdgeP_Base-Standard",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = databoxedge.NewDevice(ctx, "exampleDevice", &databoxedge.DeviceArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("EdgeP_Base-Standard"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_device = azure.databoxedge.Device("exampleDevice",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku_name="EdgeP_Base-Standard")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleDevice = new azure.databoxedge.Device("exampleDevice", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    skuName: "EdgeP_Base-Standard",
});

Create a Device Resource

new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           location: Optional[str] = None,
           name: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           sku_name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None)
@overload
def Device(resource_name: str,
           args: DeviceArgs,
           opts: Optional[ResourceOptions] = None)
func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Device Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Device resource accepts the following input properties:

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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
Location string
The Azure Region 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.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Databox Edge Device.
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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
Location string
The Azure Region 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.
Tags map[string]string
A mapping of tags which should be assigned to the Databox Edge Device.
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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
location string
The Azure Region 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.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Databox Edge Device.
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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
location str
The Azure Region 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.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Databox Edge Device.

Outputs

All input properties are implicitly available as output properties. Additionally, the Device resource produces the following output properties:

DeviceProperties List<Pulumi.Azure.DataboxEdge.Outputs.DeviceDeviceProperty>
A device_properties block as defined below.
Id string
The provider-assigned unique ID for this managed resource.
DeviceProperties []DeviceDeviceProperty
A device_properties block as defined below.
Id string
The provider-assigned unique ID for this managed resource.
deviceProperties DeviceDeviceProperty[]
A device_properties block as defined below.
id string
The provider-assigned unique ID for this managed resource.
device_properties Sequence[DeviceDeviceProperty]
A device_properties block as defined below.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Device Resource

Get an existing Device resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeviceState, opts?: CustomResourceOptions): Device
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_properties: Optional[Sequence[DeviceDevicePropertyArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Device
func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

DeviceProperties List<Pulumi.Azure.DataboxEdge.Inputs.DeviceDevicePropertyArgs>
A device_properties block as defined below.
Location string
The Azure Region 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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Databox Edge Device.
DeviceProperties []DeviceDevicePropertyArgs
A device_properties block as defined below.
Location string
The Azure Region 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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Databox Edge Device.
deviceProperties DeviceDevicePropertyArgs[]
A device_properties block as defined below.
location string
The Azure Region 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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Databox Edge Device.
device_properties Sequence[DeviceDevicePropertyArgs]
A device_properties block as defined below.
location str
The Azure Region 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.
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, possible values are Gateway, EdgeMR_Mini, EdgeP_Base, EdgeP_High, EdgePR_Base, EdgePR_Base_UPS, GPU, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_UPS, TEA_1Node_Heater, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater or TMA. The second segment defines the tier of the sku_name, possible values are Standard. For more information see the product documentation. Changing this forces a new Databox Edge Device to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Databox Edge Device.

Supporting Types

DeviceDeviceProperty

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 (eg: 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 (eg: 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 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 (eg: 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 (eg: 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.

Import

Databox Edge Devices can be imported using the resource id, e.g.

 $ pulumi import azure:databoxedge/device:Device example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/device1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.