Bicep resource definition
The orderItems resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.EdgeOrder/orderItems resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.EdgeOrder/orderItems@2024-02-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
addressDetails: {
forwardAddress: {
addressClassification: 'string'
contactDetails: {
contactName: 'string'
emailList: [
'string'
]
mobile: 'string'
phone: 'string'
phoneExtension: 'string'
}
shippingAddress: {
addressType: 'string'
city: 'string'
companyName: 'string'
country: 'string'
postalCode: 'string'
stateOrProvince: 'string'
streetAddress1: 'string'
streetAddress2: 'string'
streetAddress3: 'string'
zipExtendedCode: 'string'
}
}
}
orderId: 'string'
orderItemDetails: {
notificationEmailList: [
'string'
]
orderItemMode: 'string'
orderItemType: 'string'
preferences: {
encryptionPreferences: {
doubleEncryptionStatus: 'string'
}
managementResourcePreferences: {
preferredManagementResourceId: 'string'
}
notificationPreferences: [
{
sendNotification: bool
stageName: 'string'
}
]
termCommitmentPreferences: {
preferredTermCommitmentDuration: 'string'
preferredTermCommitmentType: 'string'
}
transportPreferences: {
preferredShipmentType: 'string'
}
}
productDetails: {
displayInfo: {}
hierarchyInformation: {
configurationIdDisplayName: 'string'
configurationName: 'string'
productFamilyName: 'string'
productLineName: 'string'
productName: 'string'
}
optInAdditionalConfigurations: [
{
hierarchyInformation: {
configurationIdDisplayName: 'string'
configurationName: 'string'
productFamilyName: 'string'
productLineName: 'string'
productName: 'string'
}
provisioningDetails: [
{
autoProvisioningStatus: 'string'
devicePresenceVerification: {}
managementResourceArmId: 'string'
provisioningArmId: 'string'
provisioningEndPoint: 'string'
quantity: int
readyToConnectArmId: 'string'
serialNumber: 'string'
vendorName: 'string'
}
]
quantity: int
}
]
parentProvisioningDetails: {
autoProvisioningStatus: 'string'
devicePresenceVerification: {}
managementResourceArmId: 'string'
provisioningArmId: 'string'
provisioningEndPoint: 'string'
quantity: int
readyToConnectArmId: 'string'
serialNumber: 'string'
vendorName: 'string'
}
}
siteDetails: {
siteId: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
Name |
Description |
Value |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the configuration. |
HierarchyInformation (required) |
provisioningDetails |
List Provisioning Details for Devices in Additional Config. |
ProvisioningDetails[] |
quantity |
Quantity of the product. |
int (required) |
Name |
Description |
Value |
forwardAddress |
Customer address and contact details. |
AddressProperties (required) |
Name |
Description |
Value |
addressClassification |
Type of address based on its usage context. |
'Shipping' 'Site' |
contactDetails |
Contact details for the address. |
ContactDetails |
shippingAddress |
Shipping details for the address. |
ShippingAddress |
Name |
Description |
Value |
contactName |
Contact name of the person. |
string |
emailList |
List of Email-ids to be notified about job progress. |
string[] |
mobile |
Mobile number of the contact person. |
string |
phone |
Phone number of the contact person. |
string |
phoneExtension |
Phone extension number of the contact person. |
string |
DevicePresenceVerificationDetails
Name |
Description |
Value |
doubleEncryptionStatus |
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. |
'Disabled' 'Enabled' |
Name |
Description |
Value |
configurationIdDisplayName |
Represents Model Display Name. |
string |
configurationName |
Represents configuration name that uniquely identifies configuration. |
string |
productFamilyName |
Represents product family name that uniquely identifies product family. |
string |
productLineName |
Represents product line name that uniquely identifies product line. |
string |
productName |
Represents product name that uniquely identifies product. |
string |
ManagementResourcePreferences
Name |
Description |
Value |
preferredManagementResourceId |
Customer preferred Management resource ARM ID. |
string |
Microsoft.EdgeOrder/orderItems
Name |
Description |
Value |
identity |
Msi identity of the resource |
ResourceIdentity |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$ (required) |
properties |
Order item properties. |
OrderItemProperties (required) |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
Name |
Description |
Value |
sendNotification |
Notification is required or not. |
bool (required) |
stageName |
Name of the stage. |
'Delivered' 'Shipped' (required) |
Name |
Description |
Value |
notificationEmailList |
Additional notification email list. |
string[] |
orderItemMode |
Defines the mode of the Order item. |
'Default' 'DoNotFulfill' |
orderItemType |
Order item type. |
'External' 'Purchase' 'Rental' (required) |
preferences |
Customer notification Preferences. |
Preferences |
productDetails |
Represents product details. |
ProductDetails (required) |
siteDetails |
Site Related Details. |
SiteDetails |
Name |
Description |
Value |
addressDetails |
Represents shipping and return address for order item. |
AddressDetails |
orderId |
Id of the order to which order item belongs to. |
string (required) |
orderItemDetails |
Represents order item details. |
OrderItemDetails (required) |
Name |
Description |
Value |
displayInfo |
Display details of the product. |
DisplayInfo |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the product. |
HierarchyInformation (required) |
optInAdditionalConfigurations |
List of additional configurations customer wants in the order item apart from the ones included in the base configuration. |
AdditionalConfiguration[] |
parentProvisioningDetails |
Device Provisioning Details for Parent. |
ProvisioningDetails |
Name |
Description |
Value |
autoProvisioningStatus |
Auto Provisioning Details. |
'Disabled' 'Enabled' |
devicePresenceVerification |
Proof of possession details. |
DevicePresenceVerificationDetails |
managementResourceArmId |
Management Resource ArmId. |
string |
provisioningArmId |
Provisioning Resource Arm ID. |
string |
provisioningEndPoint |
Provisioning End Point. |
string |
quantity |
Quantity of the devices. |
int
Constraints: Min value = 0 |
readyToConnectArmId |
Arc Enabled Resource Arm id. |
string |
serialNumber |
Serial Number for the Device. |
string |
vendorName |
Vendor Name for the Device , (for 1P devices - Microsoft). |
string |
Name |
Description |
Value |
type |
Identity type |
string |
userAssignedIdentities |
User Assigned Identities |
UserAssignedIdentities |
Name |
Description |
Value |
addressType |
Type of address. |
'Commercial' 'None' 'Residential' |
city |
Name of the City. |
string |
companyName |
Name of the company. |
string |
country |
Name of the Country. |
string (required) |
postalCode |
Postal code. |
string |
stateOrProvince |
Name of the State or Province. |
string |
streetAddress1 |
Street Address line 1. |
string |
streetAddress2 |
Street Address line 2. |
string |
streetAddress3 |
Street Address line 3. |
string |
zipExtendedCode |
Extended Zip Code. |
string |
Name |
Description |
Value |
siteId |
Unique Id, Identifying A Site. |
string (required) |
TermCommitmentPreferences
Name |
Description |
Value |
preferredTermCommitmentDuration |
Customer preferred Term Duration. |
string |
preferredTermCommitmentType |
Term Commitment Type |
'None' 'Timed' 'Trial' (required) |
Name |
Description |
Value |
preferredShipmentType |
Indicates Shipment Logistics type that the customer preferred. |
'CustomerManaged' 'MicrosoftManaged' (required) |
ARM template resource definition
The orderItems resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.EdgeOrder/orderItems resource, add the following JSON to your template.
{
"type": "Microsoft.EdgeOrder/orderItems",
"apiVersion": "2024-02-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"addressDetails": {
"forwardAddress": {
"addressClassification": "string",
"contactDetails": {
"contactName": "string",
"emailList": [ "string" ],
"mobile": "string",
"phone": "string",
"phoneExtension": "string"
},
"shippingAddress": {
"addressType": "string",
"city": "string",
"companyName": "string",
"country": "string",
"postalCode": "string",
"stateOrProvince": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"streetAddress3": "string",
"zipExtendedCode": "string"
}
}
},
"orderId": "string",
"orderItemDetails": {
"notificationEmailList": [ "string" ],
"orderItemMode": "string",
"orderItemType": "string",
"preferences": {
"encryptionPreferences": {
"doubleEncryptionStatus": "string"
},
"managementResourcePreferences": {
"preferredManagementResourceId": "string"
},
"notificationPreferences": [
{
"sendNotification": "bool",
"stageName": "string"
}
],
"termCommitmentPreferences": {
"preferredTermCommitmentDuration": "string",
"preferredTermCommitmentType": "string"
},
"transportPreferences": {
"preferredShipmentType": "string"
}
},
"productDetails": {
"displayInfo": {
},
"hierarchyInformation": {
"configurationIdDisplayName": "string",
"configurationName": "string",
"productFamilyName": "string",
"productLineName": "string",
"productName": "string"
},
"optInAdditionalConfigurations": [
{
"hierarchyInformation": {
"configurationIdDisplayName": "string",
"configurationName": "string",
"productFamilyName": "string",
"productLineName": "string",
"productName": "string"
},
"provisioningDetails": [
{
"autoProvisioningStatus": "string",
"devicePresenceVerification": {
},
"managementResourceArmId": "string",
"provisioningArmId": "string",
"provisioningEndPoint": "string",
"quantity": "int",
"readyToConnectArmId": "string",
"serialNumber": "string",
"vendorName": "string"
}
],
"quantity": "int"
}
],
"parentProvisioningDetails": {
"autoProvisioningStatus": "string",
"devicePresenceVerification": {
},
"managementResourceArmId": "string",
"provisioningArmId": "string",
"provisioningEndPoint": "string",
"quantity": "int",
"readyToConnectArmId": "string",
"serialNumber": "string",
"vendorName": "string"
}
},
"siteDetails": {
"siteId": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
Name |
Description |
Value |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the configuration. |
HierarchyInformation (required) |
provisioningDetails |
List Provisioning Details for Devices in Additional Config. |
ProvisioningDetails[] |
quantity |
Quantity of the product. |
int (required) |
Name |
Description |
Value |
forwardAddress |
Customer address and contact details. |
AddressProperties (required) |
Name |
Description |
Value |
addressClassification |
Type of address based on its usage context. |
'Shipping' 'Site' |
contactDetails |
Contact details for the address. |
ContactDetails |
shippingAddress |
Shipping details for the address. |
ShippingAddress |
Name |
Description |
Value |
contactName |
Contact name of the person. |
string |
emailList |
List of Email-ids to be notified about job progress. |
string[] |
mobile |
Mobile number of the contact person. |
string |
phone |
Phone number of the contact person. |
string |
phoneExtension |
Phone extension number of the contact person. |
string |
DevicePresenceVerificationDetails
Name |
Description |
Value |
doubleEncryptionStatus |
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. |
'Disabled' 'Enabled' |
Name |
Description |
Value |
configurationIdDisplayName |
Represents Model Display Name. |
string |
configurationName |
Represents configuration name that uniquely identifies configuration. |
string |
productFamilyName |
Represents product family name that uniquely identifies product family. |
string |
productLineName |
Represents product line name that uniquely identifies product line. |
string |
productName |
Represents product name that uniquely identifies product. |
string |
ManagementResourcePreferences
Name |
Description |
Value |
preferredManagementResourceId |
Customer preferred Management resource ARM ID. |
string |
Microsoft.EdgeOrder/orderItems
Name |
Description |
Value |
apiVersion |
The api version |
'2024-02-01' |
identity |
Msi identity of the resource |
ResourceIdentity |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$ (required) |
properties |
Order item properties. |
OrderItemProperties (required) |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
type |
The resource type |
'Microsoft.EdgeOrder/orderItems' |
Name |
Description |
Value |
sendNotification |
Notification is required or not. |
bool (required) |
stageName |
Name of the stage. |
'Delivered' 'Shipped' (required) |
Name |
Description |
Value |
notificationEmailList |
Additional notification email list. |
string[] |
orderItemMode |
Defines the mode of the Order item. |
'Default' 'DoNotFulfill' |
orderItemType |
Order item type. |
'External' 'Purchase' 'Rental' (required) |
preferences |
Customer notification Preferences. |
Preferences |
productDetails |
Represents product details. |
ProductDetails (required) |
siteDetails |
Site Related Details. |
SiteDetails |
Name |
Description |
Value |
addressDetails |
Represents shipping and return address for order item. |
AddressDetails |
orderId |
Id of the order to which order item belongs to. |
string (required) |
orderItemDetails |
Represents order item details. |
OrderItemDetails (required) |
Name |
Description |
Value |
displayInfo |
Display details of the product. |
DisplayInfo |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the product. |
HierarchyInformation (required) |
optInAdditionalConfigurations |
List of additional configurations customer wants in the order item apart from the ones included in the base configuration. |
AdditionalConfiguration[] |
parentProvisioningDetails |
Device Provisioning Details for Parent. |
ProvisioningDetails |
Name |
Description |
Value |
autoProvisioningStatus |
Auto Provisioning Details. |
'Disabled' 'Enabled' |
devicePresenceVerification |
Proof of possession details. |
DevicePresenceVerificationDetails |
managementResourceArmId |
Management Resource ArmId. |
string |
provisioningArmId |
Provisioning Resource Arm ID. |
string |
provisioningEndPoint |
Provisioning End Point. |
string |
quantity |
Quantity of the devices. |
int
Constraints: Min value = 0 |
readyToConnectArmId |
Arc Enabled Resource Arm id. |
string |
serialNumber |
Serial Number for the Device. |
string |
vendorName |
Vendor Name for the Device , (for 1P devices - Microsoft). |
string |
Name |
Description |
Value |
type |
Identity type |
string |
userAssignedIdentities |
User Assigned Identities |
UserAssignedIdentities |
Name |
Description |
Value |
addressType |
Type of address. |
'Commercial' 'None' 'Residential' |
city |
Name of the City. |
string |
companyName |
Name of the company. |
string |
country |
Name of the Country. |
string (required) |
postalCode |
Postal code. |
string |
stateOrProvince |
Name of the State or Province. |
string |
streetAddress1 |
Street Address line 1. |
string |
streetAddress2 |
Street Address line 2. |
string |
streetAddress3 |
Street Address line 3. |
string |
zipExtendedCode |
Extended Zip Code. |
string |
Name |
Description |
Value |
siteId |
Unique Id, Identifying A Site. |
string (required) |
TermCommitmentPreferences
Name |
Description |
Value |
preferredTermCommitmentDuration |
Customer preferred Term Duration. |
string |
preferredTermCommitmentType |
Term Commitment Type |
'None' 'Timed' 'Trial' (required) |
Name |
Description |
Value |
preferredShipmentType |
Indicates Shipment Logistics type that the customer preferred. |
'CustomerManaged' 'MicrosoftManaged' (required) |
The orderItems resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.EdgeOrder/orderItems resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EdgeOrder/orderItems@2024-02-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
addressDetails = {
forwardAddress = {
addressClassification = "string"
contactDetails = {
contactName = "string"
emailList = [
"string"
]
mobile = "string"
phone = "string"
phoneExtension = "string"
}
shippingAddress = {
addressType = "string"
city = "string"
companyName = "string"
country = "string"
postalCode = "string"
stateOrProvince = "string"
streetAddress1 = "string"
streetAddress2 = "string"
streetAddress3 = "string"
zipExtendedCode = "string"
}
}
}
orderId = "string"
orderItemDetails = {
notificationEmailList = [
"string"
]
orderItemMode = "string"
orderItemType = "string"
preferences = {
encryptionPreferences = {
doubleEncryptionStatus = "string"
}
managementResourcePreferences = {
preferredManagementResourceId = "string"
}
notificationPreferences = [
{
sendNotification = bool
stageName = "string"
}
]
termCommitmentPreferences = {
preferredTermCommitmentDuration = "string"
preferredTermCommitmentType = "string"
}
transportPreferences = {
preferredShipmentType = "string"
}
}
productDetails = {
displayInfo = {
}
hierarchyInformation = {
configurationIdDisplayName = "string"
configurationName = "string"
productFamilyName = "string"
productLineName = "string"
productName = "string"
}
optInAdditionalConfigurations = [
{
hierarchyInformation = {
configurationIdDisplayName = "string"
configurationName = "string"
productFamilyName = "string"
productLineName = "string"
productName = "string"
}
provisioningDetails = [
{
autoProvisioningStatus = "string"
devicePresenceVerification = {
}
managementResourceArmId = "string"
provisioningArmId = "string"
provisioningEndPoint = "string"
quantity = int
readyToConnectArmId = "string"
serialNumber = "string"
vendorName = "string"
}
]
quantity = int
}
]
parentProvisioningDetails = {
autoProvisioningStatus = "string"
devicePresenceVerification = {
}
managementResourceArmId = "string"
provisioningArmId = "string"
provisioningEndPoint = "string"
quantity = int
readyToConnectArmId = "string"
serialNumber = "string"
vendorName = "string"
}
}
siteDetails = {
siteId = "string"
}
}
}
}
}
Name |
Description |
Value |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the configuration. |
HierarchyInformation (required) |
provisioningDetails |
List Provisioning Details for Devices in Additional Config. |
ProvisioningDetails[] |
quantity |
Quantity of the product. |
int (required) |
Name |
Description |
Value |
forwardAddress |
Customer address and contact details. |
AddressProperties (required) |
Name |
Description |
Value |
addressClassification |
Type of address based on its usage context. |
'Shipping' 'Site' |
contactDetails |
Contact details for the address. |
ContactDetails |
shippingAddress |
Shipping details for the address. |
ShippingAddress |
Name |
Description |
Value |
contactName |
Contact name of the person. |
string |
emailList |
List of Email-ids to be notified about job progress. |
string[] |
mobile |
Mobile number of the contact person. |
string |
phone |
Phone number of the contact person. |
string |
phoneExtension |
Phone extension number of the contact person. |
string |
DevicePresenceVerificationDetails
Name |
Description |
Value |
doubleEncryptionStatus |
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. |
'Disabled' 'Enabled' |
Name |
Description |
Value |
configurationIdDisplayName |
Represents Model Display Name. |
string |
configurationName |
Represents configuration name that uniquely identifies configuration. |
string |
productFamilyName |
Represents product family name that uniquely identifies product family. |
string |
productLineName |
Represents product line name that uniquely identifies product line. |
string |
productName |
Represents product name that uniquely identifies product. |
string |
ManagementResourcePreferences
Name |
Description |
Value |
preferredManagementResourceId |
Customer preferred Management resource ARM ID. |
string |
Microsoft.EdgeOrder/orderItems
Name |
Description |
Value |
identity |
Msi identity of the resource |
ResourceIdentity |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$ (required) |
properties |
Order item properties. |
OrderItemProperties (required) |
tags |
Resource tags |
Dictionary of tag names and values. |
type |
The resource type |
"Microsoft.EdgeOrder/orderItems@2024-02-01" |
Name |
Description |
Value |
sendNotification |
Notification is required or not. |
bool (required) |
stageName |
Name of the stage. |
'Delivered' 'Shipped' (required) |
Name |
Description |
Value |
notificationEmailList |
Additional notification email list. |
string[] |
orderItemMode |
Defines the mode of the Order item. |
'Default' 'DoNotFulfill' |
orderItemType |
Order item type. |
'External' 'Purchase' 'Rental' (required) |
preferences |
Customer notification Preferences. |
Preferences |
productDetails |
Represents product details. |
ProductDetails (required) |
siteDetails |
Site Related Details. |
SiteDetails |
Name |
Description |
Value |
addressDetails |
Represents shipping and return address for order item. |
AddressDetails |
orderId |
Id of the order to which order item belongs to. |
string (required) |
orderItemDetails |
Represents order item details. |
OrderItemDetails (required) |
Name |
Description |
Value |
displayInfo |
Display details of the product. |
DisplayInfo |
hierarchyInformation |
Hierarchy of the product which uniquely identifies the product. |
HierarchyInformation (required) |
optInAdditionalConfigurations |
List of additional configurations customer wants in the order item apart from the ones included in the base configuration. |
AdditionalConfiguration[] |
parentProvisioningDetails |
Device Provisioning Details for Parent. |
ProvisioningDetails |
Name |
Description |
Value |
autoProvisioningStatus |
Auto Provisioning Details. |
'Disabled' 'Enabled' |
devicePresenceVerification |
Proof of possession details. |
DevicePresenceVerificationDetails |
managementResourceArmId |
Management Resource ArmId. |
string |
provisioningArmId |
Provisioning Resource Arm ID. |
string |
provisioningEndPoint |
Provisioning End Point. |
string |
quantity |
Quantity of the devices. |
int
Constraints: Min value = 0 |
readyToConnectArmId |
Arc Enabled Resource Arm id. |
string |
serialNumber |
Serial Number for the Device. |
string |
vendorName |
Vendor Name for the Device , (for 1P devices - Microsoft). |
string |
Name |
Description |
Value |
type |
Identity type |
string |
userAssignedIdentities |
User Assigned Identities |
UserAssignedIdentities |
Name |
Description |
Value |
addressType |
Type of address. |
'Commercial' 'None' 'Residential' |
city |
Name of the City. |
string |
companyName |
Name of the company. |
string |
country |
Name of the Country. |
string (required) |
postalCode |
Postal code. |
string |
stateOrProvince |
Name of the State or Province. |
string |
streetAddress1 |
Street Address line 1. |
string |
streetAddress2 |
Street Address line 2. |
string |
streetAddress3 |
Street Address line 3. |
string |
zipExtendedCode |
Extended Zip Code. |
string |
Name |
Description |
Value |
siteId |
Unique Id, Identifying A Site. |
string (required) |
TermCommitmentPreferences
Name |
Description |
Value |
preferredTermCommitmentDuration |
Customer preferred Term Duration. |
string |
preferredTermCommitmentType |
Term Commitment Type |
'None' 'Timed' 'Trial' (required) |
Name |
Description |
Value |
preferredShipmentType |
Indicates Shipment Logistics type that the customer preferred. |
'CustomerManaged' 'MicrosoftManaged' (required) |