Skip to content

azurermDataboxEdgeOrder

Manages a Databox Edge Order.

!> Creation of Databox Edge Order is not supported by the Azure API - as such the azurermDataboxEdgeOrder resource is deprecated and will be removed in v4.0 of the AzureRM Provider.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-databoxedge",
  }
);
const azurermDataboxEdgeDeviceExample =
  new azurerm.databoxEdgeDevice.DataboxEdgeDevice(this, "example_1", {
    location: azurermResourceGroupExample.location,
    name: "example-device",
    resource_group_name: azurermResourceGroupExample.name,
    sku_name: "EdgeP_Base-Standard",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataboxEdgeDeviceExample.overrideLogicalId("example");
const azurermDataboxEdgeOrderExample =
  new azurerm.databoxEdgeOrder.DataboxEdgeOrder(this, "example_2", {
    contact: [
      {
        company_name: "Flynn's Arcade",
        emails: ["creator4983@FlynnsArcade.com"],
        name: "TerraForm Test",
        phone_number: "(800) 555-1234",
      },
    ],
    device_name: azurermDataboxEdgeDeviceExample.name,
    resource_group_name: azurermResourceGroupExample.name,
    shipment_address: [
      {
        address: ["One Microsoft Way"],
        city: "Redmond",
        country: "United States",
        postal_code: "98052",
        state: "WA",
      },
    ],
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataboxEdgeOrderExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

  • resourceGroupName - (Required) The name of the Resource Group where the Databox Edge Order should exist. Changing this forces a new Databox Edge Order to be created.

  • deviceName - (Required) The name of the Databox Edge Device this order is for. Changing this forces a new Databox Edge Order to be created.

  • contact - (Required) A contact block as defined below.

  • shipmentAddress - (Required) A shipmentAddress block as defined below.

An contact block includes the following:

  • companyName - (Required) The name of the company. Changing this forces a new Databox Edge Order to be created.

  • name - (Required) The contact person name. Changing this forces a new Databox Edge Order to be created.

  • emails - (Required) A list of email address to send order notification to. Changing this forces a new Databox Edge Order to be created.

  • phoneNumber - (Required) The phone number. Changing this forces a new Databox Edge Order to be created.

An shipmentAddress block includes the following:

  • address - (Required) The list of upto 3 lines for address information.

  • city - (Required) The city name. Changing this forces a new Databox Edge Order to be created.

  • country - (Required) The name of the country to ship the Databox Edge Device to. Valid values are "Algeria", "Argentina", "Australia", "Austria", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belgium", "Bermuda", "Bolivia", "Bosnia and Herzegovina", "Brazil", "Bulgaria", "Canada", "Cayman Islands", "Chile", "Colombia", "Costa Rica", "Croatia", "Cyprus", "Czechia", "Côte D'ivoire", "Denmark", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Estonia", "Ethiopia", "Finland", "France", "Georgia", "Germany", "Ghana", "Greece", "Guatemala", "Honduras", "Hong Kong SAR", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Jamaica", "Japan", "Jordan", "Kazakhstan", "Kenya", "Kuwait", "Kyrgyzstan", "Latvia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao SAR", "Malaysia", "Malta", "Mauritius", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Morocco", "Namibia", "Nepal", "Netherlands", "New Zealand", "Nicaragua", "Nigeria", "Norway", "Oman", "Pakistan", "Palestinian Authority", "Panama", "Paraguay", "Peru", "Philippines", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of Korea", "Romania", "Russia", "Rwanda", "Saint Kitts And Nevis", "Saudi Arabia", "Senegal", "Serbia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sri Lanka", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Trinidad And Tobago", "Tunisia", "Turkey", "Turkmenistan", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "Uruguay", "Uzbekistan", "Venezuela", "Vietnam", "Yemen", "Zambia" or "Zimbabwe". Changing this forces a new Databox Edge Order to be created.

  • postalCode - (Required) The postal code. Changing this forces a new Databox Edge Order to be created.

  • state - (Required) The name of the state to ship the Databox Edge Device to. Changing this forces a new Databox Edge Order to be created.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Databox Edge Order.

  • name - The Name of this Databox Edge Order.

  • shipmentTracking - Tracking information for the package delivered to the customer whether it has an original or a replacement device. A shipmentTracking block as defined below.

  • status - The current status of the order. A status block as defined below.

  • shipmentHistory - List of status changes in the order. A shipmentHistory block as defined below.

  • returnTracking - Tracking information for the package returned from the customer whether it has an original or a replacement device. A returnTracking block as defined below.

  • serialNumber - Serial number of the device.

A shipmentTracking block exports the following:

  • carrierName - Name of the carrier used in the delivery.

  • serialNumber - Serial number of the device being tracked.

  • trackingId - The ID of the tracking.

  • trackingUrl - Tracking URL of the shipment.

A status block exports the following:

  • info - The current status of the order. Possible values include untracked, awaitingFulfilment, awaitingPreparation, awaitingShipment, shipped, arriving, delivered, replacementRequested, lostDevice, declined, returnInitiated, awaitingReturnShipment, shippedBack or collectedAtMicrosoft.

  • additionalDetails - Dictionary to hold generic information which is not stored by the already existing properties.

  • comments - Comments related to this status change.

  • lastUpdate - Time of status update.

A shipmentHistory block exports the following:

  • additionalDetails - Dictionary to hold generic information which is not stored by the already existing properties.

  • comments - Comments related to this status change.

  • lastUpdate - Time of status update.

A returnTracking block exports the following:

  • carrierName - Name of the carrier used in the delivery.

  • serialNumber - Serial number of the device being tracked.

  • trackingId - The ID of the tracking.

  • trackingUrl - Tracking URL of the shipment.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating a Databox Edge Order.
  • read - (Defaults to 5 minutes) Used when retrieving a Databox Edge Order.
  • update - (Defaults to 30 minutes) Used when updating a Databox Edge Order.
  • delete - (Defaults to 30 minutes) Used when deleting a Databox Edge Order.

Import

Databox Edge Orders can be imported using the resourceId, e.g.

terraform import azurerm_databox_edge_order.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/device1