Billing Profiles - Create Or Update

Service:

Billing

API Version:

2020-05-01

Tworzy lub aktualizuje profil rozliczeniowy. Operacja jest obsługiwana w przypadku kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft lub Microsoft Partner Agreement.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountName	path	True	string	Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe.
billingProfileName	path	True	string	Identyfikator, który jednoznacznie identyfikuje profil rozliczeniowy.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2020-05-01.

Treść żądania

Nazwa	Typ	Opis
properties.billTo	AddressDetails	Adres rozliczeniowy.
properties.displayName	string	Nazwa profilu rozliczeniowego.
properties.enabledAzurePlans	AzurePlan[]	Informacje o włączonych planach platformy Azure.
properties.invoiceEmailOptIn	boolean	Flaga kontrolująca, czy faktury dla profilu rozliczeniowego są wysyłane za pośrednictwem poczty e-mail.
properties.invoiceSections	InvoiceSectionsOnExpand	Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand.
properties.poNumber	string	Nazwa zamówienia zakupu wyświetlana na fakturach wygenerowanych dla profilu rozliczeniowego.
properties.tags	object	Tagi profilów rozliczeniowych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BillingProfile	OK. Żądanie zakończyło się pomyślnie.
202 Accepted		Zaakceptowano Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CreateBillingProfile

Sample Request

HTTP

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

{
  "properties": {
    "displayName": "Finance",
    "billTo": {
      "firstName": "Test",
      "lastName": "User",
      "addressLine1": "Test Address 1",
      "city": "Redmond",
      "postalCode": "12345",
      "region": "WA",
      "country": "US"
    },
    "enabledAzurePlans": [
      {
        "skuId": "0001"
      },
      {
        "skuId": "0002"
      }
    ],
    "invoiceEmailOptIn": true,
    "poNumber": "ABC12345"
  }
}

Java

import com.azure.resourcemanager.billing.fluent.models.BillingProfileInner;
import com.azure.resourcemanager.billing.models.AddressDetails;
import com.azure.resourcemanager.billing.models.AzurePlan;
import java.util.Arrays;

/** Samples for BillingProfiles CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json
     */
    /**
     * Sample code: CreateBillingProfile.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void createBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingProfiles()
            .createOrUpdate(
                "{billingAccountName}",
                "{billingProfileName}",
                new BillingProfileInner()
                    .withDisplayName("Finance")
                    .withPoNumber("ABC12345")
                    .withBillTo(
                        new AddressDetails()
                            .withFirstName("Test")
                            .withLastName("User")
                            .withAddressLine1("Test Address 1")
                            .withCity("Redmond")
                            .withRegion("WA")
                            .withCountry("US")
                            .withPostalCode("fakeTokenPlaceholder"))
                    .withInvoiceEmailOptIn(true)
                    .withEnabledAzurePlans(
                        Arrays.asList(new AzurePlan().withSkuId("0001"), new AzurePlan().withSkuId("0002"))),
                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 create_billing_profile.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_profiles.begin_create_or_update(
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        parameters={
            "properties": {
                "billTo": {
                    "addressLine1": "Test Address 1",
                    "city": "Redmond",
                    "country": "US",
                    "firstName": "Test",
                    "lastName": "User",
                    "postalCode": "12345",
                    "region": "WA",
                },
                "displayName": "Finance",
                "enabledAzurePlans": [{"skuId": "0001"}, {"skuId": "0002"}],
                "invoiceEmailOptIn": True,
                "poNumber": "ABC12345",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.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/PutBillingProfile.json
func ExampleProfilesClient_BeginCreateOrUpdate() {
	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.NewProfilesClient().BeginCreateOrUpdate(ctx, "{billingAccountName}", "{billingProfileName}", armbilling.Profile{
		Properties: &armbilling.ProfileProperties{
			BillTo: &armbilling.AddressDetails{
				AddressLine1: to.Ptr("Test Address 1"),
				City:         to.Ptr("Redmond"),
				Country:      to.Ptr("US"),
				FirstName:    to.Ptr("Test"),
				LastName:     to.Ptr("User"),
				PostalCode:   to.Ptr("12345"),
				Region:       to.Ptr("WA"),
			},
			DisplayName: to.Ptr("Finance"),
			EnabledAzurePlans: []*armbilling.AzurePlan{
				{
					SKUID: to.Ptr("0001"),
				},
				{
					SKUID: to.Ptr("0002"),
				}},
			InvoiceEmailOptIn: to.Ptr(true),
			PoNumber:          to.Ptr("ABC12345"),
		},
	}, 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.Profile = armbilling.Profile{
	// 	Name: to.Ptr("billingProfileId1"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/billingProfileId1"),
	// 	Properties: &armbilling.ProfileProperties{
	// 		BillTo: &armbilling.AddressDetails{
	// 			AddressLine1: to.Ptr("Test Address 1"),
	// 			City: to.Ptr("Redmond"),
	// 			Country: to.Ptr("US"),
	// 			FirstName: to.Ptr("Test"),
	// 			LastName: to.Ptr("User"),
	// 			PostalCode: to.Ptr("12345"),
	// 			Region: to.Ptr("WA"),
	// 		},
	// 		Currency: to.Ptr("USD"),
	// 		DisplayName: to.Ptr("Finance"),
	// 		EnabledAzurePlans: []*armbilling.AzurePlan{
	// 			{
	// 				SKUDescription: to.Ptr("Microsoft Azure Plan"),
	// 				SKUID: to.Ptr("0001"),
	// 			},
	// 			{
	// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
	// 				SKUID: to.Ptr("0002"),
	// 		}},
	// 		HasReadAccess: to.Ptr(true),
	// 		InvoiceDay: to.Ptr[int32](5),
	// 		InvoiceEmailOptIn: to.Ptr(true),
	// 		PoNumber: to.Ptr("ABC12345"),
	// 		SpendingLimit: to.Ptr(armbilling.SpendingLimitOff),
	// 		Status: to.Ptr(armbilling.BillingProfileStatusActive),
	// 		SystemID: to.Ptr("1XXX-11XX-XX1-XXXX-XXX"),
	// 	},
	// }
}

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 Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
 *
 * @summary Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json
 */
