Address - Validate

Referencia

Servicio:: Billing

Versión de la API:: 2024-04-01

Valida una dirección. Use la operación para validar una dirección antes de usarla como soldTo o una dirección billTo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-04-01.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
addressLine1	True	string minLength: 1	Línea de dirección 1.
country	True	string minLength: 1	El código de país usa el formato ISO 3166-1 Alpha-2.
addressLine2		string	Línea de dirección 2.
addressLine3		string	Línea de dirección 3.
city		string	Ciudad de dirección.
companyName		string	Nombre de la compañía. Opcional para MCA Individual (pago por uso).
district		string	Distrito de direcciones.
email		string	Dirección de correo electrónico.
firstName		string	Nombre. Opcional para MCA Enterprise.
isValidAddress		boolean	Indica si la dirección está incompleta.
lastName		string	Apellido. Opcional para MCA Enterprise.
middleName		string	Segundo nombre.
phoneNumber		string	Número de teléfono.
postalCode		string	Código postal.
region		string	Región de direcciones.

Respuestas

Nombre	Tipo	Description
200 OK	AddressValidationResponse	Resultado de la validación de direcciones.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

AddressValidateInvalid

AddressValidateValid

AddressValidateInvalid

Solicitud de ejemplo

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"
}


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

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

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

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

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.Resources;
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);

TenantResource 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

Respuesta de muestra

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

Solicitud de ejemplo

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"
}


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

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

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

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

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.Resources;
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);

TenantResource 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

Respuesta de muestra

status code:: 200

{
  "status": "Valid"
}

Definiciones

Nombre	Description
AddressDetails	Detalles de la dirección.
AddressValidationResponse	Resultado de la validación de direcciones.
AddressValidationStatus	Estado de la validación de direcciones.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

AddressDetails

Object

Detalles de la dirección.

Nombre	Tipo	Description
addressLine1	string minLength: 1	Línea de dirección 1.
addressLine2	string	Línea de dirección 2.
addressLine3	string	Línea de dirección 3.
city	string	Ciudad de dirección.
companyName	string	Nombre de la compañía. Opcional para MCA Individual (pago por uso).
country	string minLength: 1	El código de país usa el formato ISO 3166-1 Alpha-2.
district	string	Distrito de direcciones.
email	string	Dirección de correo electrónico.
firstName	string	Nombre. Opcional para MCA Enterprise.
isValidAddress	boolean	Indica si la dirección está incompleta.
lastName	string	Apellido. Opcional para MCA Enterprise.
middleName	string	Segundo nombre.
phoneNumber	string	Número de teléfono.
postalCode	string	Código postal.
region	string	Región de direcciones.

AddressValidationResponse

Object

Resultado de la validación de direcciones.

Nombre	Tipo	Description
status	AddressValidationStatus	Estado de la validación de direcciones.
suggestedAddresses	AddressDetails[]	Lista de direcciones sugeridas.
validationMessage	string	Mensaje de error de validación.

AddressValidationStatus

Enumeración

Estado de la validación de direcciones.

Valor	Description
Invalid
Other
Valid

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Compartir a través de

Address - Validate

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

AddressValidateInvalid

Solicitud de ejemplo

Respuesta de muestra

AddressValidateValid

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AddressDetails

AddressValidationResponse

AddressValidationStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse