RolesOperations Class

RolesOperations 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

RolesOperations

Constructor

RolesOperations(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	Create or update a role.
begin_delete	Deletes the role on the device.
get	Gets a specific role by name.
list_by_data_box_edge_device	Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

begin_create_or_update

Create or update a role.

begin_create_or_update(device_name: str, name: str, resource_group_name: str, role: '_models.Role', **kwargs: Any) -> LROPoller['_models.Role']

Parameters

Name	Description
device_name Required	str The device name.
name Required	str The role name.
resource_group_name Required	str The resource group name.
role Required	Role The role properties.

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 PollingMethod Pass in True if you'd like the ARMPolling 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
LROPoller[Role]	An instance of LROPoller that returns either Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the role on the device.

begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
device_name Required	str The device name.
name Required	str The role 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 PollingMethod Pass in True if you'd like the ARMPolling 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
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a specific role by name.

get(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> _models.Role

Parameters

Name	Description
device_name Required	str The device name.
name Required	str The role 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
Role	Role, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_data_box_edge_device

Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

list_by_data_box_edge_device(device_name: str, resource_group_name: str, **kwargs: Any) -> Iterable['_models.RoleList']

Parameters

Name	Description
device_name Required	str The device 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
ItemPaged[RoleList]	An iterator like instance of either RoleList 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'>