@azure/arm-edgeorder package

Classes

EdgeOrderClient

Interfaces

AdditionalConfiguration	Additional Configuration details.
AddressDetails	Address details for an order item.
AddressProperties	Address Properties.
AddressResource	Address Resource.
AddressUpdateParameter	The Address update parameters.
AddressUpdateProperties	Address Update Properties.
AddressesCreateOptionalParams	Optional parameters.
AddressesDeleteOptionalParams	Optional parameters.
AddressesGetOptionalParams	Optional parameters.
AddressesListByResourceGroupOptionalParams	Optional parameters.
AddressesListBySubscriptionOptionalParams	Optional parameters.
AddressesOperations	Interface representing a Addresses operations.
AddressesUpdateOptionalParams	Optional parameters.
AvailabilityInformation	Availability information of a product system.
BasicInformation	Basic information for any product system.
BillingMeterDetails	Holds billing meter details for each type of billing.
CancellationReason	Reason for cancellation.
CategoryInformation	Category related properties of a child configuration.
ChildConfiguration	Child configuration object.
ChildConfigurationFilter	Child configuration filter.
ChildConfigurationProperties	Properties of child configuration.
CommonProperties	Represents common properties across product hierarchy.
Configuration	Configuration object.
ConfigurationDeviceDetails	Device details for configuration.
ConfigurationFilter	Configuration filters.
ConfigurationProperties	Properties of configuration.
ConfigurationsRequest	Configuration request object.
ContactDetails	Contact Details.
CostInformation	Cost information for the product system.
CustomerSubscriptionDetails	Holds Customer subscription details. Clients can display available products to unregistered customers by explicitly passing subscription details.
CustomerSubscriptionRegisteredFeatures	Represents subscription registered features.
Description	Description related properties of a product system.
DeviceDetails	Device details.
DevicePresenceVerificationDetails	Proof of possession details.
Dimensions	Dimensions of a configuration.
DisplayInfo	Describes product display information.
EdgeOrderClientOptionalParams	Optional parameters for the client.
EncryptionPreferences	Preferences related to the double encryption.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FilterableProperty	Different types of filters supported and its values.
ForwardShippingDetails	Forward shipment details.
GroupedChildConfigurations	Grouped child configuration object.
HierarchyInformation	Holds details about product hierarchy information.
ImageInformation	Image for the product.
Link	Returns link related to the product.
ManagementResourcePreferences	Management resource preference to link device.
MeterDetails	Holds details about billing type and its meter guids.
NotificationPreference	Notification preference for a job stage.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OrderItemDetails	Order item details.
OrderItemDetailsUpdateParameter	Order item details Patchable Properties.
OrderItemProperties	Represents order item properties.
OrderItemResource	Represents order item resource.
OrderItemUpdateParameter	Updates order item parameters.
OrderItemUpdateProperties	Order item update properties.
OrderItemsCancelOptionalParams	Optional parameters.
OrderItemsCreateOptionalParams	Optional parameters.
OrderItemsDeleteOptionalParams	Optional parameters.
OrderItemsGetOptionalParams	Optional parameters.
OrderItemsListByResourceGroupOptionalParams	Optional parameters.
OrderItemsListBySubscriptionOptionalParams	Optional parameters.
OrderItemsOperations	Interface representing a OrderItems operations.
OrderItemsReturnOptionalParams	Optional parameters.
OrderItemsUpdateOptionalParams	Optional parameters.
OrderProperties	Represents order details.
OrderResource	Specifies the properties or parameters for an order. Order is a grouping of one or more order items.
OrdersGetOptionalParams	Optional parameters.
OrdersListByResourceGroupOptionalParams	Optional parameters.
OrdersListBySubscriptionOptionalParams	Optional parameters.
OrdersOperations	Interface representing a Orders operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Pav2MeterDetails	Billing type PAV2 meter details.
Preferences	Preferences related to the order.
Product	Represents a product.
ProductDetails	Represents product details.
ProductDetailsUpdateParameter	Represents product details patchable properties.
ProductFamiliesMetadataDetails	Product families metadata details.
ProductFamiliesRequest	The filters for showing the product families.
ProductFamily	Product Family.
ProductFamilyProperties	Properties of product family.
ProductLine	Product line.
ProductLineProperties	Properties of product line.
ProductProperties	Properties of product.
ProductsAndConfigurationsListConfigurationsOptionalParams	Optional parameters.
ProductsAndConfigurationsListProductFamiliesMetadataOptionalParams	Optional parameters.
ProductsAndConfigurationsListProductFamiliesOptionalParams	Optional parameters.
ProductsAndConfigurationsOperations	Interface representing a ProductsAndConfigurations operations.
ProvisioningDetails	Details Related To Provision Resource.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PurchaseMeterDetails	Billing type Purchase meter details.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceIdentity	Msi identity details of the resource
ResourceProviderDetails	Management RP details.
RestorePollerOptions
ReturnOrderItemDetails	Return order item request body.
ReverseShippingDetails	Reverse shipment details.
ShippingAddress	Shipping address where customer wishes to receive the device.
SiteDetails	Represents Site Related Details.
Specification	Specification of the configurations.
StageDetails	Resource stage details.
SystemData	Metadata pertaining to creation and last modification of the resource.
TermCommitmentInformation	Term Commitment Information.
TermCommitmentPreferences	Term Commitment preference received from customer.
TermTypeDetails	Holds details about term type and duration.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TransportPreferences	Preferences related to the shipment logistics of the sku.
UserAssignedIdentity	User assigned identity properties

