roles

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

Overview

Name	roles
Type	Resource
Id	azure.data_box_edge.roles

Fields

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 the resource.
type	string	The hierarchical type of the object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deviceName, name, resourceGroupName, subscriptionId	Gets a specific role by name.
list_by_data_box_edge_device	SELECT	deviceName, resourceGroupName, subscriptionId	Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
create_or_update	INSERT	deviceName, name, resourceGroupName, subscriptionId, data__kind	Create or update a role.
delete	DELETE	deviceName, name, resourceGroupName, subscriptionId	Deletes the role on the device.

SELECT examples

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 }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.roles (
deviceName,
name,
resourceGroupName,
subscriptionId,
data__kind,
kind
)
SELECT 
'{{ deviceName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__kind }}',
'{{ kind }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: kind
      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 roles resource.

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