Billing Accounts - Update

Service:

Billing

API Version:

2020-05-01

Mises à jour les propriétés d’un compte de facturation. Actuellement, displayName et address peuvent être mis à jour. L’opération est prise en charge uniquement pour les comptes de facturation avec le type de contrat Contrat client Microsoft.

PATCH https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountName	path	True	string	ID qui identifie de façon unique un compte de facturation.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client. La version actuelle est 2020-05-01.

Corps de la demande

Nom	Type	Description
properties.billingProfiles	BillingProfilesOnExpand	Profils de facturation associés au compte de facturation. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans $expand.
properties.departments	Department[]	Services associés à l’inscription.
properties.displayName	string	Nom du compte de facturation.
properties.enrollmentAccounts	EnrollmentAccount[]	Comptes associés à l’inscription.
properties.notificationEmailAddress	string	Adresse e-mail de notification, uniquement pour les comptes hérités
properties.soldTo	AddressDetails	Adresse de la personne ou du organization responsable du compte de facturation.

Réponses

Nom	Type	Description
200 OK	BillingAccount	OK. La demande a réussi.
202 Accepted		Accepté. La mise à jour du compte de facturation est en cours.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

UpdateBillingAccount

Sample Request

HTTP

PATCH https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01

{
  "properties": {
    "displayName": "Test Account",
    "soldTo": {
      "companyName": "Contoso",
      "firstName": "Test",
      "lastName": "User",
      "addressLine1": "Test Address 1",
      "city": "Redmond",
      "postalCode": "12345",
      "region": "WA",
      "country": "US"
    }
  }
}

Java

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

/** Samples for BillingAccounts Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json
     */
    /**
     * Sample code: UpdateBillingAccount.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void updateBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingAccounts()
            .update(
                "{billingAccountName}",
                new BillingAccountUpdateRequest()
                    .withDisplayName("Test Account")
                    .withSoldTo(
                        new AddressDetails()
                            .withFirstName("Test")
                            .withLastName("User")
                            .withCompanyName("Contoso")
                            .withAddressLine1("Test Address 1")
                            .withCity("Redmond")
                            .withRegion("WA")
                            .withCountry("US")
                            .withPostalCode("fakeTokenPlaceholder")),
                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 update_billing_account.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.billing_accounts.begin_update(
        billing_account_name="{billingAccountName}",
        parameters={
            "properties": {
                "displayName": "Test Account",
                "soldTo": {
                    "addressLine1": "Test Address 1",
                    "city": "Redmond",
                    "companyName": "Contoso",
                    "country": "US",
                    "firstName": "Test",
                    "lastName": "User",
                    "postalCode": "12345",
                    "region": "WA",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json
func ExampleAccountsClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewAccountsClient().BeginUpdate(ctx, "{billingAccountName}", armbilling.AccountUpdateRequest{
		Properties: &armbilling.AccountProperties{
			DisplayName: to.Ptr("Test Account"),
			SoldTo: &armbilling.AddressDetails{
				AddressLine1: to.Ptr("Test Address 1"),
				City:         to.Ptr("Redmond"),
				CompanyName:  to.Ptr("Contoso"),
				Country:      to.Ptr("US"),
				FirstName:    to.Ptr("Test"),
				LastName:     to.Ptr("User"),
				PostalCode:   to.Ptr("12345"),
				Region:       to.Ptr("WA"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Account = armbilling.Account{
	// 	Name: to.Ptr("{billingAccountName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}"),
	// 	Properties: &armbilling.AccountProperties{
	// 		AccountStatus: to.Ptr(armbilling.AccountStatusActive),
	// 		AccountType: to.Ptr(armbilling.AccountTypeEnterprise),
	// 		AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftCustomerAgreement),
	// 		DisplayName: to.Ptr("Test Account"),
	// 		HasReadAccess: to.Ptr(true),
	// 		SoldTo: &armbilling.AddressDetails{
	// 			AddressLine1: to.Ptr("Test Address 1"),
	// 			City: to.Ptr("Redmond"),
	// 			CompanyName: to.Ptr("Contoso"),
	// 			Country: to.Ptr("US"),
	// 			FirstName: to.Ptr("Test"),
	// 			LastName: to.Ptr("User"),
	// 			PostalCode: to.Ptr("12345"),
	// 			Region: to.Ptr("WA"),
	// 		},
	// 	},
	// }
}

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 Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json
 */
