Address - Validate

Service:

Billing

API Version:

2024-04-01

Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.

POST https://management.azure.com/providers/Microsoft.Billing/validateAddress?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.

Request Body

Name	Required	Type	Description
addressLine1	True	string	Address line 1.
country	True	string	Country code uses ISO 3166-1 Alpha-2 format.
addressLine2		string	Address line 2.
addressLine3		string	Address line 3.
city		string	Address city.
companyName		string	Company name. Optional for MCA Individual (Pay-as-you-go).
district		string	Address district.
email		string	Email address.
firstName		string	First name. Optional for MCA Enterprise.
isValidAddress		boolean	Indicates if the address is incomplete.
lastName		string	Last name. Optional for MCA Enterprise.
middleName		string	Middle name.
phoneNumber		string	Phone number.
postalCode		string	Postal code.
region		string	Address region.

Responses

Name	Type	Description
200 OK	AddressValidationResponse	Result of the address validation.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

AddressValidateInvalid

AddressValidateValid

AddressValidateInvalid

Sample request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/validateAddress?api-version=2024-04-01

{
  "addressLine1": "1 Test",
  "city": "bellevue",
  "country": "us",
  "postalCode": "12345",
  "region": "wa"
}

Java

import com.azure.resourcemanager.billing.models.AddressDetails;

/**
 * Samples for Address Validate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json
     */
    /**
     * Sample code: AddressValidateInvalid.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void addressValidateInvalid(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.address().validateWithResponse(new AddressDetails().withAddressLine1("1 Test").withCity("bellevue")
            .withCountry("us").withPostalCode("fakeTokenPlaceholder").withRegion("wa"),
            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.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python address_validate_invalid.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 = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.address.validate(
        parameters={
            "addressLine1": "1 Test",
            "city": "bellevue",
            "country": "us",
            "postalCode": "12345",
            "region": "wa",
        },
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.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 armbilling_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/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json
func ExampleAddressClient_Validate_addressValidateInvalid() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAddressClient().Validate(ctx, armbilling.AddressDetails{
		AddressLine1: to.Ptr("1 Test"),
		City:         to.Ptr("bellevue"),
		Country:      to.Ptr("us"),
		PostalCode:   to.Ptr("12345"),
		Region:       to.Ptr("wa"),
	}, 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.AddressValidationResponse = armbilling.AddressValidationResponse{
	// 	Status: to.Ptr(armbilling.AddressValidationStatusInvalid),
	// 	SuggestedAddresses: []*armbilling.AddressDetails{
	// 		{
	// 			AddressLine1: to.Ptr("1 Test Address"),
	// 			City: to.Ptr("Bellevue"),
	// 			Country: to.Ptr("US"),
	// 			PostalCode: to.Ptr("98052"),
	// 			Region: to.Ptr("WA"),
	// 		},
	// 		{
	// 			AddressLine1: to.Ptr("1 Test Address"),
	// 			City: to.Ptr("Bellevue"),
	// 			Country: to.Ptr("US"),
	// 			PostalCode: to.Ptr("12345-0000"),
	// 			Region: to.Ptr("WA"),
	// 	}},
	// 	ValidationMessage: to.Ptr("Invalid address"),
	// }
}

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 { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
 *
 * @summary Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json
 */
async function addressValidateInvalid() {
  const parameters = {
    addressLine1: "1 Test",
    city: "bellevue",
    country: "us",
    postalCode: "12345",
    region: "wa",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.address.validate(parameters);
  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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json
// this example is just showing the usage of "Address_Validate" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
BillingAddressDetails details = new BillingAddressDetails("1 Test", "us")
{
    City = "bellevue",
    PostalCode = "12345",
    Region = "wa",
};
BillingAddressValidationResult result = await tenantResource.ValidateAddresAsync(details);

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

{
  "status": "Invalid",
  "suggestedAddresses": [
    {
      "addressLine1": "1 Test Address",
      "city": "Bellevue",
      "country": "US",
      "postalCode": "98052",
      "region": "WA"
    },
    {
      "addressLine1": "1 Test Address",
      "city": "Bellevue",
      "country": "US",
      "postalCode": "12345-0000",
      "region": "WA"
    }
  ],
  "validationMessage": "Invalid address"
}

AddressValidateValid

Sample request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/validateAddress?api-version=2024-04-01

{
  "addressLine1": "1 Test",
  "city": "bellevue",
  "country": "us",
  "postalCode": "12345",
  "region": "wa"
}

Java

import com.azure.resourcemanager.billing.models.AddressDetails;

/**
 * Samples for Address Validate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json
     */
    /**
     * Sample code: AddressValidateValid.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void addressValidateValid(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.address().validateWithResponse(new AddressDetails().withAddressLine1("1 Test").withCity("bellevue")
            .withCountry("us").withPostalCode("fakeTokenPlaceholder").withRegion("wa"),
            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.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python address_validate_valid.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 = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.address.validate(
        parameters={
            "addressLine1": "1 Test",
            "city": "bellevue",
            "country": "us",
            "postalCode": "12345",
            "region": "wa",
        },
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.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 armbilling_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/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json
func ExampleAddressClient_Validate_addressValidateValid() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAddressClient().Validate(ctx, armbilling.AddressDetails{
		AddressLine1: to.Ptr("1 Test"),
		City:         to.Ptr("bellevue"),
		Country:      to.Ptr("us"),
		PostalCode:   to.Ptr("12345"),
		Region:       to.Ptr("wa"),
	}, 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.AddressValidationResponse = armbilling.AddressValidationResponse{
	// 	Status: to.Ptr(armbilling.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 { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
 *
 * @summary Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json
 */
async function addressValidateValid() {
  const parameters = {
    addressLine1: "1 Test",
    city: "bellevue",
    country: "us",
    postalCode: "12345",
    region: "wa",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.address.validate(parameters);
  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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json
// this example is just showing the usage of "Address_Validate" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
BillingAddressDetails details = new BillingAddressDetails("1 Test", "us")
{
    City = "bellevue",
    PostalCode = "12345",
    Region = "wa",
};
BillingAddressValidationResult result = await tenantResource.ValidateAddresAsync(details);

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

{
  "status": "Valid"
}

Definitions

Name	Description
AddressDetails	Address details.
AddressValidationResponse	Result of the address validation.
AddressValidationStatus	Status of the address validation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

AddressDetails

Address details.

Name	Type	Description
addressLine1	string	Address line 1.
addressLine2	string	Address line 2.
addressLine3	string	Address line 3.
city	string	Address city.
companyName	string	Company name. Optional for MCA Individual (Pay-as-you-go).
country	string	Country code uses ISO 3166-1 Alpha-2 format.
district	string	Address district.
email	string	Email address.
firstName	string	First name. Optional for MCA Enterprise.
isValidAddress	boolean	Indicates if the address is incomplete.
lastName	string	Last name. Optional for MCA Enterprise.
middleName	string	Middle name.
phoneNumber	string	Phone number.
postalCode	string	Postal code.
region	string	Address region.

AddressValidationResponse

Result of the address validation.

Name	Type	Description
status	AddressValidationStatus	Status of the address validation.
suggestedAddresses	AddressDetails[]	The list of suggested addresses.
validationMessage	string	Validation error message.

AddressValidationStatus

Status of the address validation.

Name	Type	Description
Invalid	string
Other	string
Valid	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.