roles

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

Overview

Name	roles
Type	Resource
Id	azure.edge_gateway.roles

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_raw	exec	resource_group_name, name, device_name, subscription_id	accept-language	Gets a specific role by name.
list_by_data_box_edge_device	exec	resource_group_name, device_name, subscription_id	accept-language	Lists all the roles configured in a data box 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.
name	string	The role name.
resource_group_name	string	The resource group name.
subscription_id	string
accept-language	string

Lifecycle Methods

get_raw

Gets a specific role by name.

EXEC azure.edge_gateway.roles.get_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;

list_by_data_box_edge_device

Lists all the roles configured in a data box edge/gateway device.

EXEC azure.edge_gateway.roles.list_by_data_box_edge_device 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;