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

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.
encryptedPassword	object	The password details.
shareAccessRights	array	List of shares that the user has rights on. This field should not be specified during user creation.
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".
userType	string	Type of the user. Required. Known values are: "Share", "LocalManagement", and "ARM". (Share, LocalManagement, ARM)

list_by_data_box_edge_device

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.
encryptedPassword	object	The password details.
shareAccessRights	array	List of shares that the user has rights on. This field should not be specified during user creation.
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".
userType	string	Type of the user. Required. Known values are: "Share", "LocalManagement", and "ARM". (Share, LocalManagement, ARM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, name, resource_group_name, subscription_id		Gets the properties of the specified user.
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id	$filter	Gets all the users registered on a Data Box Edge/Data Box Gateway device.
create_or_update	insert	device_name, name, resource_group_name, subscription_id, properties		Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
create_or_update	replace	device_name, name, resource_group_name, subscription_id, properties		Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
delete	delete	device_name, name, resource_group_name, subscription_id		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
device_name	string	The device name. Required.
name	string	The user name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Specify $filter='Type eq ' to filter on user type property. Default value is None.

SELECT examples

get

Gets the properties of the specified user.

SELECT
id,
name,
encryptedPassword,
shareAccessRights,
systemData,
type,
userType
FROM azure.data_box_edge.users
WHERE device_name = '{{ device_name }}' -- required
AND name = '{{ name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_box_edge_device

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

SELECT
id,
name,
encryptedPassword,
shareAccessRights,
systemData,
type,
userType
FROM azure.data_box_edge.users
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
device_name,
name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ device_name }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the users resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the users resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the users resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the users resource.
  - name: properties
    description: |
      The storage account credential properties. Required.
    value:
      encryptedPassword:
        value: "{{ value }}"
        encryptionCertThumbprint: "{{ encryptionCertThumbprint }}"
        encryptionAlgorithm: "{{ encryptionAlgorithm }}"
      shareAccessRights:
        - shareId: "{{ shareId }}"
          accessType: "{{ accessType }}"
      userType: "{{ userType }}"

REPLACE examples

create_or_update

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

REPLACE azure.data_box_edge.users
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the user on a databox edge/gateway device.

DELETE FROM azure.data_box_edge.users
WHERE device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;