Microsoft.EdgeOrder (stable:2024-02-01)

2025/07/10 • 17 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "List all the supported operations."
  }
}

⚼ 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). ,
Format: uri ,
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 (updated)
Description :  List all the addresses available under the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Addresses_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AddressResource items on this page",
            "old": "List of address resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of job resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The AddressResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List configurations for the given product family, product line and product for the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductsAndConfigurations_ListConfigurations",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Configuration items on this page",
            "old": "List of configurations."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of configurations."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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: The Configuration items on this page ,
Required: True ,
}
[
{
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a 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 ,
termTypeDetails:
{
Description: Represent Term Type details. ,
Required: False ,
}
{
termType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termTypeDuration:
{
Description: Duration for the term type. ,
Format: duration ,
Required: True ,
}
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
}
,
}
,
]
,
}
,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a configuration. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List product families for the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductsAndConfigurations_ListProductFamilies",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ProductFamily items on this page",
            "old": "List of product families."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of product families."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The ProductFamily items on this page ,
Required: True ,
}
[
{
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a 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 ,
termTypeDetails:
{
Description: Represent Term Type details. ,
Required: False ,
}
{
termType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termTypeDuration:
{
Description: Duration for the term type. ,
Format: duration ,
Required: True ,
}
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
}
,
}
,
]
,
}
,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a configuration. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List order items at subscription level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrderItems_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrderItemResource items on this page",
            "old": "List of order item resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of order item resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id and order Item Type. 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: The OrderItemResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Represents product details. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningDetails:
{
Description: List Provisioning Details for Devices in Additional Config. ,
Required: False ,
}
[
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
External: Orders placed outside of azure. ,
}
,
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 ,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
Required: True ,
}
string ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
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: False ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List orders at subscription level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Orders_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrderResource items on this page",
            "old": "List of order resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of order resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The OrderResource items on this page ,
