Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. databoxedge
  5. IoTRole
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.databoxedge.IoTRole

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Compute role. API Version: 2020-12-01.

    Example Usage

    RolePut

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

return await Deployment.RunAsync(() => 
{
    var ioTRole = new AzureNative.DataBoxEdge.IoTRole("ioTRole", new()
    {
        DeviceName = "testedgedevice",
        HostPlatform = "Linux",
        IoTDeviceDetails = new AzureNative.DataBoxEdge.Inputs.IoTDeviceInfoArgs
        {
            Authentication = new AzureNative.DataBoxEdge.Inputs.AuthenticationArgs
            {
                SymmetricKey = new AzureNative.DataBoxEdge.Inputs.SymmetricKeyArgs
                {
                    ConnectionString = new AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretArgs
                    {
                        EncryptionAlgorithm = "AES256",
                        EncryptionCertThumbprint = "348586569999244",
                        Value = "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                    },
                },
            },
            DeviceId = "iotdevice",
            IoTHostHub = "iothub.azure-devices.net",
        },
        IoTEdgeDeviceDetails = new AzureNative.DataBoxEdge.Inputs.IoTDeviceInfoArgs
        {
            Authentication = new AzureNative.DataBoxEdge.Inputs.AuthenticationArgs
            {
                SymmetricKey = new AzureNative.DataBoxEdge.Inputs.SymmetricKeyArgs
                {
                    ConnectionString = new AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretArgs
                    {
                        EncryptionAlgorithm = "AES256",
                        EncryptionCertThumbprint = "1245475856069999244",
                        Value = "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                    },
                },
            },
            DeviceId = "iotEdge",
            IoTHostHub = "iothub.azure-devices.net",
        },
        Kind = "IOT",
        Name = "IoTRole1",
        ResourceGroupName = "GroupForEdgeAutomation",
        RoleStatus = "Enabled",
        ShareMappings = new[] {},
    });

});

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databoxedge.IoTRole;
import com.pulumi.azurenative.databoxedge.IoTRoleArgs;
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 ioTRole = new IoTRole("ioTRole", IoTRoleArgs.builder()        
            .deviceName("testedgedevice")
            .hostPlatform("Linux")
            .ioTDeviceDetails(Map.ofEntries(
                Map.entry("authentication", Map.of("symmetricKey", Map.of("connectionString", Map.ofEntries(
                    Map.entry("encryptionAlgorithm", "AES256"),
                    Map.entry("encryptionCertThumbprint", "348586569999244"),
                    Map.entry("value", "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>")
                )))),
                Map.entry("deviceId", "iotdevice"),
                Map.entry("ioTHostHub", "iothub.azure-devices.net")
            ))
            .ioTEdgeDeviceDetails(Map.ofEntries(
                Map.entry("authentication", Map.of("symmetricKey", Map.of("connectionString", Map.ofEntries(
                    Map.entry("encryptionAlgorithm", "AES256"),
                    Map.entry("encryptionCertThumbprint", "1245475856069999244"),
                    Map.entry("value", "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>")
                )))),
                Map.entry("deviceId", "iotEdge"),
                Map.entry("ioTHostHub", "iothub.azure-devices.net")
            ))
            .kind("IOT")
            .name("IoTRole1")
            .resourceGroupName("GroupForEdgeAutomation")
            .roleStatus("Enabled")
            .shareMappings()
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

io_t_role = azure_native.databoxedge.IoTRole("ioTRole",
    device_name="testedgedevice",
    host_platform="Linux",
    io_t_device_details=azure_native.databoxedge.IoTDeviceInfoResponseArgs(
        authentication={
            "symmetricKey": {
                "connectionString": azure_native.databoxedge.AsymmetricEncryptedSecretArgs(
                    encryption_algorithm="AES256",
                    encryption_cert_thumbprint="348586569999244",
                    value="Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                ),
            },
        },
        device_id="iotdevice",
        io_t_host_hub="iothub.azure-devices.net",
    ),
    io_t_edge_device_details=azure_native.databoxedge.IoTDeviceInfoResponseArgs(
        authentication={
            "symmetricKey": {
                "connectionString": azure_native.databoxedge.AsymmetricEncryptedSecretArgs(
                    encryption_algorithm="AES256",
                    encryption_cert_thumbprint="1245475856069999244",
                    value="Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                ),
            },
        },
        device_id="iotEdge",
        io_t_host_hub="iothub.azure-devices.net",
    ),
    kind="IOT",
    name="IoTRole1",
    resource_group_name="GroupForEdgeAutomation",
    role_status="Enabled",
    share_mappings=[])

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const ioTRole = new azure_native.databoxedge.IoTRole("ioTRole", {
    deviceName: "testedgedevice",
    hostPlatform: "Linux",
    ioTDeviceDetails: {
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: "AES256",
                    encryptionCertThumbprint: "348586569999244",
                    value: "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                },
            },
        },
        deviceId: "iotdevice",
        ioTHostHub: "iothub.azure-devices.net",
    },
    ioTEdgeDeviceDetails: {
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: "AES256",
                    encryptionCertThumbprint: "1245475856069999244",
                    value: "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                },
            },
        },
        deviceId: "iotEdge",
        ioTHostHub: "iothub.azure-devices.net",
    },
    kind: "IOT",
    name: "IoTRole1",
    resourceGroupName: "GroupForEdgeAutomation",
    roleStatus: "Enabled",
    shareMappings: [],
});

    resources:
  ioTRole:
    type: azure-native:databoxedge:IoTRole
    properties:
      deviceName: testedgedevice
      hostPlatform: Linux
      ioTDeviceDetails:
        authentication:
          symmetricKey:
            connectionString:
              encryptionAlgorithm: AES256
              encryptionCertThumbprint: '348586569999244'
              value: Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>
        deviceId: iotdevice
        ioTHostHub: iothub.azure-devices.net
      ioTEdgeDeviceDetails:
        authentication:
          symmetricKey:
            connectionString:
              encryptionAlgorithm: AES256
              encryptionCertThumbprint: '1245475856069999244'
              value: Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>
        deviceId: iotEdge
        ioTHostHub: iothub.azure-devices.net
      kind: IOT
      name: IoTRole1
      resourceGroupName: GroupForEdgeAutomation
      roleStatus: Enabled
      shareMappings: []

    Create IoTRole Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IoTRole(name: string, args: IoTRoleArgs, opts?: CustomResourceOptions);
    @overload
def IoTRole(resource_name: str,
            args: IoTRoleArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IoTRole(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            device_name: Optional[str] = None,
            host_platform: Optional[Union[str, PlatformType]] = None,
            io_t_device_details: Optional[IoTDeviceInfoArgs] = None,
            io_t_edge_device_details: Optional[IoTDeviceInfoArgs] = None,
            resource_group_name: Optional[str] = None,
            role_status: Optional[Union[str, RoleStatus]] = None,
            compute_resource: Optional[ComputeResourceArgs] = None,
            io_t_edge_agent_info: Optional[IoTEdgeAgentInfoArgs] = None,
            name: Optional[str] = None,
            share_mappings: Optional[Sequence[MountPointMapArgs]] = None)
    func NewIoTRole(ctx *Context, name string, args IoTRoleArgs, opts ...ResourceOption) (*IoTRole, error)
    public IoTRole(string name, IoTRoleArgs args, CustomResourceOptions? opts = null)
    public IoTRole(String name, IoTRoleArgs args)
public IoTRole(String name, IoTRoleArgs args, CustomResourceOptions options)

    type: azure-native:databoxedge:IoTRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IoTRoleArgs
    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 IoTRoleArgs
    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 IoTRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IoTRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IoTRoleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ioTRoleResource = new AzureNative.Databoxedge.IoTRole("ioTRoleResource", new()
{
    DeviceName = "string",
    HostPlatform = "string",
    IoTDeviceDetails = 
    {
        { "deviceId", "string" },
        { "ioTHostHub", "string" },
        { "authentication", 
        {
            { "symmetricKey", 
            {
                { "connectionString", 
                {
                    { "encryptionAlgorithm", "string" },
                    { "value", "string" },
                    { "encryptionCertThumbprint", "string" },
                } },
            } },
        } },
        { "ioTHostHubId", "string" },
    },
    IoTEdgeDeviceDetails = 
    {
        { "deviceId", "string" },
        { "ioTHostHub", "string" },
        { "authentication", 
        {
            { "symmetricKey", 
            {
                { "connectionString", 
                {
                    { "encryptionAlgorithm", "string" },
                    { "value", "string" },
                    { "encryptionCertThumbprint", "string" },
                } },
            } },
        } },
        { "ioTHostHubId", "string" },
    },
    Kind = "string",
    ResourceGroupName = "string",
    RoleStatus = "string",
    ComputeResource = 
    {
        { "memoryInGB", 0 },
        { "processorCount", 0 },
    },
    IoTEdgeAgentInfo = 
    {
        { "imageName", "string" },
        { "tag", "string" },
        { "imageRepository", 
        {
            { "imageRepositoryUrl", "string" },
            { "userName", "string" },
            { "password", 
            {
                { "encryptionAlgorithm", "string" },
                { "value", "string" },
                { "encryptionCertThumbprint", "string" },
            } },
        } },
    },
    Name = "string",
    ShareMappings = new[]
    {
        
        {
            { "shareId", "string" },
        },
    },
});

    example, err := databoxedge.NewIoTRole(ctx, "ioTRoleResource", &databoxedge.IoTRoleArgs{
	DeviceName:   "string",
	HostPlatform: "string",
	IoTDeviceDetails: map[string]interface{}{
		"deviceId":   "string",
		"ioTHostHub": "string",
		"authentication": map[string]interface{}{
			"symmetricKey": map[string]interface{}{
				"connectionString": map[string]interface{}{
					"encryptionAlgorithm":      "string",
					"value":                    "string",
					"encryptionCertThumbprint": "string",
				},
			},
		},
		"ioTHostHubId": "string",
	},
	IoTEdgeDeviceDetails: map[string]interface{}{
		"deviceId":   "string",
		"ioTHostHub": "string",
		"authentication": map[string]interface{}{
			"symmetricKey": map[string]interface{}{
				"connectionString": map[string]interface{}{
					"encryptionAlgorithm":      "string",
					"value":                    "string",
					"encryptionCertThumbprint": "string",
				},
			},
		},
		"ioTHostHubId": "string",
	},
	Kind:              "string",
	ResourceGroupName: "string",
	RoleStatus:        "string",
	ComputeResource: map[string]interface{}{
		"memoryInGB":     0,
		"processorCount": 0,
	},
	IoTEdgeAgentInfo: map[string]interface{}{
		"imageName": "string",
		"tag":       "string",
		"imageRepository": map[string]interface{}{
			"imageRepositoryUrl": "string",
			"userName":           "string",
			"password": map[string]interface{}{
				"encryptionAlgorithm":      "string",
				"value":                    "string",
				"encryptionCertThumbprint": "string",
			},
		},
	},
	Name: "string",
	ShareMappings: []map[string]interface{}{
		map[string]interface{}{
			"shareId": "string",
		},
	},
})

    var ioTRoleResource = new IoTRole("ioTRoleResource", IoTRoleArgs.builder()
    .deviceName("string")
    .hostPlatform("string")
    .ioTDeviceDetails(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .ioTEdgeDeviceDetails(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .kind("string")
    .resourceGroupName("string")
    .roleStatus("string")
    .computeResource(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .ioTEdgeAgentInfo(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .name("string")
    .shareMappings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    io_t_role_resource = azure_native.databoxedge.IoTRole("ioTRoleResource",
    device_name=string,
    host_platform=string,
    io_t_device_details={
        deviceId: string,
        ioTHostHub: string,
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: string,
                    value: string,
                    encryptionCertThumbprint: string,
                },
            },
        },
        ioTHostHubId: string,
    },
    io_t_edge_device_details={
        deviceId: string,
        ioTHostHub: string,
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: string,
                    value: string,
                    encryptionCertThumbprint: string,
                },
            },
        },
        ioTHostHubId: string,
    },
    kind=string,
    resource_group_name=string,
    role_status=string,
    compute_resource={
        memoryInGB: 0,
        processorCount: 0,
    },
    io_t_edge_agent_info={
        imageName: string,
        tag: string,
        imageRepository: {
            imageRepositoryUrl: string,
            userName: string,
            password: {
                encryptionAlgorithm: string,
                value: string,
                encryptionCertThumbprint: string,
            },
        },
    },
    name=string,
    share_mappings=[{
        shareId: string,
    }])

    const ioTRoleResource = new azure_native.databoxedge.IoTRole("ioTRoleResource", {
    deviceName: "string",
    hostPlatform: "string",
    ioTDeviceDetails: {
        deviceId: "string",
        ioTHostHub: "string",
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: "string",
                    value: "string",
                    encryptionCertThumbprint: "string",
                },
            },
        },
        ioTHostHubId: "string",
    },
    ioTEdgeDeviceDetails: {
        deviceId: "string",
        ioTHostHub: "string",
        authentication: {
            symmetricKey: {
                connectionString: {
                    encryptionAlgorithm: "string",
                    value: "string",
                    encryptionCertThumbprint: "string",
                },
            },
        },
        ioTHostHubId: "string",
    },
    kind: "string",
    resourceGroupName: "string",
    roleStatus: "string",
    computeResource: {
        memoryInGB: 0,
        processorCount: 0,
    },
    ioTEdgeAgentInfo: {
        imageName: "string",
        tag: "string",
        imageRepository: {
            imageRepositoryUrl: "string",
            userName: "string",
            password: {
                encryptionAlgorithm: "string",
                value: "string",
                encryptionCertThumbprint: "string",
            },
        },
    },
    name: "string",
    shareMappings: [{
        shareId: "string",
    }],
});

    type: azure-native:databoxedge:IoTRole