async function createBillingProfile() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const parameters = {
    billTo: {
      addressLine1: "Test Address 1",
      city: "Redmond",
      country: "US",
      firstName: "Test",
      lastName: "User",
      postalCode: "12345",
      region: "WA",
    },
    displayName: "Finance",
    enabledAzurePlans: [{ skuId: "0001" }, { skuId: "0002" }],
    invoiceEmailOptIn: true,
    poNumber: "ABC12345",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.billingProfiles.beginCreateOrUpdateAndWait(
    billingAccountName,
    billingProfileName,
    parameters
  );
  console.log(result);
}

createBillingProfile().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: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2020-05-01
Retry-After: 60

Status code:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/billingProfileId1",
  "name": "billingProfileId1",
  "type": "Microsoft.Billing/billingAccounts/billingProfiles",
  "properties": {
    "displayName": "Finance",
    "billTo": {
      "firstName": "Test",
      "lastName": "User",
      "addressLine1": "Test Address 1",
      "city": "Redmond",
      "postalCode": "12345",
      "region": "WA",
      "country": "US"
    },
    "currency": "USD",
    "enabledAzurePlans": [
      {
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan"
      },
      {
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    ],
    "invoiceDay": 5,
    "invoiceEmailOptIn": true,
    "poNumber": "ABC12345",
    "hasReadAccess": true,
    "systemId": "1XXX-11XX-XX1-XXXX-XXX",
    "status": "Active",
    "spendingLimit": "Off"
  }
}

Definicje

Nazwa	Opis
AddressDetails	Szczegóły adresu.
AzurePlan	Szczegóły planu platformy Azure.
BillingProfile	Profil rozliczeniowy.
BillingProfileStatus	Stan profilu rozliczeniowego.
BillingRelationshipType	Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorSubDetails
IndirectRelationshipInfo	Szczegóły profilu rozliczeniowego partnera klienta dla ruchu pośredniego.
InvoiceSection	Sekcja faktury.
InvoiceSectionsOnExpand	Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand.
InvoiceSectionState	Identyfikuje stan sekcji faktury.
SpendingLimit	Limit wydatków profilu rozliczeniowego.
StatusReasonCode	Przyczyna określonego stanu profilu rozliczeniowego.
targetCloud	Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to opcjonalne pole zarządzane przez system i jest aktualizowane, gdy sekcja faktury jest skojarzona z kontami w różnych chmurach.

AddressDetails

Szczegóły adresu.

Nazwa	Typ	Opis
addressLine1	string	Wiersz adresu 1.
addressLine2	string	Wiersz adresu 2.
addressLine3	string	Wiersz adresu 3.
city	string	Miasto adresów.
companyName	string	Nazwa firmy.
country	string	Kod kraju używa formatu ISO2, 2-cyfrowego.
district	string	Dystrykt adresu.
email	string	Adres e-mail.
firstName	string	Imię.
lastName	string	Nazwisko.
middleName	string	Nazwa środkowa.
phoneNumber	string	Numer telefonu.
postalCode	string	Kod pocztowy.
region	string	Region adresu.

AzurePlan

Szczegóły planu platformy Azure.

Nazwa	Typ	Opis
skuDescription	string	Opis jednostki SKU.
skuId	string	Identyfikator jednostki SKU.

BillingProfile

