Microsoft.DataBoxEdge dataBoxEdgeDevices/orders 2022-04-01-preview

Bicep resource definition

The dataBoxEdgeDevices/orders resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    contactInformation: {
      companyName: 'string'
      contactPerson: 'string'
      emailList: [
        'string'
      ]
      phone: 'string'
    }
    shipmentType: 'string'
    shippingAddress: {
      addressLine1: 'string'
      addressLine2: 'string'
      addressLine3: 'string'
      city: 'string'
      country: 'string'
      postalCode: 'string'
      state: 'string'
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders

Name Description Value
name The resource name 'default' (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: dataBoxEdgeDevices
properties The order properties. OrderProperties

Address

Name Description Value
addressLine1 The address line1. string
addressLine2 The address line2. string
addressLine3 The address line3. string
city The city name. string
country The country name. string (required)
postalCode The postal code. string
state The state name. string

ContactDetails

Name Description Value
companyName The name of the company. string (required)
contactPerson The contact person name. string (required)
emailList The email list. string[] (required)
phone The phone number. string (required)

OrderProperties

Name Description Value
contactInformation The contact details. ContactDetails
shipmentType ShipmentType of the order 'NotApplicable'
'SelfPickup'
'ShippedToCustomer'
shippingAddress The shipping address. Address

ARM template resource definition

The dataBoxEdgeDevices/orders resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "contactInformation": {
      "companyName": "string",
      "contactPerson": "string",
      "emailList": [ "string" ],
      "phone": "string"
    },
    "shipmentType": "string",
    "shippingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "state": "string"
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders

Name Description Value
apiVersion The api version '2022-04-01-preview'
name The resource name 'default' (required)
properties The order properties. OrderProperties
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders'

Address

Name Description Value
addressLine1 The address line1. string
addressLine2 The address line2. string
addressLine3 The address line3. string
city The city name. string
country The country name. string (required)
postalCode The postal code. string
state The state name. string

ContactDetails

Name Description Value
companyName The name of the company. string (required)
contactPerson The contact person name. string (required)
emailList The email list. string[] (required)
phone The phone number. string (required)

OrderProperties

Name Description Value
contactInformation The contact details. ContactDetails
shipmentType ShipmentType of the order 'NotApplicable'
'SelfPickup'
'ShippedToCustomer'
shippingAddress The shipping address. Address

Terraform (AzAPI provider) resource definition

The dataBoxEdgeDevices/orders 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.DataBoxEdge/dataBoxEdgeDevices/orders resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      contactInformation = {
        companyName = "string"
        contactPerson = "string"
        emailList = [
          "string"
        ]
        phone = "string"
      }
      shipmentType = "string"
      shippingAddress = {
        addressLine1 = "string"
        addressLine2 = "string"
        addressLine3 = "string"
        city = "string"
        country = "string"
        postalCode = "string"
        state = "string"
      }
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: dataBoxEdgeDevices
properties The order properties. OrderProperties
type The resource type "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-04-01-preview"

Address

Name Description Value
addressLine1 The address line1. string
addressLine2 The address line2. string
addressLine3 The address line3. string
city The city name. string
country The country name. string (required)
postalCode The postal code. string
state The state name. string

ContactDetails

Name Description Value
companyName The name of the company. string (required)
contactPerson The contact person name. string (required)
emailList The email list. string[] (required)
phone The phone number. string (required)

OrderProperties

Name Description Value
contactInformation The contact details. ContactDetails
shipmentType ShipmentType of the order 'NotApplicable'
'SelfPickup'
'ShippedToCustomer'
shippingAddress The shipping address. Address