OrdersOperations Class

OrdersOperations 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.object
OrdersOperations

Constructor

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

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Creates or updates an order.

Creates or updates an order.

begin_delete

Deletes the order related to the device.

Deletes the order related to the device.

get

Gets a specific order by name.

Gets a specific order by name.

list_by_data_box_edge_device

Lists all the orders related to a Data Box Edge/Data Box Gateway device.

Lists all the orders related to a Data Box Edge/Data Box Gateway device.

begin_create_or_update

Creates or updates an order.

Creates or updates an order.

async begin_create_or_update(device_name: str, resource_group_name: str, order: azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.Order, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.Order]

Parameters

device_name
str
Required

The order details of a device.

resource_group_name
str
Required

The resource group name.

order
Order
Required

The order to be created or updated.

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 Order or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes the order related to the device.

Deletes the order related to the device.

async begin_delete(device_name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

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 order by name.

Gets a specific order by name.

async get(device_name: str, resource_group_name: str, **kwargs) -> azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.Order

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

A custom type or function that will be passed the direct response

Returns

Order, or the result of cls(response)

Return type

Exceptions

list_by_data_box_edge_device

Lists all the orders related to a Data Box Edge/Data Box Gateway device.

Lists all the orders related to 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.databoxedge.v2020_05_01_preview.models._models_py3.OrderList]

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OrderList or the result of cls(response)

Return type

Exceptions

Attributes

models

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