Addons - List By Role

Service:

Data Box Edge/Data Box Gateway

API Version:

2021-02-01

Lists all the addons configured in the role.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons?api-version=2021-02-01

URI Parameters

Name	In	Required	Type	Description
deviceName	path	True	string	The device name.
resourceGroupName	path	True	string	The resource group name.
roleName	path	True	string	The role name.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	The API version.

Responses

Name	Type	Description
200 OK	AddonList	List of all the addons configured in the role.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RoleListAddOns

Sample Request

HTTP

GET https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1/addons?api-version=2021-02-01

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
        "resourceGroupName": "testrg1",
        "resourceName": "testresource1",
        "resourceLocation": "EastUS",
        "version": "0.2.18",
        "hostPlatform": "Linux",
        "hostPlatformType": "KubernetesCluster",
        "provisioningState": "Created"
      },
      "kind": "ArcForKubernetes",
      "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
      "name": "arcName",
      "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
    }
  ]
}

Definitions

Name	Description
AddonList	Collection of all the Role addon on the Azure Stack Edge device.
AddonState	Addon Provisioning State
ArcAddon	Arc Addon.
AsymmetricEncryptedSecret	Represent the secrets intended for encryption with asymmetric key pair.
Authentication	Authentication mechanism for IoT devices.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
createdByType	The type of identity that created the resource.
EncryptionAlgorithm	The algorithm used to encrypt "Value".
HostPlatformType	Platform where the runtime is hosted.
IoTAddon	IoT Addon.
IoTDeviceInfo	Metadata of IoT device/IoT Edge device to be configured.
PlatformType	Host OS supported by the Arc addon.
SymmetricKey	Symmetric key for authentication.
SystemData	Metadata pertaining to creation and last modification of the resource.

AddonList

Collection of all the Role addon on the Azure Stack Edge device.

Name	Type	Description
nextLink	string	Link to the next set of results.
value	Addon[]: ArcAddon[] IoTAddon[]	The Value.

AddonState

Addon Provisioning State

Name	Type	Description
Created	string
Creating	string
Deleting	string
Failed	string
Invalid	string
Reconfiguring	string
Updating	string

ArcAddon

Arc Addon.

Name	Type	Description
id	string	The path ID that uniquely identifies the object.
kind	string: ArcForKubernetes	Addon type.
name	string	The object name.
properties.hostPlatform	PlatformType	Host OS supported by the Arc addon.
properties.hostPlatformType	HostPlatformType	Platform where the runtime is hosted.
properties.provisioningState	AddonState	Addon Provisioning State
properties.resourceGroupName	string	Arc resource group name
properties.resourceLocation	string	Arc resource location
properties.resourceName	string	Arc resource Name
properties.subscriptionId	string	Arc resource subscription Id
properties.version	string	Arc resource version
systemData	SystemData	Addon type
type	string	The hierarchical type of the object.

AsymmetricEncryptedSecret

Represent the secrets intended for encryption with asymmetric key pair.

Name	Type	Description
encryptionAlgorithm	EncryptionAlgorithm	The algorithm used to encrypt "Value".
encryptionCertThumbprint	string	Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
value	string	The value of the secret.

Authentication

Authentication mechanism for IoT devices.

Name	Type	Description
symmetricKey	SymmetricKey	Symmetric key for authentication.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	The error details.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EncryptionAlgorithm

The algorithm used to encrypt "Value".

Name	Type	Description
AES256	string
None	string
RSAES_PKCS1_v_1_5	string

HostPlatformType

Platform where the runtime is hosted.

Name	Type	Description
KubernetesCluster	string
LinuxVM	string

IoTAddon

IoT Addon.

Name	Type	Description
id	string	The path ID that uniquely identifies the object.
kind	string: IotEdge	Addon type.
name	string	The object name.
properties.hostPlatform	PlatformType	Host OS supported by the IoT addon.
properties.hostPlatformType	HostPlatformType	Platform where the runtime is hosted.
properties.ioTDeviceDetails	IoTDeviceInfo	IoT device metadata to which appliance needs to be connected.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	IoT edge device to which the IoT Addon needs to be configured.
properties.provisioningState	AddonState	Addon Provisioning State
properties.version	string	Version of IoT running on the appliance.
systemData	SystemData	Addon type
type	string	The hierarchical type of the object.

IoTDeviceInfo

Metadata of IoT device/IoT Edge device to be configured.

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

PlatformType

Host OS supported by the Arc addon.

Name	Type	Description
Linux	string
Windows	string

SymmetricKey

Symmetric key for authentication.

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

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	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	createdByType	The type of identity that last modified the resource.