Orders interface

Package:

@azure/arm-databoxedge

Interface representing a Orders.

Methods

beginCreateOrUpdate(string, string, Order, OrdersCreateOrUpdateOptionalParams)	Creates or updates an order.
beginCreateOrUpdateAndWait(string, string, Order, OrdersCreateOrUpdateOptionalParams)	Creates or updates an order.
beginDelete(string, string, OrdersDeleteOptionalParams)	Deletes the order related to the device.
beginDeleteAndWait(string, string, OrdersDeleteOptionalParams)	Deletes the order related to the device.
get(string, string, OrdersGetOptionalParams)	Gets a specific order by name.
listByDataBoxEdgeDevice(string, string, OrdersListByDataBoxEdgeDeviceOptionalParams)	Lists all the orders related to a Data Box Edge/Data Box Gateway device.
listDCAccessCode(string, string, OrdersListDCAccessCodeOptionalParams)	Gets the DCAccess Code

Method Details

beginCreateOrUpdate(string, string, Order, OrdersCreateOrUpdateOptionalParams)

Creates or updates an order.

function beginCreateOrUpdate(deviceName: string, resourceGroupName: string, order: Order, options?: OrdersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Order>, Order>>

Parameters

deviceName

string

The order details of a device.

resourceGroupName

string

The resource group name.

order

Order

The order to be created or updated.

options

OrdersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Order>, Order>>

beginCreateOrUpdateAndWait(string, string, Order, OrdersCreateOrUpdateOptionalParams)

Creates or updates an order.

function beginCreateOrUpdateAndWait(deviceName: string, resourceGroupName: string, order: Order, options?: OrdersCreateOrUpdateOptionalParams): Promise<Order>

Parameters

deviceName

string

The order details of a device.

resourceGroupName

string

The resource group name.

order

Order

The order to be created or updated.

options

OrdersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Order>

beginDelete(string, string, OrdersDeleteOptionalParams)

Deletes the order related to the device.

function beginDelete(deviceName: string, resourceGroupName: string, options?: OrdersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

OrdersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, OrdersDeleteOptionalParams)

Deletes the order related to the device.

function beginDeleteAndWait(deviceName: string, resourceGroupName: string, options?: OrdersDeleteOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

OrdersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, OrdersGetOptionalParams)

Gets a specific order by name.

function get(deviceName: string, resourceGroupName: string, options?: OrdersGetOptionalParams): Promise<Order>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

OrdersGetOptionalParams

The options parameters.

Returns

Promise<Order>

listByDataBoxEdgeDevice(string, string, OrdersListByDataBoxEdgeDeviceOptionalParams)

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

function listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: OrdersListByDataBoxEdgeDeviceOptionalParams): PagedAsyncIterableIterator<Order, Order[], PageSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

OrdersListByDataBoxEdgeDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Order, Order[], PageSettings>

listDCAccessCode(string, string, OrdersListDCAccessCodeOptionalParams)

Gets the DCAccess Code

function listDCAccessCode(deviceName: string, resourceGroupName: string, options?: OrdersListDCAccessCodeOptionalParams): Promise<DCAccessCode>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name.

options

OrdersListDCAccessCodeOptionalParams

The options parameters.

Returns

Promise<DCAccessCode>