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

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

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: azure.mgmt.databoxedge.v2019_08_01.models._models_py3.User, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.databoxedge.v2019_08_01.models._models_py3.User]

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

user

User

Required

The user details.

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

An instance of AsyncLROPoller that returns either User or the result of cls(response)

Return type

AsyncLROPoller[User]

Exceptions

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) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets the properties of the specified user.

async get(device_name: str, name: str, resource_group_name: str, **kwargs) -> azure.mgmt.databoxedge.v2019_08_01.models._models_py3.User

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

cls

callable

A custom type or function that will be passed the direct response

Returns

User, or the result of cls(response)

Return type

User

Exceptions

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: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.databoxedge.v2019_08_01.models._models_py3.UserList]

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

filter

str

default value: None

Specify $filter='UserType eq <type>' to filter on user type property.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserList or the result of cls(response)

Return type

AsyncItemPaged[UserList]

Exceptions

HttpResponseError

Attributes

models

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