OrdersOperations Class

OrdersOperations operations.

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

api_version

The API version. Constant value: "2019-03-01".

Methods

create_or_update	Creates or updates an order.
delete	Deletes the order related to the device.
get	Gets a specific order by name.
list_by_data_box_edge_device	Lists all the orders related to a data box edge/gateway device.

create_or_update

Creates or updates an order.

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

Parameters

device_name

str

Required

The device name.

order

Order

Required

The order to be created or updated.

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

Return type

AzureOperationPoller[Order],

AzureOperationPoller[ClientRawResponse[Order]]

Exceptions

CloudError

delete

Deletes the order related to the device.

delete(device_name, resource_group_name, custom_headers=None, raw=False, polling=True, **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

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

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

Order or ClientRawResponse if raw=true

Return type

Order,

ClientRawResponse

Exceptions

CloudError

list_by_data_box_edge_device

Lists all the orders related to 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 Order

Return type

OrderPaged[Order]

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