users

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

Overview

Name	users
Type	Resource
Id	azure.data_box_edge.users

Fields

The following fields are returned by SELECT queries:

get

The user details.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The storage account credential properties.
systemData	object	Metadata pertaining to creation and last modification of User
type	string	The hierarchical type of the object.

list_by_data_box_edge_device

The collection of all users on the device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The storage account credential properties.
systemData	object	Metadata pertaining to creation and last modification of User
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 the properties of the specified user.
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName	$filter	Gets all the users registered on a Data Box Edge/Data Box Gateway device.
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, 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, subscriptionId, resourceGroupName		Deletes the user on a databox edge/gateway 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 user name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.
$filter	string	Specify $filter='Type eq <type>' to filter on user type property

SELECT examples

get

Gets the properties of the specified user.

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

list_by_data_box_edge_device

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

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

INSERT examples

create_or_update

Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.

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

Manifest

# Description fields are for documentation purposes
- name: users
  props:
    - name: deviceName
      value: string
      description: Required parameter for the users resource.
    - name: name
      value: string
      description: Required parameter for the users resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the users resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the users resource.
    - name: properties
      value: object
      description: |
        The storage account credential properties.

DELETE examples

delete

Deletes the user on a databox edge/gateway device.

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