async function updateBillingAccount() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const parameters = {
    displayName: "Test Account",
    soldTo: {
      addressLine1: "Test Address 1",
      city: "Redmond",
      companyName: "Contoso",
      country: "US",
      firstName: "Test",
      lastName: "User",
      postalCode: "12345",
      region: "WA",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.billingAccounts.beginUpdateAndWait(billingAccountName, parameters);
  console.log(result);
}

updateBillingAccount().catch(console.error);

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:

202

Location: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationStatus/65e1f2bf-c31c-4b89-a599-25d9d4172af9?api-version=2020-05-01
Retry-After: 10

Status code:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
  "name": "{billingAccountName}",
  "type": "Microsoft.Billing/billingAccounts",
  "properties": {
    "displayName": "Test Account",
    "agreementType": "MicrosoftCustomerAgreement",
    "accountStatus": "Active",
    "accountType": "Enterprise",
    "hasReadAccess": true,
    "soldTo": {
      "companyName": "Contoso",
      "firstName": "Test",
      "lastName": "User",
      "addressLine1": "Test Address 1",
      "city": "Redmond",
      "postalCode": "12345",
      "region": "WA",
      "country": "US"
    }
  }
}

Définitions

Nom	Description
AccountStatus	Status actuelle du compte de facturation.
AccountType	Type de client.
AddressDetails	Détails de l’adresse.
AgreementType	Type d’accord.
AzurePlan	Détails du plan Azure.
BillingAccount	Un compte de facturation.
BillingAccountUpdateRequest	Propriétés de demande du compte de facturation qui peuvent être mises à jour.
BillingProfile	Profil de facturation.
BillingProfilesOnExpand	Profils de facturation associés au compte de facturation. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
BillingProfileStatus	Status du profil de facturation.
BillingRelationshipType	Identifie les services et les achats qui sont payés par un profil de facturation.
Department	Un département.
Enrollment	Propriétés d’une inscription.
EnrollmentAccount	Un compte d’inscription.
EnrollmentPolicies	Stratégies pour les inscriptions Accord Entreprise.
ErrorDetails	Détails de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.
ErrorSubDetails
IndirectRelationshipInfo	Détails du profil de facturation du partenaire du client pour un mouvement indirect.
InvoiceSection	Une section de facture.
InvoiceSectionsOnExpand	Sections de facture associées au profil de facturation. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans $expand.
InvoiceSectionState	Identifie l’état d’une section de facture.
SpendingLimit	Limite de dépense du profil de facturation.
StatusReasonCode	Raison du profil de facturation spécifié status.
targetCloud	Identifie les environnements cloud associés à une section de facture. Il s’agit d’un champ facultatif géré par le système qui est mis à jour à mesure que la section de facture est associée à des comptes dans différents clouds.

AccountStatus

Status actuelle du compte de facturation.

Nom	Type	Description
Active	string
Deleted	string
Disabled	string
Expired	string
Extended	string
Terminated	string
Transferred	string

AccountType

Type de client.

Nom	Type	Description
Enterprise	string
Individual	string
Partner	string

AddressDetails

Détails de l’adresse.

Nom	Type	Description
addressLine1	string	Ligne d’adresse 1.
addressLine2	string	Ligne d’adresse 2.
addressLine3	string	Ligne d’adresse 3.
city	string	Ville d’adresse.
companyName	string	Nom de la société
country	string	Le code de pays utilise le format ISO2 à 2 chiffres.
district	string	District d’adresse.
email	string	Adresse e-mail.
firstName	string	Prénom.
lastName	string	Nom.
middleName	string	Deuxième prénom.
phoneNumber	string	Numéro de téléphone.
postalCode	string	Code postal.
region	string	Région d’adresse.

AgreementType

Type d’accord.

Nom	Type	Description
EnterpriseAgreement	string
MicrosoftCustomerAgreement	string
MicrosoftOnlineServicesProgram	string
MicrosoftPartnerAgreement	string

AzurePlan

Détails du plan Azure.

Nom	Type	Description
skuDescription	string	Description de la référence SKU.
skuId	string	ID de référence SKU.

BillingAccount

