RolesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:roles> attribute.

Constructor

RolesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a role.
begin_delete	Deletes the role on the device.
get	Gets a specific role by name.
list_by_data_box_edge_device	Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

begin_create_or_update

Create or update a role.

async begin_create_or_update(device_name: str, name: str, resource_group_name: str, role: _models.Role, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Role]

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The role name. Required.
resource_group_name Required	str The resource group name. Required.
role Required	Role or IO[bytes] The role properties. Is either a Role type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Role]	An instance of AsyncLROPoller that returns either Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the role on the device.

async begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The role name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a specific role by name.

async get(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> Role

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The role name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
Role	Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_data_box_edge_device

Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

list_by_data_box_edge_device(device_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[Role]

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.

Returns

Type	Description
AsyncItemPaged[Role]	An iterator like instance of either Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>