Profil rozliczeniowy.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.billTo	AddressDetails	Adres rozliczeniowy.
properties.billingRelationshipType	BillingRelationshipType	Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy.
properties.currency	string	Waluta, w której są naliczane opłaty za profil rozliczeniowy.
properties.displayName	string	Nazwa profilu rozliczeniowego.
properties.enabledAzurePlans	AzurePlan[]	Informacje o włączonych planach platformy Azure.
properties.hasReadAccess	boolean	Wskazuje, czy użytkownik ma dostęp do odczytu do profilu rozliczeniowego.
properties.indirectRelationshipInfo	IndirectRelationshipInfo	Identyfikuje profil rozliczeniowy połączony z innym profilem rozliczeniowym w ruchu pośrednim zakupu.
properties.invoiceDay	integer	Dzień miesiąca wygenerowania faktury dla profilu rozliczeniowego.
properties.invoiceEmailOptIn	boolean	Flaga kontrolująca, czy faktury dla profilu rozliczeniowego są wysyłane za pośrednictwem poczty e-mail.
properties.invoiceSections	InvoiceSectionsOnExpand	Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand.
properties.poNumber	string	Nazwa zamówienia zakupu wyświetlana na fakturach wygenerowanych dla profilu rozliczeniowego.
properties.spendingLimit	SpendingLimit	Limit wydatków profilu rozliczeniowego.
properties.status	BillingProfileStatus	Stan profilu rozliczeniowego.
properties.statusReasonCode	StatusReasonCode	Przyczyna określonego stanu profilu rozliczeniowego.
properties.systemId	string	System wygenerował unikatowy identyfikator profilu rozliczeniowego.
properties.tags	object	Tagi profilów rozliczeniowych.
properties.targetClouds	targetCloud[]	Identyfikuje środowiska chmury skojarzone z profilem rozliczeniowym. Jest to opcjonalne pole zarządzane przez system i jest aktualizowane, gdy profil rozliczeniowy jest skojarzony z kontami w różnych chmurach.
type	string	Typ zasobu.

BillingProfileStatus

Stan profilu rozliczeniowego.

Nazwa	Typ	Opis
Active	string
Disabled	string
Warned	string

BillingRelationshipType

Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy.

Nazwa	Typ	Opis
CSPPartner	string
Direct	string
IndirectCustomer	string
IndirectPartner	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorSubDetails[]	Szczegóły podrzędne błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

ErrorSubDetails

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

IndirectRelationshipInfo

Szczegóły profilu rozliczeniowego partnera klienta dla ruchu pośredniego.

Nazwa	Typ	Opis
billingAccountName	string	Nazwa konta rozliczeniowego partnera lub klienta dla ruchu pośredniego.
billingProfileName	string	Nazwa profilu rozliczeniowego partnera lub klienta dla ruchu pośredniego.
displayName	string	Nazwa wyświetlana partnera lub klienta dla ruchu pośredniego.

InvoiceSection

Sekcja faktury.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.displayName	string	Nazwa sekcji faktury.
properties.labels	object	Słownik metadanych skojarzonych z sekcją faktury.
properties.state	InvoiceSectionState	Identyfikuje stan sekcji faktury.
properties.systemId	string	System wygenerował unikatowy identyfikator sekcji faktury.
properties.tags	object	Słownik metadanych skojarzonych z sekcją faktury. Maksymalna długość klucza/wartości obsługiwana przez 256 znaków. Klucze/wartość nie powinny zawierać wartości pustej ani wartości null. Klucze nie mogą zawierać <> % & \ ? /
properties.targetCloud	targetCloud	Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to opcjonalne pole zarządzane przez system i jest aktualizowane, gdy sekcja faktury jest skojarzona z kontami w różnych chmurach.
type	string	Typ zasobu.

InvoiceSectionsOnExpand

Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand.

Nazwa	Typ	Opis
hasMoreResults	boolean	Wskazuje, czy w tej kolekcji znajduje się więcej sekcji faktur niż te wymienione w tej kolekcji. Kolekcja zawiera maksymalnie 50 sekcji faktur. Aby uzyskać wszystkie sekcje faktur, użyj interfejsu API sekcji faktur listy.
value	InvoiceSection[]	Sekcje faktur skojarzone z profilem rozliczeniowym.

InvoiceSectionState

Identyfikuje stan sekcji faktury.

Nazwa	Typ	Opis
Active	string
Restricted	string

SpendingLimit

Limit wydatków profilu rozliczeniowego.

Nazwa	Typ	Opis
Off	string
On	string

StatusReasonCode

Przyczyna określonego stanu profilu rozliczeniowego.

Nazwa	Typ	Opis
PastDue	string
SpendingLimitExpired	string
SpendingLimitReached	string

targetCloud

Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to opcjonalne pole zarządzane przez system i jest aktualizowane, gdy sekcja faktury jest skojarzona z kontami w różnych chmurach.

Nazwa	Typ	Opis
USGov	string
USNat	string
USSec	string