Service - Validate Address

Service:

Data Box

API Version:

2025-02-01

[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The location of the resource
subscriptionId	path	True	string	The Subscription Id
api-version	query	True	string	The API Version

Request Body

Name	Required	Type	Description
deviceType	True	SkuName	Device type to be used for the job.
shippingAddress	True	ShippingAddress	Shipping address of the customer.
validationType	True	string: ValidateAddress	Identifies the type of validation request.
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
transportPreferences		TransportPreferences	Preferences related to the shipment logistics of the sku.

Responses

Name	Type	Description
200 OK	AddressValidationOutput	The valid and alternate addresses.
Other Status Codes	ApiError	Error response describing reason for operation failure.

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

ValidateAddressPost

Sample request

HTTP

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

{
  "validationType": "ValidateAddress",
  "shippingAddress": {
    "streetAddress1": "XXXX XXXX",
    "streetAddress2": "XXXX XXXX",
    "city": "XXXX XXXX",
    "stateOrProvince": "XX",
    "country": "XX",
    "postalCode": "00000",
    "companyName": "XXXX XXXX",
    "addressType": "Commercial"
  },
  "deviceType": "DataBox",
  "model": "DataBox"
}

Java

import com.azure.resourcemanager.databox.models.AddressType;
import com.azure.resourcemanager.databox.models.ModelName;
import com.azure.resourcemanager.databox.models.ShippingAddress;
import com.azure.resourcemanager.databox.models.SkuName;
import com.azure.resourcemanager.databox.models.ValidateAddress;

/**
 * Samples for Service ValidateAddress.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/databox/resource-manager/Microsoft.DataBox/stable/2025-02-01/examples/ValidateAddressPost.json
     */
    /**
     * Sample code: ValidateAddressPost.
     * 
     * @param manager Entry point to DataBoxManager.
     */
    public static void validateAddressPost(com.azure.resourcemanager.databox.DataBoxManager manager) {
        manager.services().validateAddressWithResponse("westus",
            new ValidateAddress()
                .withShippingAddress(new ShippingAddress().withStreetAddress1("XXXX XXXX")
                    .withStreetAddress2("XXXX XXXX").withCity("XXXX XXXX").withStateOrProvince("XX").withCountry("XX")
                    .withPostalCode("fakeTokenPlaceholder").withCompanyName("XXXX XXXX")
                    .withAddressType(AddressType.COMMERCIAL))
                .withDeviceType(SkuName.DATA_BOX).withModel(ModelName.DATA_BOX),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.databox import DataBoxManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-databox
# USAGE
    python validate_address_post.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataBoxManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="YourSubscriptionId",
    )

    response = client.service.validate_address(
        location="westus",
        validate_address={
            "deviceType": "DataBox",
            "model": "DataBox",
            "shippingAddress": {
                "addressType": "Commercial",
                "city": "XXXX XXXX",
                "companyName": "XXXX XXXX",
                "country": "XX",
                "postalCode": "00000",
                "stateOrProvince": "XX",
                "streetAddress1": "XXXX XXXX",
                "streetAddress2": "XXXX XXXX",
            },
            "validationType": "ValidateAddress",
        },
    )
    print(response)


# x-ms-original-file: specification/databox/resource-manager/Microsoft.DataBox/stable/2025-02-01/examples/ValidateAddressPost.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatabox_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databox/armdatabox/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cecf11996f2bfc7958f6d0de814badab23f9720/specification/databox/resource-manager/Microsoft.DataBox/stable/2025-02-01/examples/ValidateAddressPost.json
func ExampleServiceClient_ValidateAddress() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatabox.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServiceClient().ValidateAddress(ctx, "westus", armdatabox.ValidateAddress{
		ValidationType: to.Ptr(armdatabox.ValidationInputDiscriminatorValidateAddress),
		DeviceType:     to.Ptr(armdatabox.SKUNameDataBox),
		Model:          to.Ptr(armdatabox.ModelNameDataBox),
		ShippingAddress: &armdatabox.ShippingAddress{
			AddressType:     to.Ptr(armdatabox.AddressTypeCommercial),
			City:            to.Ptr("XXXX XXXX"),
			CompanyName:     to.Ptr("XXXX XXXX"),
			Country:         to.Ptr("XX"),
			PostalCode:      to.Ptr("00000"),
			StateOrProvince: to.Ptr("XX"),
			StreetAddress1:  to.Ptr("XXXX XXXX"),
			StreetAddress2:  to.Ptr("XXXX XXXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AddressValidationOutput = armdatabox.AddressValidationOutput{
	// 	Properties: &armdatabox.AddressValidationProperties{
	// 		ValidationType: to.Ptr(armdatabox.ValidationInputDiscriminatorValidateAddress),
	// 		AlternateAddresses: []*armdatabox.ShippingAddress{
	// 			{
	// 				AddressType: to.Ptr(armdatabox.AddressTypeNone),
	// 				City: to.Ptr("XXXX XXXX"),
	// 				Country: to.Ptr("XX"),
	// 				PostalCode: to.Ptr("00000"),
	// 				StateOrProvince: to.Ptr("XX"),
	// 				StreetAddress1: to.Ptr("XXXX XXXX"),
	// 				StreetAddress2: to.Ptr("XXXX XXXX"),
	// 				StreetAddress3: to.Ptr(""),
	// 		}},
	// 		ValidationStatus: to.Ptr(armdatabox.AddressValidationStatusValid),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataBoxManagementClient } = require("@azure/arm-databox");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to [DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.
 *
 * @summary [DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.
 * x-ms-original-file: specification/databox/resource-manager/Microsoft.DataBox/stable/2025-02-01/examples/ValidateAddressPost.json
 */
async function validateAddressPost() {
  const subscriptionId = process.env["DATABOX_SUBSCRIPTION_ID"] || "YourSubscriptionId";
  const location = "westus";
  const validateAddress = {
    deviceType: "DataBox",
    model: "DataBox",
    shippingAddress: {
      addressType: "Commercial",
      city: "XXXX XXXX",
      companyName: "XXXX XXXX",
      country: "XX",
      postalCode: "00000",
      stateOrProvince: "XX",
      streetAddress1: "XXXX XXXX",
      streetAddress2: "XXXX XXXX",
    },
    validationType: "ValidateAddress",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataBoxManagementClient(credential, subscriptionId);
  const result = await client.service.validateAddress(location, validateAddress);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataBox.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DataBox;

// Generated from example definition: specification/databox/resource-manager/Microsoft.DataBox/stable/2025-02-01/examples/ValidateAddressPost.json
// this example is just showing the usage of "Service_ValidateAddress" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "YourSubscriptionId";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("westus");
DataBoxValidateAddressContent content = new DataBoxValidateAddressContent(new DataBoxShippingAddress("XXXX XXXX", "XX")
{
    StreetAddress2 = "XXXX XXXX",
    City = "XXXX XXXX",
    StateOrProvince = "XX",
    PostalCode = "00000",
    CompanyName = "XXXX XXXX",
    AddressType = DataBoxShippingAddressType.Commercial,
}, DataBoxSkuName.DataBox)
{
    Model = DeviceModelName.DataBox,
};
AddressValidationOutput result = await subscriptionResource.ValidateAddressAsync(location, content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "validationStatus": "Valid",
    "alternateAddresses": [
      {
        "streetAddress1": "XXXX XXXX",
        "streetAddress2": "XXXX XXXX",
        "streetAddress3": "",
        "city": "XXXX XXXX",
        "stateOrProvince": "XX",
        "country": "XX",
        "postalCode": "00000",
        "addressType": "None"
      }
    ],
    "validationType": "ValidateAddress"
  }
}

Definitions

Name	Description
AdditionalErrorInfo	This class represents additional info which Resource Providers pass when an error occurs.
AddressType	Type of address.
AddressValidationOutput	Output of the address validation api.
AddressValidationStatus	The address validation status.
ApiError
CloudError	Provides additional information about an http error response.
Details
ErrorDetail
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
ShippingAddress	Shipping address where customer wishes to receive the device.
SkuName	Sku Names to filter for available skus
TransportPreferences	Preferences related to the shipment logistics of the sku
TransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred.
ValidateAddress	The requirements to validate customer address where the device needs to be shipped.

AdditionalErrorInfo

Object

This class represents additional info which Resource Providers pass when an error occurs.

Name	Type	Description
info	object	Additional information of the type of error.
type	string	Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation).

AddressType

Enumeration

Type of address.

Value	Description
None	Address type not known.
Residential	Residential Address.
Commercial	Commercial Address.

AddressValidationOutput

Object

Output of the address validation api.

Name	Type	Description
properties.alternateAddresses	ShippingAddress[]	List of alternate addresses.
properties.error	CloudError	Error code and message of validation response.
properties.validationStatus	AddressValidationStatus	The address validation status.
properties.validationType	ValidationInputDiscriminator	Identifies the type of validation response.

AddressValidationStatus

Enumeration

The address validation status.

Value	Description
Valid	Address provided is valid.
Invalid	Address provided is invalid or not supported.
Ambiguous	Address provided is ambiguous, please choose one of the alternate addresses returned.

ApiError

Object

Name	Type	Description
error	ErrorDetail

CloudError

Object

Provides additional information about an http error response.

Name	Type	Description
additionalInfo	AdditionalErrorInfo[]	Gets or sets additional error info.
code	string	Error code.
details	CloudError[]	Gets or sets details for the error.
message	string	The error message parsed from the body of the http error response.
target	string	Gets or sets the target of the error.

Details

Object

Name	Type	Description
code	string
message	string

ErrorDetail

Object

Name	Type	Description
code	string
details	Details[]
message	string
target	string

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 125TB usable capacity.
AzureDataBox525	Data Box V2 with 500TB usable capacity.

ShippingAddress

Object

Shipping address where customer wishes to receive the device.

Name	Type	Default value	Description
addressType	AddressType	None	Type of address.
city	string		Name of the City.
companyName	string		Name of the company.
country	string		Name of the Country.
postalCode	string		Postal code.
skipAddressValidation	boolean		Flag to indicate if customer has chosen to skip default address validation
stateOrProvince	string		Name of the State or Province.
streetAddress1	string		Street Address line 1.
streetAddress2	string		Street Address line 2.
streetAddress3	string		Street Address line 3.
taxIdentificationNumber	string		Tax Identification Number
zipExtendedCode	string		Extended Zip Code.

SkuName

Enumeration

Sku Names to filter for available skus

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

TransportPreferences

Object

Preferences related to the shipment logistics of the sku

Name	Type	Description
isUpdated	boolean	Read only property which indicates whether transport preferences has been updated or not after device is prepared.
preferredShipmentType	TransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred.

TransportShipmentTypes

Enumeration

Indicates Shipment Logistics type that the customer preferred.

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

ValidateAddress

Object

The requirements to validate customer address where the device needs to be shipped.

Name	Type	Description
deviceType	SkuName	Device type to be used for the job.
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
shippingAddress	ShippingAddress	Shipping address of the customer.
transportPreferences	TransportPreferences	Preferences related to the shipment logistics of the sku.
validationType	string: ValidateAddress	Identifies the type of validation request.