UsersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:users> attribute.

Constructor

UsersOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
begin_delete	Deletes the user on a databox edge/gateway device.
get	Gets the properties of the specified user.
list_by_data_box_edge_device	Gets all the users registered on a Data Box Edge/Data Box Gateway device.

begin_create_or_update

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

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

Parameters

Name	Description
device_name Required	str The device name. Required.
name Required	str The user name. Required.
resource_group_name Required	str The resource group name. Required.
user Required	User or IO[bytes] The user details. Is either a User type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the user on a databox edge/gateway 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 user 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 the properties of the specified user.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_data_box_edge_device

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

list_by_data_box_edge_device(device_name: str, resource_group_name: str, filter: str | None = None, **kwargs: Any) -> AsyncIterable[User]

Parameters

Name	Description
device_name Required	str The device name. Required.
resource_group_name Required	str The resource group name. Required.
filter	str Specify $filter='UserType eq <type>' to filter on user type property. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[User]	An iterator like instance of either User 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'>