Type Aliases

ActionStatusEnum	Describes whether the order item is deletable or not. KnownActionStatusEnum can be used interchangeably with ActionStatusEnum, this enum contains the known values that the service supports. Known values supported by the service Allowed: Allowed flag. NotAllowed: Not Allowed flag.
ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AddressClassification	Type of address based on its usage context. KnownAddressClassification can be used interchangeably with AddressClassification, this enum contains the known values that the service supports. Known values supported by the service Shipping: Shipping address for the order. Site: Site Address.
AddressType	Type of address. KnownAddressType can be used interchangeably with AddressType, this enum contains the known values that the service supports. Known values supported by the service None: Address type not known. Residential: Residential Address. Commercial: Commercial Address.
AddressValidationStatus	Status of address validation. KnownAddressValidationStatus can be used interchangeably with AddressValidationStatus, this enum contains the known values that the service supports. Known values supported by the service Valid: Address provided is valid. Invalid: Address provided is invalid or not supported. Ambiguous: Address provided is ambiguous, please choose one of the alternate addresses returned.
AutoProvisioningStatus	Auto Provisioning Details. KnownAutoProvisioningStatus can be used interchangeably with AutoProvisioningStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. Disabled: Provisioning Disabled.
AvailabilityStage	Current availability stage of the product. KnownAvailabilityStage can be used interchangeably with AvailabilityStage, this enum contains the known values that the service supports. Known values supported by the service Available: Product is available. Preview: Product is in preview. Signup: Product is available only on signup. Discoverable: Product is not available in our service but can be discovered from other sources. ComingSoon: Product is coming soon. Unavailable: Product is not available. Deprecated: Product is deprecated.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BillingType	Represents billing type. KnownBillingType can be used interchangeably with BillingType, this enum contains the known values that the service supports. Known values supported by the service Pav2: PaV2 billing. Purchase: Purchase billing.
ChargingType	Charging type. KnownChargingType can be used interchangeably with ChargingType, this enum contains the known values that the service supports. Known values supported by the service PerOrder: Per order charging type. PerDevice: Per device charging type.
ChildConfigurationType	Type of ChildConfigurationType
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DescriptionType	Type of description. KnownDescriptionType can be used interchangeably with DescriptionType, this enum contains the known values that the service supports. Known values supported by the service Base: Base description.
DevicePresenceVerificationStatus	Proof of possession status. KnownDevicePresenceVerificationStatus can be used interchangeably with DevicePresenceVerificationStatus, this enum contains the known values that the service supports. Known values supported by the service NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. Completed: Confirms that the device is verified to be with the right edge operator or at the right location.
DisabledReason	Reason why the product is disabled. KnownDisabledReason can be used interchangeably with DisabledReason, this enum contains the known values that the service supports. Known values supported by the service None: Not disabled. Country: Not available in the requested country. Region: Not available to push data to the requested Azure region. Feature: Required features are not enabled. OfferType: Subscription does not have required offer types. NoSubscriptionInfo: Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification. NotAvailable: The product is not yet available. OutOfStock: The product is out of stock.
DoubleEncryptionStatus	Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. KnownDoubleEncryptionStatus can be used interchangeably with DoubleEncryptionStatus, this enum contains the known values that the service supports. Known values supported by the service Disabled: Double encryption is disabled. Enabled: Double encryption is enabled.
FulfillmentType	The entity responsible for fulfillment of the item at the given hierarchy level. KnownFulfillmentType can be used interchangeably with FulfillmentType, this enum contains the known values that the service supports. Known values supported by the service Microsoft: The fulfillment (the whole journey of the product offering) is handled by microsoft. External: The fulfillment (the whole journey of the product offering) is handled by external third party entities.
IdentificationType	Identification type of the configuration. KnownIdentificationType can be used interchangeably with IdentificationType, this enum contains the known values that the service supports. Known values supported by the service NotSupported: Product does not have any explicit identifier. SerialNumber: Product is identifiable by serial number.
ImageType	Type of the image. KnownImageType can be used interchangeably with ImageType, this enum contains the known values that the service supports. Known values supported by the service MainImage: Main image. BulletImage: Bullet image. GenericImage: Generic image.
LengthHeightUnit	Unit for the dimensions of length, height and width. KnownLengthHeightUnit can be used interchangeably with LengthHeightUnit, this enum contains the known values that the service supports. Known values supported by the service IN: Inch, applicable for West US. CM: Centimeter.
LinkType	Type of link. KnownLinkType can be used interchangeably with LinkType, this enum contains the known values that the service supports. Known values supported by the service Generic: Generic link. TermsAndConditions: Terms and conditions link. Specification: Link to product specification. Documentation: Link to product documentation. KnowMore: Link to know more. SignUp: Link to sign up for products. Discoverable: Link to order the product from another source and not from Azure Edge Hardware Center.
MeterDetailsUnion	Alias for MeterDetailsUnion
MeteringType	Represents Metering type (eg one-time or recurrent). KnownMeteringType can be used interchangeably with MeteringType, this enum contains the known values that the service supports. Known values supported by the service OneTime: One time billing. Recurring: Recurring billing. Adhoc: Adhoc billing.
NotificationStageName	Name of the stage. KnownNotificationStageName can be used interchangeably with NotificationStageName, this enum contains the known values that the service supports. Known values supported by the service Shipped: Notification at order item shipped from microsoft datacenter. Delivered: Notification at order item delivered to customer.
OrderItemCancellationEnum	Describes whether the order item is cancellable or not. KnownOrderItemCancellationEnum can be used interchangeably with OrderItemCancellationEnum, this enum contains the known values that the service supports. Known values supported by the service Cancellable: Order item can be cancelled without fee. CancellableWithFee: Order item can be cancelled with fee. NotCancellable: Order item not cancellable.
OrderItemReturnEnum	Describes whether the order item is returnable or not. KnownOrderItemReturnEnum can be used interchangeably with OrderItemReturnEnum, this enum contains the known values that the service supports. Known values supported by the service Returnable: Order item can be returned without fee. ReturnableWithFee: Order item can be returned with fee. NotReturnable: Order item not returnable.
OrderItemType	Order item type. KnownOrderItemType can be used interchangeably with OrderItemType, this enum contains the known values that the service supports. Known values supported by the service Purchase: Purchase OrderItem. Rental: Rental OrderItem. External: Orders placed outside of azure.
OrderMode	Defines the mode of the Order item. KnownOrderMode can be used interchangeably with OrderMode, this enum contains the known values that the service supports. Known values supported by the service Default: Default Order mode. DoNotFulfill: Mode in which the Order will not be fulfilled.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	Provisioning state KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating: Creating state. Succeeded: Succeeded state. Failed: Failed state. Canceled: Canceled state.
ProvisioningSupport	Determining nature of provisioning that the configuration supports. KnownProvisioningSupport can be used interchangeably with ProvisioningSupport, this enum contains the known values that the service supports. Known values supported by the service CloudBased: The configuration can be provisioned from the cloud. Manual: The configuration need to be provisioned manually by the end user.
StageName	Stage name. KnownStageName can be used interchangeably with StageName, this enum contains the known values that the service supports. Known values supported by the service Placed: Currently in draft mode and can still be cancelled. InReview: Order is currently in draft mode and can still be cancelled. Confirmed: Order is confirmed. ReadyToShip: Order is ready to ship. Shipped: Order is in transit to customer. Delivered: Order is delivered to customer. ReadyToSetup: Order is ready to get cloud connected. InUse: Order is in use at customer site. ReturnInitiated: Return has been initiated by customer. ReturnPickedUp: Order is in transit from customer to Microsoft. ReturnedToMicrosoft: Order has been received back to Microsoft. ReturnCompleted: Return has now completed. Cancelled: Order has been cancelled.
StageStatus	Stage status. KnownStageStatus can be used interchangeably with StageStatus, this enum contains the known values that the service supports. Known values supported by the service None: No status available yet. InProgress: Stage is in progress. Succeeded: Stage has succeeded. Failed: Stage has failed. Cancelled: Stage has been cancelled. Cancelling: Stage is cancelling.
SupportedFilterTypes	Type of product filter. KnownSupportedFilterTypes can be used interchangeably with SupportedFilterTypes, this enum contains the known values that the service supports. Known values supported by the service ShipToCountries: Ship to country. DoubleEncryptionStatus: Double encryption status.
TermCommitmentType	Term Commitment Type KnownTermCommitmentType can be used interchangeably with TermCommitmentType, this enum contains the known values that the service supports. Known values supported by the service None: Pay as you go Term Commitment Model. Trial: Trial Term Commitment Model. Timed: Time based Term Commitment Model.
TransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred. KnownTransportShipmentTypes can be used interchangeably with TransportShipmentTypes, this enum contains the known values that the service supports. Known values supported by the service CustomerManaged: Shipment Logistics is handled by the customer. MicrosoftManaged: Shipment Logistics is handled by Microsoft.
WeightMeasurementUnit	Unit for the dimensions of weight. KnownWeightMeasurementUnit can be used interchangeably with WeightMeasurementUnit, this enum contains the known values that the service supports. Known values supported by the service LBS: Pounds. KGS: Kilograms.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionStatusEnum	Describes whether the order item is deletable or not.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAddressClassification	Type of address based on its usage context.
KnownAddressType	Type of address.
KnownAddressValidationStatus	Status of address validation.
KnownAutoProvisioningStatus	Auto Provisioning Details.
KnownAvailabilityStage	Current availability stage of the product.
KnownBillingType	Represents billing type.
KnownChargingType	Charging type.
KnownChildConfigurationType	Known values of ChildConfigurationType that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownDescriptionType	Type of description.
KnownDevicePresenceVerificationStatus	Proof of possession status.
KnownDisabledReason	Reason why the product is disabled.
KnownDoubleEncryptionStatus	Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
KnownFulfillmentType	The entity responsible for fulfillment of the item at the given hierarchy level.
KnownIdentificationType	Identification type of the configuration.
KnownImageType	Type of the image.
KnownLengthHeightUnit	Unit for the dimensions of length, height and width.
KnownLinkType	Type of link.
KnownMeteringType	Represents Metering type (eg one-time or recurrent).
KnownNotificationStageName	Name of the stage.
KnownOrderItemCancellationEnum	Describes whether the order item is cancellable or not.
KnownOrderItemReturnEnum	Describes whether the order item is returnable or not.
KnownOrderItemType	Order item type.
KnownOrderMode	Defines the mode of the Order item.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state
KnownProvisioningSupport	Determining nature of provisioning that the configuration supports.
KnownStageName	Stage name.
KnownStageStatus	Stage status.
KnownSupportedFilterTypes	Type of product filter.
KnownTermCommitmentType	Term Commitment Type
KnownTransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred.
KnownVersions	The available API versions.
KnownWeightMeasurementUnit	Unit for the dimensions of weight.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(EdgeOrderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(EdgeOrderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: EdgeOrderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

EdgeOrderClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor