@azure/arm-edgeorder package

Additional Configuration details.

Address details for an order item.

Address Properties.

Address Resource.

The Address update parameters.

Address Update Properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Addresses operations.

Optional parameters.

Availability information of a product system.

Basic information for any product system.

Holds billing meter details for each type of billing.

Reason for cancellation.

Category related properties of a child configuration.

Child configuration object.

Child configuration filter.

Properties of child configuration.

Represents common properties across product hierarchy.

Configuration object.

Device details for configuration.

Configuration filters.

Properties of configuration.

Configuration request object.

Contact Details.

Cost information for the product system.

Holds Customer subscription details. Clients can display available products to unregistered customers by explicitly passing subscription details.

Represents subscription registered features.

Description related properties of a product system.

Device details.

Proof of possession details.

Dimensions of a configuration.

Describes product display information.

Optional parameters for the client.

Preferences related to the double encryption.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Different types of filters supported and its values.

Forward shipment details.

Grouped child configuration object.

Holds details about product hierarchy information.

Image for the product.

Returns link related to the product.

Management resource preference to link device.

Holds details about billing type and its meter guids.

Notification preference for a job stage.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for an operation.

Optional parameters.

Interface representing a Operations operations.

Order item details.

Order item details Patchable Properties.

Represents order item properties.

Represents order item resource.

Updates order item parameters.

Order item update properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a OrderItems operations.

Optional parameters.

Optional parameters.

Represents order details.

Specifies the properties or parameters for an order. Order is a grouping of one or more order items.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Orders operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

Billing type PAV2 meter details.

Preferences related to the order.

Represents a product.

Represents product details.

Represents product details patchable properties.

Product families metadata details.

The filters for showing the product families.

Product Family.

Properties of product family.

Product line.

Properties of product line.

Properties of product.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ProductsAndConfigurations operations.

Details Related To Provision Resource.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Billing type Purchase meter details.

Common fields that are returned in the response for all Azure Resource Manager resources

Msi identity details of the resource

Management RP details.

Return order item request body.

Reverse shipment details.

Shipping address where customer wishes to receive the device.

Represents Site Related Details.

Specification of the configurations.

Resource stage details.

Metadata pertaining to creation and last modification of the resource.

Term Commitment Information.

Term Commitment preference received from customer.

Holds details about term type and duration.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Preferences related to the shipment logistics of the sku.

User assigned identity properties

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.

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.

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.

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.

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.

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.

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.

The supported values for cloud setting as a string literal type

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.

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.

Type of ChildConfigurationType

An interface that describes a page of results.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Alias for MeterDetailsUnion

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

An enum to describe Azure Cloud environments.

Describes whether the order item is deletable or not.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Type of address based on its usage context.

Type of address.

Status of address validation.

Auto Provisioning Details.

Current availability stage of the product.

Represents billing type.

Charging type.

Known values of ChildConfigurationType that the service accepts.

The kind of entity that created the resource.

Type of description.

Proof of possession status.

Reason why the product is disabled.

Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.

The entity responsible for fulfillment of the item at the given hierarchy level.

Identification type of the configuration.

Type of the image.

Unit for the dimensions of length, height and width.

Type of link.

Represents Metering type (eg one-time or recurrent).

Name of the stage.

Describes whether the order item is cancellable or not.

Describes whether the order item is returnable or not.

Order item type.

Defines the mode of the Order item.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Provisioning state

Determining nature of provisioning that the configuration supports.

Stage name.

Stage status.

Type of product filter.

Term Commitment Type

Indicates Shipment Logistics type that the customer preferred.

The available API versions.

Unit for the dimensions of weight.

Typeguard for RestError

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.

A custom error type for failed pipeline requests.