Un compte de facturation.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.accountStatus	AccountStatus	Status actuelle du compte de facturation.
properties.accountType	AccountType	Type de client.
properties.agreementType	AgreementType	Type d’accord.
properties.billingProfiles	BillingProfilesOnExpand	Profils de facturation associés au compte de facturation. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.departments	Department[]	Services associés à l’inscription.
properties.displayName	string	Nom du compte de facturation.
properties.enrollmentAccounts	EnrollmentAccount[]	Comptes associés à l’inscription.
properties.enrollmentDetails	Enrollment	Détails sur l’inscription héritée associée. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.hasReadAccess	boolean	Indique si l’utilisateur dispose d’un accès en lecture au compte de facturation.
properties.notificationEmailAddress	string	Adresse e-mail de notification, uniquement pour les comptes hérités
properties.soldTo	AddressDetails	Adresse de la personne ou du organization responsable du compte de facturation.
type	string	Type de ressource.

BillingAccountUpdateRequest

Propriétés de demande du compte de facturation qui peuvent être mises à jour.

Nom	Type	Description
properties.accountStatus	AccountStatus	Status actuelle du compte de facturation.
properties.accountType	AccountType	Type de client.
properties.agreementType	AgreementType	Type d’accord.
properties.billingProfiles	BillingProfilesOnExpand	Profils de facturation associés au compte de facturation. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.departments	Department[]	Services associés à l’inscription.
properties.displayName	string	Nom du compte de facturation.
properties.enrollmentAccounts	EnrollmentAccount[]	Comptes associés à l’inscription.
properties.enrollmentDetails	Enrollment	Détails sur l’inscription héritée associée. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.hasReadAccess	boolean	Indique si l’utilisateur dispose d’un accès en lecture au compte de facturation.
properties.notificationEmailAddress	string	Adresse e-mail de notification, uniquement pour les comptes hérités
properties.soldTo	AddressDetails	Adresse de la personne ou du organization responsable du compte de facturation.

BillingProfile

Profil de facturation.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.billTo	AddressDetails	Adresse de facturation.
properties.billingRelationshipType	BillingRelationshipType	Identifie les services et les achats qui sont payés par un profil de facturation.
properties.currency	string	Devise dans laquelle les frais du profil de facturation sont facturés.
properties.displayName	string	Nom du profil de facturation.
properties.enabledAzurePlans	AzurePlan[]	Informations sur les plans Azure activés.
properties.hasReadAccess	boolean	Indique si l’utilisateur dispose d’un accès en lecture au profil de facturation.
properties.indirectRelationshipInfo	IndirectRelationshipInfo	Identifie le profil de facturation lié à un autre profil de facturation dans le mouvement d’achat indirect.
properties.invoiceDay	integer	Jour du mois où la facture du profil de facturation est générée.
properties.invoiceEmailOptIn	boolean	Indicateur contrôlant si les factures du profil de facturation sont envoyées par e-mail.
properties.invoiceSections	InvoiceSectionsOnExpand	Sections de facture associées au profil de facturation. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans $expand.
properties.poNumber	string	Nom du bon de commande qui apparaîtra sur les factures générées pour le profil de facturation.
properties.spendingLimit	SpendingLimit	Limite de dépense du profil de facturation.
properties.status	BillingProfileStatus	Status du profil de facturation.
properties.statusReasonCode	StatusReasonCode	Raison du profil de facturation spécifié status.
properties.systemId	string	Identificateur unique généré par le système pour un profil de facturation.
properties.tags	object	Étiquettes des profils de facturation.
properties.targetClouds	targetCloud[]	Identifie les environnements cloud associés à un profil de facturation. Il s’agit d’un champ facultatif géré par le système qui est mis à jour à mesure que le profil de facturation est associé à des comptes dans différents clouds.
type	string	Type de ressource.

BillingProfilesOnExpand

Profils de facturation associés au compte de facturation. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.

Nom	Type	Description
hasMoreResults	boolean	Indique s’il existe plus de profils de facturation que ceux répertoriés dans cette collection. La collection répertorie un maximum de 50 profils de facturation. Pour obtenir tous les profils de facturation, utilisez l’API des profils de facturation de liste.
value	BillingProfile[]	Profils de facturation associés au compte de facturation.

BillingProfileStatus

Status du profil de facturation.

Nom	Type	Description
Active	string
Disabled	string
Warned	string

BillingRelationshipType

Identifie les services et les achats qui sont payés par un profil de facturation.

Nom	Type	Description
CSPPartner	string
Direct	string
IndirectCustomer	string
IndirectPartner	string

Department

Un département.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.costCenter	string	Centre de coûts associé au service.
properties.departmentName	string	Nom du service.
properties.enrollmentAccounts	EnrollmentAccount[]	Comptes d’inscription associés. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.status	string	Le status du ministère.
type	string	Type de ressource.

