RolesOperations Class
RolesOperations 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.objectRolesOperations
Constructor
RolesOperations(client, config, serializer, deserializer)
Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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.
async begin_create_or_update(device_name: str, name: str, resource_group_name: str, role: azure.mgmt.datab.models._models_py3.Role, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datab.models._models_py3.Role]
Parameters
- role
- <xref:azure.mgmt.databoxedge.v2020_12_01.models.Role>
The role properties.
- 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 Role or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the role on the device.
async begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]
Parameters
- 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
Exceptions
get
Gets a specific role by name.
async get(device_name: str, name: str, resource_group_name: str, **kwargs) -> azure.mgmt.datab.models._models_py3.Role
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Role, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.datab.models._models_py3.RoleList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RoleList or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.datab.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datab\\models\\__init__.py'>
Feedback
Submit and view feedback for