Microsoft.EdgeOrder (preview:2022-05-01)

2025/08/07 • 21 new, 21 deleted methods

Operations_List (new)
Description :  List all the supported operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EdgeOrder/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_ListBySubscription (new)
Description :  List all the addresses available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on shipping address properties. Filter supports only equals operation. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of address resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListConfigurations (new)
Description :  List configurations for the given product family, product line and product for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of configurations, which provides the next page in the list of configurations. ,
Required: False ,
}
string ,
configurationsRequest:
{
Description: Filters for showing the configurations. ,
Required: True ,
}
{
configurationFilter:
{
Description: Holds details about product hierarchy information and filterable property. ,
Required: False ,
}
{
hierarchyInformation:
{
Description: Product hierarchy information. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
filterableProperty:
{
Description: Filters specific to product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
childConfigurationFilter:
{
Description: Filter to fetch specific child configurations that exist in the configuration. This must be passed to either fetch a list of specific child configurations, or all child configurations of specific types of child configurations. ,
Required: False ,
}
{
hierarchyInformations:
{
Description: The list of child configuration hierarchy customer wants to filter for the given configuration. ,
Required: False ,
}
[
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
]
,
childConfigurationTypes:
{
Description: Filter to fetch all child configurations belonging to the given list of configuration types. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
customerSubscriptionDetails:
{
Description: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details. ,
Required: False ,
}
{
registeredFeatures:
{
Description: List of registered feature flags for subscription. ,
Required: False ,
}
[
{
name:
{
Description: Name of subscription registered feature. ,
Required: False ,
}
string ,
state:
{
Description: State of subscription registered feature. ,
Required: False ,
}
string ,
}
,
]
,
locationPlacementId:
{
Description: Location placement Id of a subscription. ,
Required: False ,
}
string ,
quotaId:
{
Description: Quota ID of a subscription. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of configurations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListProductFamilies (new)
Description :  List product families for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on configurations parameter for product, which provides details on the configurations for the product. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of product families, which provides the next page in the list of product families. ,
Required: False ,
}
string ,
productFamiliesRequest:
{
Description: Filters for showing the product families. ,
Required: True ,
}
{
filterableProperties:
{
Description: Dictionary of filterable properties on product family. ,
Required: True ,
}
object ,
customerSubscriptionDetails:
{
Description: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details. ,
Required: False ,
}
{
registeredFeatures:
{
Description: List of registered feature flags for subscription. ,
Required: False ,
}
[
{
name:
{
Description: Name of subscription registered feature. ,
Required: False ,
}
string ,
state:
{
Description: State of subscription registered feature. ,
Required: False ,
}
string ,
}
,
]
,
locationPlacementId:
{
Description: Location placement Id of a subscription. ,
Required: False ,
}
string ,
quotaId:
{
Description: Quota ID of a subscription. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of product families. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product family. ,
Required: False ,
}
{
productLines:
{
Description: List of product lines supported in the product family. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product line. ,
Required: False ,
}
{
products:
{
Description: List of products in the product line. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product. ,
Required: False ,
}
{
configurations:
{
Description: List of configurations for the product. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of product families. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_ListBySubscription (new)
Description :  List order items at subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id. Filter supports only equals operation. ,
Required: False ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order item resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order item resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_ListBySubscription (new)
Description :  List orders at subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListProductFamiliesMetadata (new)
Description :  List product families metadata for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/productFamiliesMetadata
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of product family metadata details. ,
Required: False ,
}
[
{
properties:
{
Description: Product family properties. ,
Required: False ,
}
{
productLines:
{
Description: List of product lines supported in the product family. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product line. ,
Required: False ,
}
{
products:
{
Description: List of products in the product line. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product. ,
Required: False ,
}
{
configurations:
{
Description: List of configurations for the product. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of product families. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_ListByResourceGroup (new)
Description :  List all the addresses available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on shipping address properties. Filter supports only equals operation. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of address resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Get (new)
Description :  Get information about the specified address.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Create (new)
Description :  Create a new address with the specified parameters. Existing address cannot be updated with this API and should instead be updated with the Update address API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
addressResource:
{
Description: Address details from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Delete (new)
Description :  Delete an address.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Update (new)
Description :  Update the properties of an existing address.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. ,
Required: False ,
}
string ,
addressUpdateParameter:
{
Description: Address update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of an address to be updated. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: False ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
tags:
{
Description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_Get (new)
Description :  Get an order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
orderName:
{
Description: The name of the order. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_ListByResourceGroup (new)
Description :  List order items at resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id. Filter supports only equals operation. ,
Required: False ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order item resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order item resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Get (new)
Description :  Get an order item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Create (new)
Description :  Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
orderItemResource:
{
Description: Order item details from request body. ,
Required: True ,
}
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Delete (new)
Description :  Delete an order item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Update (new)
Description :  Update the properties of an existing order item.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value. ,
Required: False ,
}
string ,
orderItemUpdateParameter:
{
Description: Order item update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Order item update properties. ,
Required: False ,
}
{
forwardAddress:
{
Description: Updates forward shipping address and contact details. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
preferences:
{
Description: Customer preference. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Cancel (new)
Description :  Cancel order item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: True ,
}
{
reason:
{
Description: Reason for cancellation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Return (new)
Description :  Return order item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
returnOrderItemDetails:
{
Description: Return order item details. ,
Required: True ,
}
{
returnAddress:
{
Description: Customer return address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnReason:
{
Description: Return Reason. ,
Required: True ,
}
string ,
serviceTag:
{
Description: Service tag (located on the bottom-right corner of the device). ,
Required: False ,
}
string ,
shippingBoxRequired:
{
Description: Shipping Box required. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_ListByResourceGroup (new)
Description :  List orders at resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List all the supported operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EdgeOrder/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_ListBySubscription (removed)
Description :  List all the addresses available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on shipping address properties. Filter supports only equals operation. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of address resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListConfigurations (removed)
Description :  List configurations for the given product family, product line and product for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of configurations, which provides the next page in the list of configurations. ,
Required: False ,
}
string ,
configurationsRequest:
{
Description: Filters for showing the configurations. ,
Required: True ,
}
{
configurationFilter:
{
Description: Holds details about product hierarchy information and filterable property. ,
Required: False ,
}
{
hierarchyInformation:
{
Description: Product hierarchy information. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
filterableProperty:
{
Description: Filters specific to product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
childConfigurationFilter:
{
Description: Filter to fetch specific child configurations that exist in the configuration. This must be passed to either fetch a list of specific child configurations, or all child configurations of specific types of child configurations. ,
Required: False ,
}
{
hierarchyInformations:
{
Description: The list of child configuration hierarchy customer wants to filter for the given configuration. ,
Required: False ,
}
[
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
]
,
childConfigurationTypes:
{
Description: Filter to fetch all child configurations belonging to the given list of configuration types. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
customerSubscriptionDetails:
{
Description: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details. ,
Required: False ,
}
{
registeredFeatures:
{
Description: List of registered feature flags for subscription. ,
Required: False ,
}
[
{
name:
{
Description: Name of subscription registered feature. ,
Required: False ,
}
string ,
state:
{
Description: State of subscription registered feature. ,
Required: False ,
}
string ,
}
,
]
,
locationPlacementId:
{
Description: Location placement Id of a subscription. ,
Required: False ,
}
string ,
quotaId:
{
Description: Quota ID of a subscription. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of configurations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListProductFamilies (removed)
Description :  List product families for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on configurations parameter for product, which provides details on the configurations for the product. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of product families, which provides the next page in the list of product families. ,
Required: False ,
}
string ,
productFamiliesRequest:
{
Description: Filters for showing the product families. ,
Required: True ,
}
{
filterableProperties:
{
Description: Dictionary of filterable properties on product family. ,
Required: True ,
}
object ,
customerSubscriptionDetails:
{
Description: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details. ,
Required: False ,
}
{
registeredFeatures:
{
Description: List of registered feature flags for subscription. ,
Required: False ,
}
[
{
name:
{
Description: Name of subscription registered feature. ,
Required: False ,
}
string ,
state:
{
Description: State of subscription registered feature. ,
Required: False ,
}
string ,
}
,
]
,
locationPlacementId:
{
Description: Location placement Id of a subscription. ,
Required: False ,
}
string ,
quotaId:
{
Description: Quota ID of a subscription. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of product families. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product family. ,
Required: False ,
}
{
productLines:
{
Description: List of product lines supported in the product family. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product line. ,
Required: False ,
}
{
products:
{
Description: List of products in the product line. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product. ,
Required: False ,
}
{
configurations:
{
Description: List of configurations for the product. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of product families. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_ListBySubscription (removed)
Description :  List order items at subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id. Filter supports only equals operation. ,
Required: False ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order item resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order item resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_ListBySubscription (removed)
Description :  List orders at subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductsAndConfigurations_ListProductFamiliesMetadata (removed)
Description :  List product families metadata for the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/productFamiliesMetadata
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of product family metadata details. ,
Required: False ,
}
[
{
properties:
{
Description: Product family properties. ,
Required: False ,
}
{
productLines:
{
Description: List of product lines supported in the product family. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product line. ,
Required: False ,
}
{
products:
{
Description: List of products in the product line. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of product. ,
Required: False ,
}
{
configurations:
{
Description: List of configurations for the product. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of configuration. ,
Required: False ,
}
{
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
{
categoryInformation:
{
Description: Category information. ,
Required: False ,
}
{
categoryName:
{
Description: Category name of the child configuration. ,
Required: False ,
}
string ,
categoryDisplayName:
{
Description: Category display name of the child configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description text for the category. ,
Required: False ,
}
string ,
links:
{
Description: Links for the category. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
childConfigurations:
{
Description: List of child configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of child configuration. ,
Required: False ,
}
{
childConfigurationType:
{
Description: Child configuration type. ,
Enum:
{
DeviceConfiguration: Child configuration is a device configuration. ,
AdditionalConfiguration: Child configuration is an additional configuration. ,
}
,
Required: False ,
}
enum ,
isPartOfBaseConfiguration:
{
Description: Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. ,
Required: False ,
}
boolean ,
minimumQuantity:
{
Description: Minimum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumQuantity:
{
Description: Maximum quantity a customer can order while choosing this configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
specifications:
{
Description: Specifications of the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification. ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: Dimensions of the configuration. ,
Required: False ,
}
{
length:
{
Description: Length of the device. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the device. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the device. ,
Format: double ,
Required: False ,
}
number ,
lengthHeightUnit:
{
Description: Unit for the dimensions of length, height and width. ,
Enum:
{
IN: Inch, applicable for West US. ,
CM: Centimeter. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: Weight of the device. ,
Format: double ,
Required: False ,
}
number ,
depth:
{
Description: Depth of the device. ,
Format: double ,
Required: False ,
}
number ,
weightUnit:
{
Description: Unit for the dimensions of weight. ,
Enum:
{
LBS: Pounds. ,
KGS: Kilograms. ,
}
,
Required: False ,
}
enum ,
}
,
childConfigurationTypes:
{
Description: Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. ,
Required: False ,
}
[
string ,
]
,
groupedChildConfigurations:
{
Description: Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. ,
Required: False ,
}
[
string ,
]
,
filterableProperties:
{
Description: List of filters supported for a product. ,
Required: False ,
}
[
{
type:
{
Description: Type of product filter. ,
Enum:
{
ShipToCountries: Ship to country. ,
DoubleEncryptionStatus: Double encryption status. ,
}
,
Required: True ,
}
enum ,
supportedValues:
{
Description: Values to be filtered. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
displayName:
{
Description: Display Name for the product system. ,
Required: False ,
}
string ,
description:
{
Description: Description related to the product system. ,
Required: False ,
}
{
descriptionType:
{
Description: Type of description. ,
Enum:
{
Base: Base description. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: Short description of the product system. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description of the product system. ,
Required: False ,
}
string ,
keywords:
{
Description: Keywords for the product system. ,
Required: False ,
}
[
string ,
]
,
attributes:
{
Description: Attributes for the product system. ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Links for the product system. ,
Required: False ,
}
[
{
linkType:
{
Description: Type of link. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
linkUrl:
{
Description: Url of the link. ,
Required: False ,
}
string ,
}
,
]
,
}
,
imageInformation:
{
Description: Image information for the product system. ,
Required: False ,
}
[
{
imageType:
{
Description: Type of the image. ,
Enum:
{
MainImage: Main image. ,
BulletImage: Bullet image. ,
GenericImage: Generic image. ,
}
,
Required: False ,
}
enum ,
imageUrl:
{
Description: Url of the image. ,
Required: False ,
}
string ,
}
,
]
,
costInformation:
{
Description: Cost information for the product system. ,
Required: False ,
}
{
billingMeterDetails:
{
Description: Details on the various billing aspects for the product system. ,
Required: False ,
}
[
{
name:
{
Description: Represents Billing type name. ,
Required: False ,
}
string ,
meterDetails:
{
Description: Represents MeterDetails. ,
Required: False ,
}
{
billingType:
{
Description: Represents billing type. ,
Enum:
{
Pav2: PaV2 billing. ,
Purchase: Purchase billing. ,
}
,
Required: True ,
}
enum ,
multiplier:
{
Description: Billing unit applicable for Pav2 billing. ,
Format: double ,
Required: False ,
}
number ,
chargingType:
{
Description: Charging type. ,
Enum:
{
PerOrder: Per order charging type. ,
PerDevice: Per device charging type. ,
}
,
Required: False ,
}
enum ,
}
,
meteringType:
{
Description: Represents Metering type (eg one-time or recurrent). ,
Enum:
{
OneTime: One time billing. ,
Recurring: Recurring billing. ,
Adhoc: Adhoc billing. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency of recurrence. ,
Required: False ,
}
string ,
}
,
]
,
billingInfoUrl:
{
Description: Default url to display billing information. ,
Required: False ,
}
string ,
}
,
availabilityInformation:
{
Description: Availability information of the product system. ,
Required: False ,
}
{
availabilityStage:
{
Description: Current availability stage of the product. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReason:
{
Description: Reason why the product is disabled. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
disabledReasonMessage:
{
Description: Message for why the product is disabled. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy information of a product. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
fulfilledBy:
{
Description: The entity responsible for fulfillment of the item at the given hierarchy level. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of product families. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_ListByResourceGroup (removed)
Description :  List all the addresses available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on shipping address properties. Filter supports only equals operation. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of address resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Get (removed)
Description :  Get information about the specified address.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Create (removed)
Description :  Create a new address with the specified parameters. Existing address cannot be updated with this API and should instead be updated with the Update address API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
addressResource:
{
Description: Address details from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Delete (removed)
Description :  Delete an address.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addresses_Update (removed)
Description :  Update the properties of an existing address.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
addressName:
{
Description: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. ,
Required: False ,
}
string ,
addressUpdateParameter:
{
Description: Address update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of an address to be updated. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: False ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
tags:
{
Description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_Get (removed)
Description :  Get an order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
orderName:
{
Description: The name of the order. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_ListByResourceGroup (removed)
Description :  List order items at resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id. Filter supports only equals operation. ,
Required: False ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order item resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order item resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Get (removed)
Description :  Get an order item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Create (removed)
Description :  Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
orderItemResource:
{
Description: Order item details from request body. ,
Required: True ,
}
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Delete (removed)
Description :  Delete an order item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Update (removed)
Description :  Update the properties of an existing order item.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value. ,
Required: False ,
}
string ,
orderItemUpdateParameter:
{
Description: Order item update parameters from request body. ,
Required: True ,
}
{
properties:
{
Description: Order item update properties. ,
Required: False ,
}
{
forwardAddress:
{
Description: Updates forward shipping address and contact details. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
preferences:
{
Description: Customer preference. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Unique identifier for configuration. ,
Required: True ,
}
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the product. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
productDoubleEncryptionStatus:
{
Description: Double encryption status of the configuration. Read-only field. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
parentDeviceDetails:
{
Description: Device details of the parent configuration. ,
Required: False ,
}
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
optInAdditionalConfigurations:
{
Description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration. ,
Required: False ,
}
[
{
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: True ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
childConfigurationDeviceDetails:
{
Description: Details of all child configurations that are part of the order item. ,
Required: False ,
}
[
{
displayInfo:
{
Description: Display details of the product. ,
Required: False ,
}
{
productFamilyDisplayName:
{
Description: Product family display name. ,
Required: False ,
}
string ,
configurationDisplayName:
{
Description: Configuration display name. ,
Required: False ,
}
string ,
}
,
hierarchyInformation:
{
Description: Hierarchy of the product which uniquely identifies the configuration. ,
Required: False ,
}
{
productFamilyName:
{
Description: Represents product family name that uniquely identifies product family. ,
Required: False ,
}
string ,
productLineName:
{
Description: Represents product line name that uniquely identifies product line. ,
Required: False ,
}
string ,
productName:
{
Description: Represents product name that uniquely identifies product. ,
Required: False ,
}
string ,
configurationName:
{
Description: Represents configuration name that uniquely identifies configuration. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: False ,
}
integer ,
identificationType:
{
Description: Identification type of the configuration. ,
Enum:
{
NotSupported: Product does not have any explicit identifier. ,
SerialNumber: Product is identifiable by serial number. ,
}
,
Required: False ,
}
enum ,
deviceDetails:
{
Description: List of device details. ,
Required: False ,
}
[
{
serialNumber:
{
Description: Device serial number. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: True ,
}
enum ,
orderItemMode:
{
Description: Defines the mode of the Order item. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Order item Status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderItemStageHistory:
{
Description: Order item status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
preferences:
{
Description: Customer notification Preferences. ,
Required: False ,
}
{
notificationPreferences:
{
Description: Notification preferences. ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the stage. ,
Enum:
{
Shipped: Notification at order item shipped from microsoft datacenter. ,
Delivered: Notification at order item delivered to customer. ,
}
,
Required: True ,
}
enum ,
sendNotification:
{
Description: Notification is required or not. ,
Required: True ,
}
boolean ,
}
,
]
,
transportPreferences:
{
Description: Preferences related to the shipment logistics of the order. ,
Required: False ,
}
{
preferredShipmentType:
{
Description: Indicates Shipment Logistics type that the customer preferred. ,
Enum:
{
CustomerManaged: Shipment Logistics is handled by the customer. ,
MicrosoftManaged: Shipment Logistics is handled by Microsoft. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionPreferences:
{
Description: Preferences related to the Encryption. ,
Required: False ,
}
{
doubleEncryptionStatus:
{
Description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. ,
Enum:
{
Disabled: Double encryption is disabled. ,
Enabled: Double encryption is enabled. ,
}
,
Required: False ,
}
enum ,
}
,
managementResourcePreferences:
{
Description: Preferences related to the Management resource. ,
Required: False ,
}
{
preferredManagementResourceId:
{
Description: Customer preferred Management resource ARM ID. ,
Required: False ,
}
string ,
}
,
}
,
forwardShippingDetails:
{
Description: Forward Package Shipping details. ,
Required: False ,
}
{
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
reverseShippingDetails:
{
Description: Reverse Package Shipping details. ,
Required: False ,
}
{
sasKeyForLabel:
{
Description: SAS key to download the reverse shipment label of the package. ,
Required: False ,
}
string ,
carrierName:
{
Description: Name of the carrier. ,
Required: False ,
}
string ,
carrierDisplayName:
{
Description: Carrier Name for display purpose. Not to be used for any processing. ,
Required: False ,
}
string ,
trackingId:
{
Description: TrackingId of the package. ,
Required: False ,
}
string ,
trackingUrl:
{
Description: TrackingUrl of the package. ,
Required: False ,
}
string ,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
cancellationReason:
{
Description: Cancellation reason. ,
Required: False ,
}
string ,
cancellationStatus:
{
Description: Describes whether the order item is cancellable or not. ,
Enum:
{
Cancellable: Order item can be cancelled without fee. ,
CancellableWithFee: Order item can be cancelled with fee. ,
NotCancellable: Order item not cancellable. ,
}
,
Required: False ,
}
enum ,
deletionStatus:
{
Description: Describes whether the order item is deletable or not. ,
Enum:
{
Allowed: Allowed flag. ,
NotAllowed: Not Allowed flag. ,
}
,
Required: False ,
}
enum ,
returnReason:
{
Description: Return reason. ,
Required: False ,
}
string ,
returnStatus:
{
Description: Describes whether the order item is returnable or not. ,
Enum:
{
Returnable: Order item can be returned without fee. ,
ReturnableWithFee: Order item can be returned with fee. ,
NotReturnable: Order item not returnable. ,
}
,
Required: False ,
}
enum ,
managementRpDetailsList:
{
Description: List of parent RP details supported for configuration. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
addressDetails:
{
Description: Represents shipping and return address for order item. ,
Required: True ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
startTime:
{
Description: Start time of order item. ,
Format: date-time ,
Required: False ,
}
string ,
orderId:
{
Description: Id of the order to which order item belongs to. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Cancel (removed)
Description :  Cancel order item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
cancellationReason:
{
Description: Reason for cancellation. ,
Required: True ,
}
{
reason:
{
Description: Reason for cancellation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrderItems_Return (removed)
Description :  Return order item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
orderItemName:
{
Description: The name of the order item. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
returnOrderItemDetails:
{
Description: Return order item details. ,
Required: True ,
}
{
returnAddress:
{
Description: Customer return address. ,
Required: False ,
}
{
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: True ,
}
string ,
streetAddress2:
{
Description: Street Address line 2. ,
Required: False ,
}
string ,
streetAddress3:
{
Description: Street Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Name of the City. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: Name of the State or Province. ,
Required: False ,
}
string ,
country:
{
Description: Name of the Country. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
zipExtendedCode:
{
Description: Extended Zip Code. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of the company. ,
Required: False ,
}
string ,
addressType:
{
Description: Type of address. ,
Enum:
{
None: Address type not known. ,
Residential: Residential Address. ,
Commercial: Commercial Address. ,
}
,
Required: False ,
}
enum ,
}
,
contactDetails:
{
Description: Contact details for the address. ,
Required: True ,
}
{
contactName:
{
Description: Contact name of the person. ,
Required: True ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: True ,
}
string ,
phoneExtension:
{
Description: Phone extension number of the contact person. ,
Required: False ,
}
string ,
mobile:
{
Description: Mobile number of the contact person. ,
Required: False ,
}
string ,
emailList:
{
Description: List of Email-ids to be notified about job progress. ,
Required: True ,
}
[
string ,
]
,
}
,
addressValidationStatus:
{
Description: Status of address validation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
returnReason:
{
Description: Return Reason. ,
Required: True ,
}
string ,
serviceTag:
{
Description: Service tag (located on the bottom-right corner of the device). ,
Required: False ,
}
string ,
shippingBoxRequired:
{
Description: Shipping Box required. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Orders_ListByResourceGroup (removed)
Description :  List orders at resource group level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of order resources. ,
Required: False ,
}
[
{
properties:
{
Description: Order properties. ,
Required: True ,
}
{
orderItemIds:
{
Description: List of order item ARM Ids which are part of an order. ,
Required: False ,
}
[
string ,
]
,
currentStage:
{
Description: Order current status. ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
orderStageHistory:
{
Description: Order status history. ,
Required: False ,
}
[
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name. ,
Enum:
{
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. ,
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. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
orderMode:
{
Description: Order mode. ,
Enum:
{
Default: Default Order mode. ,
DoNotFulfill: Mode in which the Order will not be fulfilled. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Represents resource creation and update time. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of order resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}