UsersOperations Class

UsersOperations operations.

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

api_version

The API version. Constant value: "2019-03-01".

Methods

create_or_update	Creates a new user or updates an existing user's information on a data box edge/gateway device.
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/gateway device.

create_or_update

Creates a new user or updates an existing user's information on a data box edge/gateway device.

create_or_update(device_name, name, resource_group_name, encrypted_password=None, share_access_rights=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

encrypted_password

AsymmetricEncryptedSecret

default value: None

The password details.

share_access_rights

list[ShareAccessRight]

default value: None

List of shares that the user has rights on. This field should not be specified during user creation.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns User or ClientRawResponse if raw==True

Return type

AzureOperationPoller[User],

AzureOperationPoller[ClientRawResponse[User]]

Exceptions

CloudError

delete

Deletes the user on a databox edge/gateway device.

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

get

Gets the properties of the specified user.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name

str

Required

The device name.

name

str

Required

The user name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

User or ClientRawResponse if raw=true

Return type

User,

ClientRawResponse

Exceptions

CloudError

list_by_data_box_edge_device

Gets all the users registered on a data box edge/gateway device.

list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of User

Return type

UserPaged[User]

Exceptions

CloudError

Attributes

models

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