Required: True ,
}
[
{
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List product families metadata for the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductsAndConfigurations_ListProductFamiliesMetadata",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ProductFamiliesMetadataDetails items on this page",
            "old": "List of product family metadata details."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of product families."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/productFamiliesMetadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The ProductFamiliesMetadataDetails items on this page ,
Required: True ,
}
[
{
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
}
,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
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 ,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a 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 ,
termTypeDetails:
{
Description: Represent Term Type details. ,
Required: False ,
}
{
termType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termTypeDuration:
{
Description: Duration for the term type. ,
Format: duration ,
Required: True ,
}
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
}
,
}
,
]
,
}
,
]
,
supportedTermCommitmentDurations:
{
Description: The Term Commitment Durations that are supported for a configuration. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
resourceProviderDetails:
{
Description: Contains details related to resource provider. ,
Required: False ,
}
[
{
resourceProviderNamespace:
{
Description: Resource provider namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List all the addresses available under the given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Addresses_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AddressResource items on this page",
            "old": "List of address resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of job resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The AddressResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
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 ¶

⚶ Changes

{
  "#id": "Addresses_Create",
  "Description": {
    "new": "Create a new address with the specified parameters. Existing address cannot be updated with this API and should\ninstead be updated with the Update address API.",
    "old": "Create a new address with the specified parameters. Existing address cannot be updated with this API and should\r\ninstead be updated with the Update address API."
  },
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_7930a57ce835412591f1afefd20f157e": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
addressResource:
{
Description: Address details from request body. ,
Required: True ,
}
{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Update the properties of an existing address.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Addresses_Update",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_3d9481f145344535aca19d15accfaf4f": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: 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 (200)

{
properties:
{
Description: Properties of an address. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Delete an address.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Addresses_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_6ef816bf56254c33be9fc8d637c74fb8": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_ListByResourceGroup (updated)
Description :  List order items at resource group level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrderItems_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrderItemResource items on this page",
            "old": "List of order item resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of order item resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: $filter is supported to filter based on order id and order Item Type. 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: The OrderItemResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Represents product details. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningDetails:
{
Description: List Provisioning Details for Devices in Additional Config. ,
Required: False ,
}
[
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
External: Orders placed outside of azure. ,
}
,
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 ,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
Required: True ,
}
string ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
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: False ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
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 ¶

⚶ Changes

{
  "#id": "OrderItems_Create",
  "Description": {
    "new": "Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item\nAPI.",
    "old": "Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item\r\nAPI."
  },
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_2dbda15debdc443dae57fde925a85624": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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: Represents product details. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningDetails:
{
Description: List Provisioning Details for Devices in Additional Config. ,
Required: False ,
}
[
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
External: Orders placed outside of azure. ,
}
,
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 ,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
Required: True ,
}
string ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
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: False ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Represents product details. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningDetails:
{
Description: List Provisioning Details for Devices in Additional Config. ,
Required: False ,
}
[
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
External: Orders placed outside of azure. ,
}
,
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 ,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
Required: True ,
}
string ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
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: False ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Update the properties of an existing order item.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrderItems_Update",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_aec97a6ed05c4612b3606635cc61f07d": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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 ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
notificationEmailList:
{
Description: Additional notification email list. ,
Required: False ,
}
[
string ,
]
,
orderItemDetails:
{
Description: Represents order item details. ,
Required: False ,
}
{
productDetails:
{
Description: Represents product details. ,
Required: False ,
}
{
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
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 ,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Order item properties. ,
Required: True ,
}
{
orderItemDetails:
{
Description: Represents order item details. ,
Required: True ,
}
{
productDetails:
{
Description: Represents product details. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
parentProvisioningDetails:
{
Description: Device Provisioning Details for Parent. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Quantity of the product. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningDetails:
{
Description: List Provisioning Details for Devices in Additional Config. ,
Required: False ,
}
[
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
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 ,
configurationIdDisplayName:
{
Description: Represents Model Display Name. ,
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 ,
displaySerialNumber:
{
Description: Device serial number to be displayed. ,
Required: False ,
}
string ,
managementResourceId:
{
Description: Management Resource Id. ,
Required: False ,
}
string ,
managementResourceTenantId:
{
Description: Management Resource Tenant ID. ,
Required: False ,
}
string ,
provisioningSupport:
{
Description: Determining nature of provisioning that the configuration supports. ,
Enum:
{
CloudBased: The configuration can be provisioned from the cloud. ,
Manual: The configuration need to be provisioned manually by the end user. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Description: Provisioning Details for the device. ,
Required: False ,
}
{
quantity:
{
Description: Quantity of the devices. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningArmId:
{
Description: Provisioning Resource Arm ID. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningEndPoint:
{
Description: Provisioning End Point. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number for the Device. ,
Required: False ,
}
string ,
vendorName:
{
Description: Vendor Name for the Device , (for 1P devices - Microsoft). ,
Required: False ,
}
string ,
readyToConnectArmId:
{
Description: Arc Enabled Resource Arm id. ,
Format: arm-id ,
Required: False ,
}
string ,
managementResourceArmId:
{
Description: Management Resource ArmId. ,
Format: arm-id ,
Required: False ,
}
string ,
uniqueDeviceIdentifier:
{
Description: Unique Identity for a Device. ,
Required: False ,
}
string ,
autoProvisioningStatus:
{
Description: Auto Provisioning Details. ,
Enum:
{
Enabled: Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location. ,
Disabled: Provisioning Disabled. ,
}
,
Required: False ,
}
enum ,
devicePresenceVerification:
{
Description: Proof of possession details. ,
Required: False ,
}
{
status:
{
Description: Proof of possession status. ,
Enum:
{
NotInitiated: The device has not yet been verified to be with the right edge operator or at the right location. ,
Completed: Confirms that the device is verified to be with the right edge operator or at the right location. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Insights on current status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
termCommitmentInformation:
{
Description: Term Commitment Information of the Device. ,
Required: False ,
}
{
termCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
termCommitmentTypeDuration:
{
Description: Term Commitment Duration. Currently Supporting P365D, P1095D ,
Format: duration ,
Required: False ,
}
string ,
pendingDaysForTerm:
{
Description: Number of Days Pending for Term Commitment ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
orderItemType:
{
Description: Order item type. ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
External: Orders placed outside of azure. ,
}
,
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 ,
siteDetails:
{
Description: Site Related Details. ,
Required: False ,
}
{
siteId:
{
Description: Unique Id, Identifying A Site. ,
Required: True ,
}
string ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
termCommitmentPreferences:
{
Description: Preferences related to the Term commitment. ,
Required: False ,
}
{
preferredTermCommitmentType:
{
Description: Term Commitment Type ,
Enum:
{
None: Pay as you go Term Commitment Model. ,
Trial: Trial Term Commitment Model. ,
Timed: Time based Term Commitment Model. ,
}
,
Required: True ,
}
enum ,
preferredTermCommitmentDuration:
{
Description: Customer preferred Term Duration. ,
Format: duration ,
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: False ,
}
{
forwardAddress:
{
Description: Customer address and contact details. ,
Required: True ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
returnAddress:
{
Description: Return shipping address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Msi identity of the resource ,
Required: False ,
}
{
type:
{
Description: Identity type ,
Required: False ,
}
string ,
principalId:
{
Description: Service Principal Id backing the Msi ,
Required: False ,
}
string ,
tenantId:
{
Description: Home Tenant Id ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Delete an order item.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrderItems_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_897e633cf0b9411b867d99b8b8d6f31b": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Return order item.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrderItems_Return",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL to track the status of the long running operation."
        }
      },
      {
        "@added_16bb461c8adb4fb9a6305a1fc22ad926": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
returnOrderItemDetails:
{
Description: Return order item details. ,
Required: True ,
}
{
returnAddress:
{
Description: Customer return address. ,
Required: False ,
}
{
addressClassification:
{
Description: Type of address based on its usage context. ,
Enum:
{
Shipping: Shipping address for the order. ,
Site: Site Address. ,
}
,
Required: False ,
}
enum ,
shippingAddress:
{
Description: Shipping details for the address. ,
Required: False ,
}
{
streetAddress1:
{
Description: Street Address line 1. ,
Required: False ,
}
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: False ,
}
string ,
phone:
{
Description: Phone number of the contact person. ,
Required: False ,
}
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: False ,
}
[
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 ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: Creating state. ,
Succeeded: Succeeded state. ,
Failed: Failed state. ,
Canceled: Canceled state. ,
}
,
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 Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  List orders at resource group level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Orders_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrderResource items on this page",
            "old": "List of order resources."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for the next set of order resources."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The OrderResource items on this page ,
Required: True ,
}
[
{
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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. ,
ReadyToSetup: Order is ready to get cloud connected. ,
InUse: Order is in use at customer site. ,
ReturnInitiated: Return has been initiated by customer. ,
ReturnPickedUp: Order is in transit from customer to Microsoft. ,
ReturnedToMicrosoft: Order has been received back to Microsoft. ,
ReturnCompleted: Return has now completed. ,
Cancelled: Order has been cancelled. ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}