Microsoft.EdgeOrder orderItems 2022-05-01-preview

2024-12-09

Bicep resource definition

The orderItems resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EdgeOrder/orderItems resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EdgeOrder/orderItems@2022-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    addressDetails: {
      forwardAddress: {
        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'
          }
        ]
        transportPreferences: {
          preferredShipmentType: 'string'
        }
      }
      productDetails: {
        displayInfo: {}
        hierarchyInformation: {
          configurationName: 'string'
          productFamilyName: 'string'
          productLineName: 'string'
          productName: 'string'
        }
        optInAdditionalConfigurations: [
          {
            hierarchyInformation: {
              configurationName: 'string'
              productFamilyName: 'string'
              productLineName: 'string'
              productName: 'string'
            }
            quantity: int
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.EdgeOrder/orderItems

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Order item properties.	OrderItemProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AdditionalConfiguration

Name	Description	Value
hierarchyInformation	Hierarchy of the product which uniquely identifies the configuration.	HierarchyInformation (required)
quantity	Quantity of the product.	int (required)

AddressDetails

Name	Description	Value
forwardAddress	Customer address and contact details.	AddressProperties (required)

AddressProperties

Name	Description	Value
contactDetails	Contact details for the address.	ContactDetails (required)
shippingAddress	Shipping details for the address.	ShippingAddress

ContactDetails

Name	Description	Value
contactName	Contact name of the person.	string (required)
emailList	List of Email-ids to be notified about job progress.	string[] (required)
mobile	Mobile number of the contact person.	string
phone	Phone number of the contact person.	string (required)
phoneExtension	Phone extension number of the contact person.	string

DisplayInfo

Name	Description	Value

EncryptionPreferences

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'

HierarchyInformation

Name	Description	Value
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

NotificationPreference

Name	Description	Value
sendNotification	Notification is required or not.	bool (required)
stageName	Name of the stage.	'Delivered' 'Shipped' (required)

OrderItemDetails

Name	Description	Value
notificationEmailList	Additional notification email list.	string[]
orderItemMode	Defines the mode of the Order item.	'Default' 'DoNotFulfill'
orderItemType	Order item type.	'Purchase' 'Rental' (required)
preferences	Customer notification Preferences.	Preferences
productDetails	Unique identifier for configuration.	ProductDetails (required)

OrderItemProperties

Name	Description	Value
addressDetails	Represents shipping and return address for order item.	AddressDetails (required)
orderId	Id of the order to which order item belongs to.	string (required)
orderItemDetails	Represents order item details.	OrderItemDetails (required)

Preferences

Name	Description	Value
encryptionPreferences	Preferences related to the Encryption.	EncryptionPreferences
managementResourcePreferences	Preferences related to the Management resource.	ManagementResourcePreferences
notificationPreferences	Notification preferences.	NotificationPreference[]
transportPreferences	Preferences related to the shipment logistics of the order.	TransportPreferences

ProductDetails

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[]

ShippingAddress

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 (required)
streetAddress2	Street Address line 2.	string
streetAddress3	Street Address line 3.	string
zipExtendedCode	Extended Zip Code.	string

TrackedResourceTags

Name	Description	Value

TransportPreferences

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:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EdgeOrder/orderItems resource, add the following JSON to your template.

{
  "type": "Microsoft.EdgeOrder/orderItems",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "addressDetails": {
      "forwardAddress": {
        "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"
          }
        ],
        "transportPreferences": {
          "preferredShipmentType": "string"
        }
      },
      "productDetails": {
        "displayInfo": {
        },
        "hierarchyInformation": {
          "configurationName": "string",
          "productFamilyName": "string",
          "productLineName": "string",
          "productName": "string"
        },
        "optInAdditionalConfigurations": [
          {
            "hierarchyInformation": {
              "configurationName": "string",
              "productFamilyName": "string",
              "productLineName": "string",
              "productName": "string"
            },
            "quantity": "int"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.EdgeOrder/orderItems

Name	Description	Value
apiVersion	The api version	'2022-05-01-preview'
location	The geo-location where the resource lives	string (required)
name	The resource name	string (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'

AdditionalConfiguration

Name	Description	Value
hierarchyInformation	Hierarchy of the product which uniquely identifies the configuration.	HierarchyInformation (required)
quantity	Quantity of the product.	int (required)

AddressDetails

Name	Description	Value
forwardAddress	Customer address and contact details.	AddressProperties (required)

AddressProperties

Name	Description	Value
contactDetails	Contact details for the address.	ContactDetails (required)
shippingAddress	Shipping details for the address.	ShippingAddress

ContactDetails

Name	Description	Value
contactName	Contact name of the person.	string (required)
emailList	List of Email-ids to be notified about job progress.	string[] (required)
mobile	Mobile number of the contact person.	string
phone	Phone number of the contact person.	string (required)
phoneExtension	Phone extension number of the contact person.	string

DisplayInfo

Name	Description	Value

EncryptionPreferences

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'

HierarchyInformation

Name	Description	Value
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

NotificationPreference

Name	Description	Value
sendNotification	Notification is required or not.	bool (required)
stageName	Name of the stage.	'Delivered' 'Shipped' (required)

OrderItemDetails

Name	Description	Value
notificationEmailList	Additional notification email list.	string[]
orderItemMode	Defines the mode of the Order item.	'Default' 'DoNotFulfill'
orderItemType	Order item type.	'Purchase' 'Rental' (required)
preferences	Customer notification Preferences.	Preferences
productDetails	Unique identifier for configuration.	ProductDetails (required)

OrderItemProperties

Name	Description	Value
addressDetails	Represents shipping and return address for order item.	AddressDetails (required)
orderId	Id of the order to which order item belongs to.	string (required)
orderItemDetails	Represents order item details.	OrderItemDetails (required)

Preferences

Name	Description	Value
encryptionPreferences	Preferences related to the Encryption.	EncryptionPreferences
managementResourcePreferences	Preferences related to the Management resource.	ManagementResourcePreferences
notificationPreferences	Notification preferences.	NotificationPreference[]
transportPreferences	Preferences related to the shipment logistics of the order.	TransportPreferences

ProductDetails

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[]

ShippingAddress

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 (required)
streetAddress2	Street Address line 2.	string
streetAddress3	Street Address line 3.	string
zipExtendedCode	Extended Zip Code.	string

TrackedResourceTags

Name	Description	Value

TransportPreferences

Name	Description	Value
preferredShipmentType	Indicates Shipment Logistics type that the customer preferred.	'CustomerManaged' 'MicrosoftManaged' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The orderItems resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EdgeOrder/orderItems resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EdgeOrder/orderItems@2022-05-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressDetails = {
        forwardAddress = {
          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"
            }
          ]
          transportPreferences = {
            preferredShipmentType = "string"
          }
        }
        productDetails = {
          displayInfo = {
          }
          hierarchyInformation = {
            configurationName = "string"
            productFamilyName = "string"
            productLineName = "string"
            productName = "string"
          }
          optInAdditionalConfigurations = [
            {
              hierarchyInformation = {
                configurationName = "string"
                productFamilyName = "string"
                productLineName = "string"
                productName = "string"
              }
              quantity = int
            }
          ]
        }
      }
    }
  }
}

Property Values

Microsoft.EdgeOrder/orderItems

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Order item properties.	OrderItemProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.EdgeOrder/orderItems@2022-05-01-preview"

AdditionalConfiguration

Name	Description	Value
hierarchyInformation	Hierarchy of the product which uniquely identifies the configuration.	HierarchyInformation (required)
quantity	Quantity of the product.	int (required)

AddressDetails

Name	Description	Value
forwardAddress	Customer address and contact details.	AddressProperties (required)

AddressProperties

Name	Description	Value
contactDetails	Contact details for the address.	ContactDetails (required)
shippingAddress	Shipping details for the address.	ShippingAddress

ContactDetails

Name	Description	Value
contactName	Contact name of the person.	string (required)
emailList	List of Email-ids to be notified about job progress.	string[] (required)
mobile	Mobile number of the contact person.	string
phone	Phone number of the contact person.	string (required)
phoneExtension	Phone extension number of the contact person.	string

DisplayInfo

Name	Description	Value

EncryptionPreferences

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'

HierarchyInformation

Name	Description	Value
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

NotificationPreference

Name	Description	Value
sendNotification	Notification is required or not.	bool (required)
stageName	Name of the stage.	'Delivered' 'Shipped' (required)

OrderItemDetails

Name	Description	Value
notificationEmailList	Additional notification email list.	string[]
orderItemMode	Defines the mode of the Order item.	'Default' 'DoNotFulfill'
orderItemType	Order item type.	'Purchase' 'Rental' (required)
preferences	Customer notification Preferences.	Preferences
productDetails	Unique identifier for configuration.	ProductDetails (required)

OrderItemProperties

Name	Description	Value
addressDetails	Represents shipping and return address for order item.	AddressDetails (required)
orderId	Id of the order to which order item belongs to.	string (required)
orderItemDetails	Represents order item details.	OrderItemDetails (required)

Preferences

Name	Description	Value
encryptionPreferences	Preferences related to the Encryption.	EncryptionPreferences
managementResourcePreferences	Preferences related to the Management resource.	ManagementResourcePreferences
notificationPreferences	Notification preferences.	NotificationPreference[]
transportPreferences	Preferences related to the shipment logistics of the order.	TransportPreferences

ProductDetails

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[]

ShippingAddress

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 (required)
streetAddress2	Street Address line 2.	string
streetAddress3	Street Address line 3.	string
zipExtendedCode	Extended Zip Code.	string

TrackedResourceTags

Name	Description	Value

TransportPreferences

Name	Description	Value
preferredShipmentType	Indicates Shipment Logistics type that the customer preferred.	'CustomerManaged' 'MicrosoftManaged' (required)

Share via

Microsoft.EdgeOrder orderItems 2022-05-01-preview

Bicep resource definition

Resource format

Property Values

Microsoft.EdgeOrder/orderItems

AdditionalConfiguration

AddressDetails

AddressProperties

ContactDetails

DisplayInfo

EncryptionPreferences

HierarchyInformation

ManagementResourcePreferences

NotificationPreference

OrderItemDetails

OrderItemProperties

Preferences

ProductDetails

ShippingAddress

TrackedResourceTags

TransportPreferences

ARM template resource definition

Resource format

Property Values

Microsoft.EdgeOrder/orderItems

AdditionalConfiguration

AddressDetails

AddressProperties

ContactDetails

DisplayInfo

EncryptionPreferences

HierarchyInformation

ManagementResourcePreferences

NotificationPreference

OrderItemDetails

OrderItemProperties

Preferences

ProductDetails

ShippingAddress

TrackedResourceTags

TransportPreferences

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.EdgeOrder/orderItems

AdditionalConfiguration

AddressDetails

AddressProperties

ContactDetails

DisplayInfo

EncryptionPreferences

HierarchyInformation

ManagementResourcePreferences

NotificationPreference

OrderItemDetails

OrderItemProperties

Preferences

ProductDetails

ShippingAddress

TrackedResourceTags

TransportPreferences

Feedback

Additional resources