Enrollment

Propriétés d’une inscription.

Nom	Type	Description
billingCycle	string	Cycle de facturation pour l’inscription.
channel	string	Type de canal de l’inscription.
countryCode	string	Code de pays de l’inscription.
currency	string	Devise de facturation de l’inscription.
endDate	string	Date de fin de l’inscription.
language	string	Langue de l’inscription.
policies	EnrollmentPolicies	Stratégies pour les inscriptions Accord Entreprise.
startDate	string	Date de début de l’inscription.
status	string	Status actuelle de l’inscription.

EnrollmentAccount

Un compte d’inscription.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.accountName	string	Nom du compte d’inscription.
properties.accountOwner	string	Propriétaire du compte d’inscription.
properties.accountOwnerEmail	string	Adresse e-mail du propriétaire du compte d’inscription.
properties.costCenter	string	Centre de coûts associé au compte d’inscription.
properties.department	Department	Service associé. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans $expand.
properties.endDate	string	Date de fin du compte d’inscription.
properties.startDate	string	Date de début du compte d’inscription.
properties.status	string	Status du compte d’inscription.
type	string	Type de ressource.

EnrollmentPolicies

Stratégies pour les inscriptions Accord Entreprise.

Nom	Type	Description
accountOwnerViewCharges	boolean	Stratégie qui contrôle si les propriétaires de compte peuvent afficher les frais.
departmentAdminViewCharges	boolean	Stratégie qui contrôle si les administrateurs de service peuvent afficher les frais.
marketplaceEnabled	boolean	Stratégie qui contrôle si les achats de la Place de marché Azure sont autorisés dans l’inscription.
reservedInstancesEnabled	boolean	Stratégie qui contrôle si les achats de réservations Azure sont autorisés dans l’inscription.

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	ErrorSubDetails[]	Sous-détails de l’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.
target	string	Cible de l’erreur particulière.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur.

ErrorSubDetails

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.
target	string	Cible de l’erreur particulière.

IndirectRelationshipInfo

Détails du profil de facturation du partenaire du client pour un mouvement indirect.

Nom	Type	Description
billingAccountName	string	Nom du compte de facturation du partenaire ou du client pour un mouvement indirect.
billingProfileName	string	Nom du profil de facturation du partenaire ou du client pour un mouvement indirect.
displayName	string	Nom complet du partenaire ou du client pour un mouvement indirect.

InvoiceSection

Une section de facture.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.displayName	string	Nom de la section de facture.
properties.labels	object	Dictionnaire de métadonnées associées à la section de facture.
properties.state	InvoiceSectionState	Identifie l’état d’une section de facture.
properties.systemId	string	Identificateur unique généré par le système pour une section de facture.
properties.tags	object	Dictionnaire de métadonnées associées à la section de facture. Longueur maximale de clé/valeur prise en charge de 256 caractères. Les clés/valeur ne doivent pas vider la valeur, ni null. Les clés ne peuvent pas contenir <> % & \ ? /
properties.targetCloud	targetCloud	Identifie les environnements cloud associés à une section de facture. Il s’agit d’un champ facultatif géré par le système qui est mis à jour à mesure que la section de facture est associée à des comptes dans différents clouds.
type	string	Type de ressource.

InvoiceSectionsOnExpand

Sections de facture associées au profil de facturation. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans $expand.

Nom	Type	Description
hasMoreResults	boolean	Indique s’il existe plus de sections de facture que celles répertoriées dans cette collection. La collection répertorie un maximum de 50 sections de facture. Pour obtenir toutes les sections de facture, utilisez l’API répertorier les sections de facture.
value	InvoiceSection[]	Sections de facture associées au profil de facturation.

InvoiceSectionState

Identifie l’état d’une section de facture.

Nom	Type	Description
Active	string
Restricted	string

SpendingLimit

Limite de dépense du profil de facturation.

Nom	Type	Description
Off	string
On	string

StatusReasonCode

Raison du profil de facturation spécifié status.

Nom	Type	Description
PastDue	string
SpendingLimitExpired	string
SpendingLimitReached	string

targetCloud

Identifie les environnements cloud associés à une section de facture. Il s’agit d’un champ facultatif géré par le système qui est mis à jour à mesure que la section de facture est associée à des comptes dans différents clouds.

Nom	Type	Description
USGov	string
USNat	string
USSec	string