UsersOperations Class

UsersOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

UsersOperations

Constructor

UsersOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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: User, **kwargs) -> AsyncLROPoller[User]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) -> AsyncLROPoller[None]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) -> User

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[UserList]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>