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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Addon type. Required. Known values are: "IotEdge" and "ArcForKubernetes".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_role

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Addon type. Required. Known values are: "IotEdge" and "ArcForKubernetes".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, role_name, addon_name, resource_group_name, subscription_id		Gets a specific addon by name.
list_by_role	select	device_name, role_name, resource_group_name, subscription_id		Lists all the addons configured in the role.
create_or_update	insert	device_name, role_name, addon_name, resource_group_name, subscription_id, kind		Create or update a addon.
create_or_update	replace	device_name, role_name, addon_name, resource_group_name, subscription_id, kind		Create or update a addon.
delete	delete	device_name, role_name, addon_name, resource_group_name, subscription_id		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
addon_name	string	The name of the addon. Required.
device_name	string	The name of the device. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_name	string	The name of the role. Required.
subscription_id	string

SELECT examples

get

Gets a specific addon by name.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_box_edge.addons
WHERE device_name = '{{ device_name }}' -- required
AND role_name = '{{ role_name }}' -- required
AND addon_name = '{{ addon_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 device_name = '{{ device_name }}' -- required
AND role_name = '{{ role_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a addon.

INSERT INTO azure.data_box_edge.addons (
kind,
device_name,
role_name,
addon_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ device_name }}',
'{{ role_name }}',
'{{ addon_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: addons
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the addons resource.
  - name: role_name
    value: "{{ role_name }}"
    description: Required parameter for the addons resource.
  - name: addon_name
    value: "{{ addon_name }}"
    description: Required parameter for the addons resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the addons resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the addons resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Addon type. Required. Known values are: "IotEdge" and "ArcForKubernetes".

REPLACE examples

create_or_update

Create or update a addon.

REPLACE azure.data_box_edge.addons
SET 
kind = '{{ kind }}'
WHERE 
device_name = '{{ device_name }}' --required
AND role_name = '{{ role_name }}' --required
AND addon_name = '{{ addon_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
systemData,
type;

DELETE examples

delete

Deletes the addon on the device.

DELETE FROM azure.data_box_edge.addons
WHERE device_name = '{{ device_name }}' --required
AND role_name = '{{ role_name }}' --required
AND addon_name = '{{ addon_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;