addons

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

Overview

Name	addons
Type	Resource
Id	azure.data_box_edge.addons

Fields

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 the resource.
type	string	The hierarchical type of the object.

Methods

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

SELECT examples

Lists all the addons configured in the role.

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

INSERT example

Use the following StackQL query and manifest file to create a new addons resource.

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.addons (
addonName,
deviceName,
resourceGroupName,
roleName,
subscriptionId,
data__kind,
kind
)
SELECT 
'{{ addonName }}',
'{{ deviceName }}',
'{{ resourceGroupName }}',
'{{ roleName }}',
'{{ subscriptionId }}',
'{{ data__kind }}',
'{{ kind }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: kind
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified addons resource.

/*+ delete */
DELETE FROM azure.data_box_edge.addons
WHERE addonName = '{{ addonName }}'
AND deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND roleName = '{{ roleName }}'
AND subscriptionId = '{{ subscriptionId }}';