OrderItemsOperations interface

Package:

@azure/arm-edgeorder

Interface representing a OrderItems operations.

Properties

cancel	Cancel order item.
create	Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
delete	Delete an order item.
get	Get an order item.
listByResourceGroup	List order items at resource group level.
listBySubscription	List order items at subscription level.
return	Return order item.
update	Update the properties of an existing order item.

Property Details

cancel

Cancel order item.

cancel: (resourceGroupName: string, orderItemName: string, cancellationReason: CancellationReason, options?: OrderItemsCancelOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, orderItemName: string, cancellationReason: CancellationReason, options?: OrderItemsCancelOptionalParams) => Promise<void>

create

Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.

create: (resourceGroupName: string, orderItemName: string, orderItemResource: OrderItemResource, options?: OrderItemsCreateOptionalParams) => PollerLike<OperationState<OrderItemResource>, OrderItemResource>

Property Value

(resourceGroupName: string, orderItemName: string, orderItemResource: OrderItemResource, options?: OrderItemsCreateOptionalParams) => PollerLike<OperationState<OrderItemResource>, OrderItemResource>

delete

Delete an order item.

delete: (resourceGroupName: string, orderItemName: string, options?: OrderItemsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, orderItemName: string, options?: OrderItemsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get an order item.

get: (resourceGroupName: string, orderItemName: string, options?: OrderItemsGetOptionalParams) => Promise<OrderItemResource>

Property Value

(resourceGroupName: string, orderItemName: string, options?: OrderItemsGetOptionalParams) => Promise<OrderItemResource>

listByResourceGroup

List order items at resource group level.

listByResourceGroup: (resourceGroupName: string, options?: OrderItemsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OrderItemResource, OrderItemResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: OrderItemsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OrderItemResource, OrderItemResource[], PageSettings>

listBySubscription

List order items at subscription level.

listBySubscription: (options?: OrderItemsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OrderItemResource, OrderItemResource[], PageSettings>

Property Value

(options?: OrderItemsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OrderItemResource, OrderItemResource[], PageSettings>

return

Return order item.

return: (resourceGroupName: string, orderItemName: string, returnOrderItemDetails: ReturnOrderItemDetails, options?: OrderItemsReturnOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, orderItemName: string, returnOrderItemDetails: ReturnOrderItemDetails, options?: OrderItemsReturnOptionalParams) => PollerLike<OperationState<void>, void>

update

Update the properties of an existing order item.

update: (resourceGroupName: string, orderItemName: string, orderItemUpdateParameter: OrderItemUpdateParameter, options?: OrderItemsUpdateOptionalParams) => PollerLike<OperationState<OrderItemResource>, OrderItemResource>

Property Value

(resourceGroupName: string, orderItemName: string, orderItemUpdateParameter: OrderItemUpdateParameter, options?: OrderItemsUpdateOptionalParams) => PollerLike<OperationState<OrderItemResource>, OrderItemResource>