Address - Validate

Dienst:

Billing

API-Version:

2024-04-01

Überprüft eine Adresse. Verwenden Sie den Vorgang, um eine Adresse zu überprüfen, bevor Sie sie als soldTo- oder billTo-Adresse verwenden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
addressLine1	True	string minLength: 1	Adresszeile 1.
country	True	string minLength: 1	Der Ländercode verwendet das ISO 3166-1 Alpha-2-Format.
addressLine2		string	Adresszeile 2.
addressLine3		string	Adresszeile 3.
city		string	Adresse Ort.
companyName		string	Firmenname. Optional für MCA Individual (Pay-as-you-go).
district		string	Adressbezirk.
email		string	E-Mail-Adresse.
firstName		string	Vorname. Optional für MCA Enterprise.
isValidAddress		boolean	Gibt an, ob die Adresse unvollständig ist.
lastName		string	Nachname. Optional für MCA Enterprise.
middleName		string	Zweitname.
phoneNumber		string	Telefonnummer.
postalCode		string	Postleitzahl.
region		string	Adressbereich.

Antworten

Name	Typ	Beschreibung
200 OK	AddressValidationResponse	Ergebnis der Adressüberprüfung.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

AddressValidateInvalid

AddressValidateValid

AddressValidateInvalid

Beispielanforderung

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.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

Beispiel für eine Antwort

Statuscode:

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

Beispielanforderung

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.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

Beispiel für eine Antwort

Statuscode:

200

{
  "status": "Valid"
}

Definitionen

Name	Beschreibung
AddressDetails	Adressdetails.
AddressValidationResponse	Ergebnis der Adressüberprüfung.
AddressValidationStatus	Status der Adressüberprüfung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AddressDetails

Objekt

Adressdetails.

Name	Typ	Beschreibung
addressLine1	string minLength: 1	Adresszeile 1.
addressLine2	string	Adresszeile 2.
addressLine3	string	Adresszeile 3.
city	string	Adresse Ort.
companyName	string	Firmenname. Optional für MCA Individual (Pay-as-you-go).
country	string minLength: 1	Der Ländercode verwendet das ISO 3166-1 Alpha-2-Format.
district	string	Adressbezirk.
email	string	E-Mail-Adresse.
firstName	string	Vorname. Optional für MCA Enterprise.
isValidAddress	boolean	Gibt an, ob die Adresse unvollständig ist.
lastName	string	Nachname. Optional für MCA Enterprise.
middleName	string	Zweitname.
phoneNumber	string	Telefonnummer.
postalCode	string	Postleitzahl.
region	string	Adressbereich.

AddressValidationResponse

Objekt

Ergebnis der Adressüberprüfung.

Name	Typ	Beschreibung
status	AddressValidationStatus	Status der Adressüberprüfung.
suggestedAddresses	AddressDetails[]	Die Liste der vorgeschlagenen Adressen.
validationMessage	string	Überprüfungsfehlermeldung.

AddressValidationStatus

Enumeration

Status der Adressüberprüfung.

Wert	Beschreibung
Invalid
Other
Valid

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.