RolesOperations Class

RolesOperations operations.

Inheritance

builtins.object

RolesOperations

Constructor

RolesOperations(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	Create or update a role.
delete	Deletes the role on the data box edge device.
get	Gets a specific role by name.
list_by_data_box_edge_device	Lists all the roles configured in a data box edge/gateway device.

create_or_update

Create or update a role.

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

Parameters

device_name

str

Required

The device name.

name

str

Required

The role name.

role

Role

Required

The role properties.

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 Role or ClientRawResponse if raw==True

Return type

AzureOperationPoller[Role],

AzureOperationPoller[ClientRawResponse[Role]]

Exceptions

CloudError

delete

Deletes the role on the data box edge 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 role 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 a specific role by name.

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

Role or ClientRawResponse if raw=true

Return type

Role,

ClientRawResponse

Exceptions

CloudError

list_by_data_box_edge_device

Lists all the roles configured in 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 Role

Return type

RolePaged[Role]

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