properties:
    computeResource:
        memoryInGB: 0
        processorCount: 0
    deviceName: string
    hostPlatform: string
    ioTDeviceDetails:
        authentication:
            symmetricKey:
                connectionString:
                    encryptionAlgorithm: string
                    encryptionCertThumbprint: string
                    value: string
        deviceId: string
        ioTHostHub: string
        ioTHostHubId: string
    ioTEdgeAgentInfo:
        imageName: string
        imageRepository:
            imageRepositoryUrl: string
            password:
                encryptionAlgorithm: string
                encryptionCertThumbprint: string
                value: string
            userName: string
        tag: string
    ioTEdgeDeviceDetails:
        authentication:
            symmetricKey:
                connectionString:
                    encryptionAlgorithm: string
                    encryptionCertThumbprint: string
                    value: string
        deviceId: string
        ioTHostHub: string
        ioTHostHubId: string
    kind: string
    name: string
    resourceGroupName: string
    roleStatus: string
    shareMappings:
        - shareId: string

    IoTRole Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IoTRole resource accepts the following input properties:

    DeviceName string
    The device name.
    HostPlatform string | Pulumi.AzureNative.DataBoxEdge.PlatformType
    Host OS supported by the IoT role.
    IoTDeviceDetails Pulumi.AzureNative.DataBoxEdge.Inputs.IoTDeviceInfo
    IoT device metadata to which data box edge device needs to be connected.
    IoTEdgeDeviceDetails Pulumi.AzureNative.DataBoxEdge.Inputs.IoTDeviceInfo
    IoT edge device to which the IoT role needs to be configured.
    ResourceGroupName string
    The resource group name.
    RoleStatus string | Pulumi.AzureNative.DataBoxEdge.RoleStatus
    Role status.
    ComputeResource Pulumi.AzureNative.DataBoxEdge.Inputs.ComputeResource
    Resource allocation
    IoTEdgeAgentInfo Pulumi.AzureNative.DataBoxEdge.Inputs.IoTEdgeAgentInfo
    Iot edge agent details to download the agent and bootstrap iot runtime.
    Name string
    The role name.
    ShareMappings List<Pulumi.AzureNative.DataBoxEdge.Inputs.MountPointMap>
    Mount points of shares in role(s).
    DeviceName string
    The device name.
    HostPlatform string | PlatformType
    Host OS supported by the IoT role.
    IoTDeviceDetails IoTDeviceInfoArgs
    IoT device metadata to which data box edge device needs to be connected.
    IoTEdgeDeviceDetails IoTDeviceInfoArgs
    IoT edge device to which the IoT role needs to be configured.
    ResourceGroupName string
    The resource group name.
    RoleStatus string | RoleStatus
    Role status.
    ComputeResource ComputeResourceArgs
    Resource allocation
    IoTEdgeAgentInfo IoTEdgeAgentInfoArgs
    Iot edge agent details to download the agent and bootstrap iot runtime.
    Name string
    The role name.
    ShareMappings []MountPointMapArgs
    Mount points of shares in role(s).
    deviceName String
    The device name.
    hostPlatform String | PlatformType
    Host OS supported by the IoT role.
    ioTDeviceDetails IoTDeviceInfo
    IoT device metadata to which data box edge device needs to be connected.
    ioTEdgeDeviceDetails IoTDeviceInfo
    IoT edge device to which the IoT role needs to be configured.
    resourceGroupName String
    The resource group name.
    roleStatus String | RoleStatus
    Role status.
    computeResource ComputeResource
    Resource allocation
    ioTEdgeAgentInfo IoTEdgeAgentInfo
    Iot edge agent details to download the agent and bootstrap iot runtime.
    name String
    The role name.
    shareMappings List<MountPointMap>
    Mount points of shares in role(s).
    deviceName string
    The device name.
    hostPlatform string | PlatformType
    Host OS supported by the IoT role.
    ioTDeviceDetails IoTDeviceInfo
    IoT device metadata to which data box edge device needs to be connected.
    ioTEdgeDeviceDetails IoTDeviceInfo
    IoT edge device to which the IoT role needs to be configured.
    resourceGroupName string
    The resource group name.
    roleStatus string | RoleStatus
    Role status.
    computeResource ComputeResource
    Resource allocation
    ioTEdgeAgentInfo IoTEdgeAgentInfo
    Iot edge agent details to download the agent and bootstrap iot runtime.
    name string
    The role name.
    shareMappings MountPointMap[]
    Mount points of shares in role(s).
    device_name str
    The device name.
    host_platform str | PlatformType
    Host OS supported by the IoT role.
    io_t_device_details IoTDeviceInfoArgs
    IoT device metadata to which data box edge device needs to be connected.
    io_t_edge_device_details IoTDeviceInfoArgs
    IoT edge device to which the IoT role needs to be configured.
    resource_group_name str
    The resource group name.
    role_status str | RoleStatus
    Role status.
    compute_resource ComputeResourceArgs
    Resource allocation
    io_t_edge_agent_info IoTEdgeAgentInfoArgs
    Iot edge agent details to download the agent and bootstrap iot runtime.
    name str
    The role name.
    share_mappings Sequence[MountPointMapArgs]
    Mount points of shares in role(s).
    deviceName String
    The device name.
    hostPlatform String | "Windows" | "Linux"
    Host OS supported by the IoT role.
    ioTDeviceDetails Property Map
    IoT device metadata to which data box edge device needs to be connected.
    ioTEdgeDeviceDetails Property Map
    IoT edge device to which the IoT role needs to be configured.
    resourceGroupName String
    The resource group name.
    roleStatus String | "Enabled" | "Disabled"
    Role status.
    computeResource Property Map
    Resource allocation
    ioTEdgeAgentInfo Property Map
    Iot edge agent details to download the agent and bootstrap iot runtime.
    name String
    The role name.
    shareMappings List<Property Map>
    Mount points of shares in role(s).

    Outputs

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

    HostPlatformType string
    Platform where the Iot runtime is hosted.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
    Role configured on ASE resource
    Type string
    The hierarchical type of the object.
    HostPlatformType string
    Platform where the Iot runtime is hosted.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    Role configured on ASE resource
    Type string
    The hierarchical type of the object.
    hostPlatformType String
    Platform where the Iot runtime is hosted.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Role configured on ASE resource
    type String
    The hierarchical type of the object.
    hostPlatformType string
    Platform where the Iot runtime is hosted.
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Role configured on ASE resource
    type string
    The hierarchical type of the object.
    host_platform_type str
    Platform where the Iot runtime is hosted.
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Role configured on ASE resource
    type str
    The hierarchical type of the object.
    hostPlatformType String
    Platform where the Iot runtime is hosted.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    Role configured on ASE resource
    type String
    The hierarchical type of the object.

    Supporting Types

    AsymmetricEncryptedSecret, AsymmetricEncryptedSecretArgs

    EncryptionAlgorithm string | Pulumi.AzureNative.DataBoxEdge.EncryptionAlgorithm
    The algorithm used to encrypt "Value".
    Value string
    The value of the secret.
    EncryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    EncryptionAlgorithm string | EncryptionAlgorithm
    The algorithm used to encrypt "Value".
    Value string
    The value of the secret.
    EncryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm String | EncryptionAlgorithm
    The algorithm used to encrypt "Value".
    value String
    The value of the secret.
    encryptionCertThumbprint String
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm string | EncryptionAlgorithm
    The algorithm used to encrypt "Value".
    value string
    The value of the secret.
    encryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryption_algorithm str | EncryptionAlgorithm
    The algorithm used to encrypt "Value".
    value str
    The value of the secret.
    encryption_cert_thumbprint str
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm String | "None" | "AES256" | "RSAES_PKCS1_v_1_5"
    The algorithm used to encrypt "Value".
    value String
    The value of the secret.
    encryptionCertThumbprint String
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

    AsymmetricEncryptedSecretResponse, AsymmetricEncryptedSecretResponseArgs

    EncryptionAlgorithm string
    The algorithm used to encrypt "Value".
    Value string
    The value of the secret.
    EncryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    EncryptionAlgorithm string
    The algorithm used to encrypt "Value".
    Value string
    The value of the secret.
    EncryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm String
    The algorithm used to encrypt "Value".
    value String
    The value of the secret.
    encryptionCertThumbprint String
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm string
    The algorithm used to encrypt "Value".
    value string
    The value of the secret.
    encryptionCertThumbprint string
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryption_algorithm str
    The algorithm used to encrypt "Value".
    value str
    The value of the secret.
    encryption_cert_thumbprint str
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
    encryptionAlgorithm String
    The algorithm used to encrypt "Value".
    value String
    The value of the secret.
    encryptionCertThumbprint String
    Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

    Authentication, AuthenticationArgs

    SymmetricKey SymmetricKey
    Symmetric key for authentication.
    symmetricKey SymmetricKey
    Symmetric key for authentication.
    symmetricKey SymmetricKey
    Symmetric key for authentication.
    symmetric_key SymmetricKey
    Symmetric key for authentication.
    symmetricKey Property Map
    Symmetric key for authentication.

    AuthenticationResponse, AuthenticationResponseArgs

    SymmetricKey SymmetricKeyResponse
    Symmetric key for authentication.
    symmetricKey SymmetricKeyResponse
    Symmetric key for authentication.
    symmetricKey SymmetricKeyResponse
    Symmetric key for authentication.
    symmetric_key SymmetricKeyResponse
    Symmetric key for authentication.
    symmetricKey Property Map
    Symmetric key for authentication.

    ComputeResource, ComputeResourceArgs

    MemoryInGB double
    Memory in GB
    ProcessorCount int
    Processor count
    MemoryInGB float64
    Memory in GB
    ProcessorCount int
    Processor count
    memoryInGB Double
    Memory in GB
    processorCount Integer
    Processor count
    memoryInGB number
    Memory in GB
    processorCount number
    Processor count
    memory_in_gb float
    Memory in GB
    processor_count int
    Processor count
    memoryInGB Number
    Memory in GB
    processorCount Number
    Processor count

    ComputeResourceResponse, ComputeResourceResponseArgs

    MemoryInGB double
    Memory in GB
    ProcessorCount int
    Processor count
    MemoryInGB float64
    Memory in GB
    ProcessorCount int
    Processor count
    memoryInGB Double
    Memory in GB
    processorCount Integer
    Processor count
    memoryInGB number
    Memory in GB
    processorCount number
    Processor count
    memory_in_gb float
    Memory in GB
    processor_count int
    Processor count
    memoryInGB Number
    Memory in GB
    processorCount Number
    Processor count

    EncryptionAlgorithm, EncryptionAlgorithmArgs

    None
    None
    AES256
    AES256
    RSAES_PKCS1_v_1_5
    RSAES_PKCS1_v_1_5
    EncryptionAlgorithmNone
    None
    EncryptionAlgorithmAES256
    AES256
    EncryptionAlgorithm_RSAES_PKCS1_v_1_5
    RSAES_PKCS1_v_1_5
    None
    None
    AES256
    AES256
    RSAES_PKCS1_v_1_5
    RSAES_PKCS1_v_1_5
    None
    None
    AES256
    AES256
    RSAES_PKCS1_v_1_5
    RSAES_PKCS1_v_1_5
    NONE
    None
    AES256
    AES256
    RSAE_S_PKCS1_V_1_5
    RSAES_PKCS1_v_1_5
    "None"
    None
    "AES256"
    AES256
    "RSAES_PKCS1_v_1_5"
    RSAES_PKCS1_v_1_5

    ImageRepositoryCredential, ImageRepositoryCredentialArgs

    ImageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    UserName string
    Repository user name.
    Password Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecret
    Repository user password.
    ImageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    UserName string
    Repository user name.
    Password AsymmetricEncryptedSecret
    Repository user password.
    imageRepositoryUrl String
    Image repository url (e.g.: mcr.microsoft.com).
    userName String
    Repository user name.
    password AsymmetricEncryptedSecret
    Repository user password.
    imageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    userName string
    Repository user name.
    password AsymmetricEncryptedSecret
    Repository user password.
    image_repository_url str
    Image repository url (e.g.: mcr.microsoft.com).
    user_name str
    Repository user name.
    password AsymmetricEncryptedSecret
    Repository user password.
    imageRepositoryUrl String
    Image repository url (e.g.: mcr.microsoft.com).
    userName String
    Repository user name.
    password Property Map
    Repository user password.

    ImageRepositoryCredentialResponse, ImageRepositoryCredentialResponseArgs

    ImageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    UserName string
    Repository user name.
    Password Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretResponse
    Repository user password.
    ImageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    UserName string
    Repository user name.
    Password AsymmetricEncryptedSecretResponse
    Repository user password.
    imageRepositoryUrl String
    Image repository url (e.g.: mcr.microsoft.com).
    userName String
    Repository user name.
    password AsymmetricEncryptedSecretResponse
    Repository user password.
    imageRepositoryUrl string
    Image repository url (e.g.: mcr.microsoft.com).
    userName string
    Repository user name.
    password AsymmetricEncryptedSecretResponse
    Repository user password.
    image_repository_url str
    Image repository url (e.g.: mcr.microsoft.com).
    user_name str
    Repository user name.
    password AsymmetricEncryptedSecretResponse
    Repository user password.
    imageRepositoryUrl String
    Image repository url (e.g.: mcr.microsoft.com).
    userName String
    Repository user name.
    password Property Map
    Repository user password.

    IoTDeviceInfo, IoTDeviceInfoArgs

    DeviceId string
    ID of the IoT device/edge device.
    IoTHostHub string
    Host name for the IoT hub associated to the device.
    Authentication Pulumi.AzureNative.DataBoxEdge.Inputs.Authentication
    Encrypted IoT device/IoT edge device connection string.
    IoTHostHubId string
    Id for the IoT hub associated to the device.
    DeviceId string
    ID of the IoT device/edge device.
    IoTHostHub string
    Host name for the IoT hub associated to the device.
    Authentication Authentication
    Encrypted IoT device/IoT edge device connection string.
    IoTHostHubId string
    Id for the IoT hub associated to the device.
    deviceId String
    ID of the IoT device/edge device.
    ioTHostHub String
    Host name for the IoT hub associated to the device.
    authentication Authentication
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId String
    Id for the IoT hub associated to the device.
    deviceId string
    ID of the IoT device/edge device.
    ioTHostHub string
    Host name for the IoT hub associated to the device.
    authentication Authentication
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId string
    Id for the IoT hub associated to the device.
    device_id str
    ID of the IoT device/edge device.
    io_t_host_hub str
    Host name for the IoT hub associated to the device.
    authentication Authentication
    Encrypted IoT device/IoT edge device connection string.
    io_t_host_hub_id str
    Id for the IoT hub associated to the device.
    deviceId String
    ID of the IoT device/edge device.
    ioTHostHub String
    Host name for the IoT hub associated to the device.
    authentication Property Map
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId String
    Id for the IoT hub associated to the device.

    IoTDeviceInfoResponse, IoTDeviceInfoResponseArgs

    DeviceId string
    ID of the IoT device/edge device.
    IoTHostHub string
    Host name for the IoT hub associated to the device.
    Authentication Pulumi.AzureNative.DataBoxEdge.Inputs.AuthenticationResponse
    Encrypted IoT device/IoT edge device connection string.
    IoTHostHubId string
    Id for the IoT hub associated to the device.
    DeviceId string
    ID of the IoT device/edge device.
    IoTHostHub string
    Host name for the IoT hub associated to the device.
    Authentication AuthenticationResponse
    Encrypted IoT device/IoT edge device connection string.
    IoTHostHubId string
    Id for the IoT hub associated to the device.
    deviceId String
    ID of the IoT device/edge device.
    ioTHostHub String
    Host name for the IoT hub associated to the device.
    authentication AuthenticationResponse
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId String
    Id for the IoT hub associated to the device.
    deviceId string
    ID of the IoT device/edge device.
    ioTHostHub string
    Host name for the IoT hub associated to the device.
    authentication AuthenticationResponse
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId string
    Id for the IoT hub associated to the device.
    device_id str
    ID of the IoT device/edge device.
    io_t_host_hub str
    Host name for the IoT hub associated to the device.
    authentication AuthenticationResponse
    Encrypted IoT device/IoT edge device connection string.
    io_t_host_hub_id str
    Id for the IoT hub associated to the device.
    deviceId String
    ID of the IoT device/edge device.
    ioTHostHub String
    Host name for the IoT hub associated to the device.
    authentication Property Map
    Encrypted IoT device/IoT edge device connection string.
    ioTHostHubId String
    Id for the IoT hub associated to the device.

    IoTEdgeAgentInfo, IoTEdgeAgentInfoArgs

    ImageName string
    Name of the IoT edge agent image.
    Tag string
    Image Tag.
    ImageRepository Pulumi.AzureNative.DataBoxEdge.Inputs.ImageRepositoryCredential
    Image repository details.
    ImageName string
    Name of the IoT edge agent image.
    Tag string
    Image Tag.
    ImageRepository ImageRepositoryCredential
    Image repository details.
    imageName String
    Name of the IoT edge agent image.
    tag String
    Image Tag.
    imageRepository ImageRepositoryCredential
    Image repository details.
    imageName string
    Name of the IoT edge agent image.
    tag string
    Image Tag.
    imageRepository ImageRepositoryCredential
    Image repository details.
    image_name str
    Name of the IoT edge agent image.
    tag str
    Image Tag.
    image_repository ImageRepositoryCredential
    Image repository details.
    imageName String
    Name of the IoT edge agent image.
    tag String
    Image Tag.
    imageRepository Property Map
    Image repository details.

    IoTEdgeAgentInfoResponse, IoTEdgeAgentInfoResponseArgs

    ImageName string
    Name of the IoT edge agent image.
    Tag string
    Image Tag.
    ImageRepository Pulumi.AzureNative.DataBoxEdge.Inputs.ImageRepositoryCredentialResponse
    Image repository details.
    ImageName string
    Name of the IoT edge agent image.
    Tag string
    Image Tag.
    ImageRepository ImageRepositoryCredentialResponse
    Image repository details.
    imageName String
    Name of the IoT edge agent image.
    tag String
    Image Tag.
    imageRepository ImageRepositoryCredentialResponse
    Image repository details.
    imageName string
    Name of the IoT edge agent image.
    tag string
    Image Tag.
    imageRepository ImageRepositoryCredentialResponse
    Image repository details.
    image_name str
    Name of the IoT edge agent image.
    tag str
    Image Tag.
    image_repository ImageRepositoryCredentialResponse
    Image repository details.
    imageName String
    Name of the IoT edge agent image.
    tag String
    Image Tag.
    imageRepository Property Map
    Image repository details.

    MountPointMap, MountPointMapArgs

    ShareId string
    ID of the share mounted to the role VM.
    ShareId string
    ID of the share mounted to the role VM.
    shareId String
    ID of the share mounted to the role VM.
    shareId string
    ID of the share mounted to the role VM.
    share_id str
    ID of the share mounted to the role VM.
    shareId String
    ID of the share mounted to the role VM.

    MountPointMapResponse, MountPointMapResponseArgs

    MountPoint string
    Mount point for the share.
    MountType string
    Mounting type.
    RoleId string
    ID of the role to which share is mounted.
    RoleType string
    Role type.
    ShareId string
    ID of the share mounted to the role VM.
    MountPoint string
    Mount point for the share.
    MountType string
    Mounting type.
    RoleId string
    ID of the role to which share is mounted.
    RoleType string
    Role type.
    ShareId string
    ID of the share mounted to the role VM.
    mountPoint String
    Mount point for the share.
    mountType String
    Mounting type.
    roleId String
    ID of the role to which share is mounted.
    roleType String
    Role type.
    shareId String
    ID of the share mounted to the role VM.
    mountPoint string
    Mount point for the share.
    mountType string
    Mounting type.
    roleId string
    ID of the role to which share is mounted.
    roleType string
    Role type.
    shareId string
    ID of the share mounted to the role VM.
    mount_point str
    Mount point for the share.
    mount_type str
    Mounting type.
    role_id str
    ID of the role to which share is mounted.
    role_type str
    Role type.
    share_id str
    ID of the share mounted to the role VM.
    mountPoint String
    Mount point for the share.
    mountType String
    Mounting type.
    roleId String
    ID of the role to which share is mounted.
    roleType String
    Role type.
    shareId String
    ID of the share mounted to the role VM.

    PlatformType, PlatformTypeArgs

    Windows
    Windows
    Linux
    Linux
    PlatformTypeWindows
    Windows
    PlatformTypeLinux
    Linux
    Windows
    Windows
    Linux
    Linux
    Windows
    Windows
    Linux
    Linux
    WINDOWS
    Windows
    LINUX
    Linux
    "Windows"
    Windows
    "Linux"
    Linux

    RoleStatus, RoleStatusArgs

    Enabled
    Enabled
    Disabled
    Disabled
    RoleStatusEnabled
    Enabled
    RoleStatusDisabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    ENABLED
    Enabled
    DISABLED
    Disabled
    "Enabled"
    Enabled
    "Disabled"
    Disabled

    SymmetricKey, SymmetricKeyArgs

    ConnectionString AsymmetricEncryptedSecret
    Connection string based on the symmetric key.
    connectionString AsymmetricEncryptedSecret
    Connection string based on the symmetric key.
    connectionString AsymmetricEncryptedSecret
    Connection string based on the symmetric key.
    connection_string AsymmetricEncryptedSecret
    Connection string based on the symmetric key.
    connectionString Property Map
    Connection string based on the symmetric key.

    SymmetricKeyResponse, SymmetricKeyResponseArgs

    ConnectionString AsymmetricEncryptedSecretResponse
    Connection string based on the symmetric key.
    connectionString AsymmetricEncryptedSecretResponse
    Connection string based on the symmetric key.
    connectionString AsymmetricEncryptedSecretResponse
    Connection string based on the symmetric key.
    connection_string AsymmetricEncryptedSecretResponse
    Connection string based on the symmetric key.
    connectionString Property Map
    Connection string based on the symmetric key.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:databoxedge:IoTRole IoTRole1 /subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native