users

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

Overview

Name	users
Type	Resource
Id	azure.data_box_edge.users

Fields

vw_users

Name	Datatype	Description
id	text	The path ID that uniquely identifies the object.
name	text	The object name.
deviceName	text	field from the properties object
encrypted_password	text	field from the properties object
resourceGroupName	text	field from the properties object
share_access_rights	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The hierarchical type of the object.
user_type	text	field from the properties object

users

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The user properties.
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	deviceName, name, resourceGroupName, subscriptionId	Gets the properties of the specified user.
list_by_data_box_edge_device	SELECT	deviceName, resourceGroupName, subscriptionId	Gets all the users registered on a Data Box Edge/Data Box Gateway device.
create_or_update	INSERT	deviceName, name, resourceGroupName, subscriptionId, data__properties	Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
delete	DELETE	deviceName, name, resourceGroupName, subscriptionId	Deletes the user on a databox edge/gateway device.

SELECT examples

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

vw_users

SELECT
id,
name,
deviceName,
encrypted_password,
resourceGroupName,
share_access_rights,
subscriptionId,
system_data,
type,
user_type
FROM azure.data_box_edge.vw_users
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

users

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.users (
deviceName,
name,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ deviceName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: encryptedPassword
          value:
            - name: value
              value: string
            - name: encryptionCertThumbprint
              value: string
            - name: encryptionAlgorithm
              value: string
        - name: shareAccessRights
          value:
            - - name: shareId
                value: string
              - name: accessType
                value: string
        - name: userType
          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 users resource.

/*+ delete */
DELETE FROM azure.data_box_edge.users
WHERE deviceName = '{{ deviceName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';