Service - Region Configuration

Service:: Data Box

API Version:: 2025-07-01

This API provides configuration details specific to given region/location at Subscription level.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration?api-version=2025-07-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of Azure region.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
datacenterAddressRequest	DatacenterAddressRequest	Request body to get the datacenter address for given sku.
deviceCapabilityRequest	DeviceCapabilityRequest	Request body to get the device capabilities for a given sku.
scheduleAvailabilityRequest	ScheduleAvailabilityRequest: DataBoxScheduleAvailabilityRequest DiskScheduleAvailabilityRequest HeavyScheduleAvailabilityRequest	Request body to get the availability for scheduling orders.
transportAvailabilityRequest	TransportAvailabilityRequest	Request body to get the transport availability for given sku.

Responses

Name	Type	Description
200 OK	RegionConfigurationResponse	The request has succeeded.
Other Status Codes	ApiError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RegionConfiguration

Sample request

HTTP

POST https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.DataBox/locations/westus/regionConfiguration?api-version=2025-07-01

{
  "deviceCapabilityRequest": {
    "model": "DataBoxDisk",
    "skuName": "DataBoxDisk"
  },
  "scheduleAvailabilityRequest": {
    "model": "DataBox",
    "skuName": "DataBox",
    "storageLocation": "westus"
  }
}

Sample response

Status code:: 200

{
  "deviceCapabilityResponse": {
    "deviceCapabilityDetails": [
      {
        "hardwareEncryption": "Enabled"
      }
    ]
  },
  "scheduleAvailabilityResponse": {
    "availableDates": [
      "2019-07-11T00:00:00+00:00",
      "2019-07-12T00:00:00+00:00",
      "2019-07-13T00:00:00+00:00",
      "2019-07-14T00:00:00+00:00",
      "2019-07-15T00:00:00+00:00",
      "2019-07-16T00:00:00+00:00",
      "2019-07-17T00:00:00+00:00",
      "2019-07-18T00:00:00+00:00",
      "2019-07-19T00:00:00+00:00",
      "2019-07-20T00:00:00+00:00",
      "2019-07-21T00:00:00+00:00",
      "2019-07-22T00:00:00+00:00",
      "2019-07-23T00:00:00+00:00",
      "2019-07-24T00:00:00+00:00",
      "2019-07-25T00:00:00+00:00",
      "2019-07-26T00:00:00+00:00",
      "2019-07-27T00:00:00+00:00",
      "2019-07-28T00:00:00+00:00",
      "2019-07-29T00:00:00+00:00",
      "2019-07-30T00:00:00+00:00",
      "2019-07-31T00:00:00+00:00"
    ]
  }
}

Definitions

Name	Description
ApiError
DataBoxScheduleAvailabilityRequest	Request body to get the availability for scheduling data box orders orders.
DatacenterAddressInstructionResponse	Datacenter instruction for given storage location.
DatacenterAddressLocationResponse	Datacenter address for given storage location.
DatacenterAddressRequest	Request body to get the datacenter address.
DatacenterAddressType	Data center address type
Details
DeviceCapabilityDetails	Device capability details for a given sku for a given region.
DeviceCapabilityRequest	Request body to get the device capabilities for given sku.
DeviceCapabilityResponse	Device capabilities for given sku in a region
DiskScheduleAvailabilityRequest	Request body to get the availability for scheduling disk orders.
ErrorDetail
HardwareEncryption	Hardware encryption support for a given sku for a given region.
HeavyScheduleAvailabilityRequest	Request body to get the availability for scheduling heavy orders.
ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
RegionConfigurationRequest	Request body to get the configuration for the region.
RegionConfigurationResponse	Configuration response specific to a region.
ScheduleAvailabilityResponse	Schedule availability for given sku in a region.
SkuName	SKU names.
TransportAvailabilityDetails	Transport options availability details for given region.
TransportAvailabilityRequest	Request body to get the transport availability for given sku.
TransportAvailabilityResponse	Transport options available for given sku in a region.
TransportShipmentTypes	Transport Shipment Type supported for given region.

ApiError

Object

Name	Type	Description
error	ErrorDetail	The error detail.

DataBoxScheduleAvailabilityRequest

Object

Request body to get the availability for scheduling data box orders orders.

Name	Type	Description
country	string	Country in which storage location should be supported.
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	string: DataBox	Sku Name for which the order is to be scheduled.
storageLocation	string	Location for data transfer. For locations check: `https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01`

DatacenterAddressInstructionResponse

Object

Datacenter instruction for given storage location.

Name	Type	Description
communicationInstruction	string	Data center communication instruction
dataCenterAzureLocation	string	Azure Location where the Data Center serves primarily.
datacenterAddressType	string: DatacenterAddressInstruction	Data center address type
supportedCarriersForReturnShipment	string[]	List of supported carriers for return shipment.

DatacenterAddressLocationResponse

Object

Datacenter address for given storage location.

Name	Type	Description
additionalShippingInformation	string	Special instruction for shipping
addressType	string	Address type
city	string	City name
company	string	Company name
contactPersonName	string	Contact person name
country	string	name of the country
dataCenterAzureLocation	string	Azure Location where the Data Center serves primarily.
datacenterAddressType	string: DatacenterAddressLocation	Data center address type
phone	string	Phone number
phoneExtension	string	Phone extension
state	string	name of the state
street1	string	Street address line 1
street2	string	Street address line 2
street3	string	Street address line 3
supportedCarriersForReturnShipment	string[]	List of supported carriers for return shipment.
zip	string	Zip code

DatacenterAddressRequest

Object

Request body to get the datacenter address.

