addons

Creates, updates, deletes, gets or lists an addons resource.

Overview

Name	addons
Type	Resource
Id	azure.data_box_edge.addons

Fields

The following fields are returned by SELECT queries:

get

The addon with the specified name in the role.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	Addon type.
systemData	object	Metadata pertaining to creation and last modification of Addon
type	string	The hierarchical type of the object.

list_by_role

List of all the addons configured in the role.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	Addon type.
systemData	object	Metadata pertaining to creation and last modification of Addon
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, roleName, addonName, subscriptionId, resourceGroupName		Gets a specific addon by name.
list_by_role	select	deviceName, roleName, subscriptionId, resourceGroupName		Lists all the addons configured in the role.
create_or_update	insert	deviceName, roleName, addonName, subscriptionId, resourceGroupName, data__kind		Create or update a addon.
delete	delete	deviceName, roleName, addonName, subscriptionId, resourceGroupName		Deletes the addon on the device.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
addonName	string	The addon name.
deviceName	string	The device name.
resourceGroupName	string	The resource group name.
roleName	string	The role name.
subscriptionId	string	The subscription ID.

SELECT examples

get

Gets a specific addon by name.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_box_edge.addons
WHERE deviceName = '{{ deviceName }}' -- required
AND roleName = '{{ roleName }}' -- required
AND addonName = '{{ addonName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_role

Lists all the addons configured in the role.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_box_edge.addons
WHERE deviceName = '{{ deviceName }}' -- required
AND roleName = '{{ roleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Create or update a addon.

INSERT INTO azure.data_box_edge.addons (
data__kind,
deviceName,
roleName,
addonName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ kind }}' /* required */,
'{{ deviceName }}',
'{{ roleName }}',
'{{ addonName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: addons
  props:
    - name: deviceName
      value: string
      description: Required parameter for the addons resource.
    - name: roleName
      value: string
      description: Required parameter for the addons resource.
    - name: addonName
      value: string
      description: Required parameter for the addons resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the addons resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the addons resource.
    - name: kind
      value: string
      description: |
        Addon type.
      valid_values: ['IotEdge', 'ArcForKubernetes']

DELETE examples

delete

Deletes the addon on the device.

DELETE FROM azure.data_box_edge.addons
WHERE deviceName = '{{ deviceName }}' --required
AND roleName = '{{ roleName }}' --required
AND addonName = '{{ addonName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;