roles

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

Overview

Name	roles
Type	Resource
Id	azure.data_box_edge.roles

Fields

The following fields are returned by SELECT queries:

get

The role with the specified name in the given device.

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

list_by_data_box_edge_device

List of all the roles configured in the device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	Role type.
systemData	object	Metadata pertaining to creation and last modification of Role
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, name, subscriptionId, resourceGroupName		Gets a specific role by name.
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName		Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, data__kind		Create or update a role.
delete	delete	deviceName, name, subscriptionId, resourceGroupName		Deletes the role 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
deviceName	string	The device name.
name	string	The role name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

get

Gets a specific role by name.

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

list_by_data_box_edge_device

Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

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

INSERT examples

create_or_update

Create or update a role.

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

Manifest

# Description fields are for documentation purposes
- name: roles
  props:
    - name: deviceName
      value: string
      description: Required parameter for the roles resource.
    - name: name
      value: string
      description: Required parameter for the roles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the roles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the roles resource.
    - name: kind
      value: string
      description: |
        Role type.
      valid_values: ['IOT', 'ASA', 'Functions', 'Cognitive', 'MEC', 'CloudEdgeManagement', 'Kubernetes']

DELETE examples

delete

Deletes the role on the device.

DELETE FROM azure.data_box_edge.roles
WHERE deviceName = '{{ deviceName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;