Name	Type	Description
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	SkuName	Sku Name for which the data center address requested.
storageLocation	string	Storage location. For locations check: `https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01`

DatacenterAddressType

Enumeration

Data center address type

Value	Description
DatacenterAddressLocation	Data center address location.
DatacenterAddressInstruction	Data center address instruction.

Details

Object

Name	Type	Description
code	string	Error code.
message	string	Error message.

DeviceCapabilityDetails

Object

Device capability details for a given sku for a given region.

Name	Type	Description
hardwareEncryption	HardwareEncryption	Hardware encryption support for a given sku for a given region.

DeviceCapabilityRequest

Object

Request body to get the device capabilities for given sku.

Name	Type	Description
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	SkuName	Type of the device.

DeviceCapabilityResponse

Object

Device capabilities for given sku in a region

Name	Type	Description
deviceCapabilityDetails	DeviceCapabilityDetails[]	List of device capabilities available for a given region and a given sku

DiskScheduleAvailabilityRequest

Object

Request body to get the availability for scheduling disk orders.

Name	Type	Description
country	string	Country in which storage location should be supported.
expectedDataSizeInTeraBytes	integer (int32)	The expected size of the data, which needs to be transferred in this job, in terabytes.
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	string: DataBoxDisk	Sku Name for which the order is to be scheduled.
storageLocation	string	Location for data transfer. For locations check: `https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01`

ErrorDetail

Object

Name	Type	Description
code	string	Error code.
details	Details[]	Error target.
message	string	Error message.
target	string	Additional error info.

HardwareEncryption

Enumeration

Hardware encryption support for a given sku for a given region.

Value	Description
Enabled	Hardware-based encryption is enabled.
Disabled	Hardware-based encryption is disabled.

HeavyScheduleAvailabilityRequest

Object

Request body to get the availability for scheduling heavy orders.

Name	Type	Description
country	string	Country in which storage location should be supported.
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	string: DataBoxHeavy	Sku Name for which the order is to be scheduled.
storageLocation	string	Location for data transfer. For locations check: `https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01`

ModelName

Enumeration

The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025

Value	Description
DataBox	Data Box.
DataBoxDisk	Data Box Disk.
DataBoxHeavy	Data Box Heavy.
DataBoxCustomerDisk	Data Box Customer Disk
AzureDataBox120	Data Box V2 with 120TB usable capacity.
AzureDataBox525	Data Box V2 with 525TB usable capacity.

RegionConfigurationRequest

Object

Request body to get the configuration for the region.

Name	Type	Description
datacenterAddressRequest	DatacenterAddressRequest	Request body to get the datacenter address for given sku.
deviceCapabilityRequest	DeviceCapabilityRequest	Request body to get the device capabilities for a given sku.
scheduleAvailabilityRequest	ScheduleAvailabilityRequest: DataBoxScheduleAvailabilityRequest DiskScheduleAvailabilityRequest HeavyScheduleAvailabilityRequest	Request body to get the availability for scheduling orders.
transportAvailabilityRequest	TransportAvailabilityRequest	Request body to get the transport availability for given sku.

RegionConfigurationResponse

Object

Configuration response specific to a region.

Name	Type	Description
datacenterAddressResponse	DatacenterAddressResponse: DatacenterAddressInstructionResponse DatacenterAddressLocationResponse	Datacenter address for given sku in a region.
deviceCapabilityResponse	DeviceCapabilityResponse	Device capabilities available for a given sku in a region.
scheduleAvailabilityResponse	ScheduleAvailabilityResponse	Schedule availability for given sku in a region.
transportAvailabilityResponse	TransportAvailabilityResponse	Transport options available for given sku in a region.

ScheduleAvailabilityResponse

Object

Schedule availability for given sku in a region.

Name	Type	Description
availableDates	string[] (date-time)	List of dates available to schedule

SkuName

Enumeration

SKU names.

Value	Description
DataBox	Data Box.
DataBoxDisk	Data Box Disk.
DataBoxHeavy	Data Box Heavy.
DataBoxCustomerDisk	Data Box Customer Disk

TransportAvailabilityDetails

Object

Transport options availability details for given region.

Name	Type	Description
shipmentType	TransportShipmentTypes	Transport Shipment Type supported for given region.

TransportAvailabilityRequest

Object

Request body to get the transport availability for given sku.

Name	Type	Description
model	ModelName	The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. AzureDataBox120 and AzureDataBox525 as of Feb/2025
skuName	SkuName	Type of the device.

TransportAvailabilityResponse

Object

Transport options available for given sku in a region.

Name	Type	Description
transportAvailabilityDetails	TransportAvailabilityDetails[]	List of transport availability details for given region

TransportShipmentTypes

Enumeration

Transport Shipment Type supported for given region.

Value	Description
CustomerManaged	Shipment Logistics is handled by the customer.
MicrosoftManaged	Shipment Logistics is handled by Microsoft.

Share via

Service - Region Configuration

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

RegionConfiguration

Sample request

Sample response

Definitions

ApiError

DataBoxScheduleAvailabilityRequest

DatacenterAddressInstructionResponse

DatacenterAddressLocationResponse

DatacenterAddressRequest

DatacenterAddressType

Details

DeviceCapabilityDetails

DeviceCapabilityRequest

DeviceCapabilityResponse

DiskScheduleAvailabilityRequest

ErrorDetail

HardwareEncryption

HeavyScheduleAvailabilityRequest

ModelName

RegionConfigurationRequest

RegionConfigurationResponse

ScheduleAvailabilityResponse

SkuName

TransportAvailabilityDetails

TransportAvailabilityRequest

TransportAvailabilityResponse

TransportShipmentTypes