Microsoft.DataBoxEdge dataBoxEdgeDevices/roles/addons

ARM template resource definition

The dataBoxEdgeDevices/roles/addons resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons",
  "apiVersion": "2023-12-01",
  "name": "string",
  "kind": "string",
  // For remaining properties, see dataBoxEdgeDevices/roles/addons objects
}

dataBoxEdgeDevices/roles/addons objects

Set the kind property to specify the type of object.

For ArcForKubernetes, use:

  "kind": "ArcForKubernetes",
  "properties": {
    "resourceGroupName": "string",
    "resourceLocation": "string",
    "resourceName": "string",
    "subscriptionId": "string"
  }

For IotEdge, use:

  "kind": "IotEdge",
  "properties": {
    "ioTDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    },
    "ioTEdgeDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    }
  }

Property values

dataBoxEdgeDevices/roles/addons

Name Description Value
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons'
apiVersion The resource api version '2023-12-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
kind Set the object type ArcForKubernetes
IotEdge (required)

ArcAddon

Name Description Value
kind Addon type. 'ArcForKubernetes' (required)
properties Properties specific to Arc addon. ArcAddonProperties (required)

ArcAddonProperties

Name Description Value
resourceGroupName Arc resource group name string (required)
resourceLocation Arc resource location string (required)
resourceName Arc resource Name string (required)
subscriptionId Arc resource subscription Id string (required)

IoTAddon

Name Description Value
kind Addon type. 'IotEdge' (required)
properties Properties specific to IOT addon. IoTAddonProperties (required)

IoTAddonProperties

Name Description Value
ioTDeviceDetails IoT device metadata to which appliance needs to be connected. IoTDeviceInfo (required)
ioTEdgeDeviceDetails IoT edge device to which the IoT Addon needs to be configured. IoTDeviceInfo (required)

IoTDeviceInfo

Name Description Value
authentication Encrypted IoT device/IoT edge device connection string. Authentication
deviceId ID of the IoT device/edge device. string (required)
ioTHostHub Host name for the IoT hub associated to the device. string (required)
ioTHostHubId Id for the IoT hub associated to the device. string

Authentication

Name Description Value
symmetricKey Symmetric key for authentication. SymmetricKey

SymmetricKey

Name Description Value
connectionString Connection string based on the symmetric key. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Name Description Value
encryptionAlgorithm The algorithm used to encrypt "Value". 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (required)
encryptionCertThumbprint Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value The value of the secret. string (required)