OrdersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataBoxEdgeManagementClient's

<xref:orders> attribute.

Constructor

OrdersOperations(*args, **kwargs)

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: _models.Order, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Order]

Parameters

Name Description
device_name
Required
str

The order details of a device. Required.

resource_group_name
Required
str

The resource group name. Required.

order
Required
Order or IO[bytes]

The order to be created or updated. Is either a Order type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either Order or the result of cls(response)

Exceptions

Type Description

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: Any) -> AsyncLROPoller[None]

Parameters

Name Description
device_name
Required
str

The device name. Required.

resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

get

Gets a specific order by name.

Gets a specific order by name.

async get(device_name: str, resource_group_name: str, **kwargs: Any) -> Order

Parameters

Name Description
device_name
Required
str

The device name. Required.

resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description

Order or the result of cls(response)

Exceptions

Type Description

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: Any) -> AsyncIterable[Order]

Parameters

Name Description
device_name
Required
str

The device name. Required.

resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>