UsersOperations Class

UsersOperations operations.

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

Name	Description
device_name Required	str The device name.
name Required	str The user name.
resource_group_name Required	str The resource group name.
encrypted_password	AsymmetricEncryptedSecret The password details. default value: None
share_access_rights	list[ShareAccessRight] List of shares that the user has rights on. This field should not be specified during user creation. default value: None
custom_headers	dict headers that will be added to the request default value: None
raw	bool The poller return type is ClientRawResponse, the direct response alongside the deserialized response default value: False
polling	True for ARMPolling, False for no polling, or a polling object for personal polling strategy default value: True

Returns

Type	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[User], <xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[User]]	An instance of LROPoller that returns User or ClientRawResponse if raw==True

Exceptions

Type	Description
msrestazure.azure_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

Name	Description
device_name Required	str The device name.
name Required	str The user name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool The poller return type is ClientRawResponse, the direct response alongside the deserialized response default value: False
polling	True for ARMPolling, False for no polling, or a polling object for personal polling strategy default value: True

Returns

Type	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[None], <xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[None]]	An instance of LROPoller that returns None or ClientRawResponse if raw==True

Exceptions

Type	Description
msrestazure.azure_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

Name	Description
device_name Required	str The device name.
name Required	str The user name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
User, <xref:msrest.pipeline.ClientRawResponse>	User or ClientRawResponse if raw=true

Exceptions

Type	Description
msrestazure.azure_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

Name	Description
device_name Required	str The device name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
UserPaged[User]	An iterator like instance of User

Exceptions

Type	Description
msrestazure.azure_exceptions.CloudError

Attributes

models

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