Products - Update

Service:

Billing

API Version:

2020-05-01

Updates die Eigenschaften eines Produkts. Derzeit kann die automatische Verlängerung aktualisiert werden. Der Vorgang wird nur für Abrechnungskonten mit dem Vertragstyp Microsoft-Kundenvereinbarung unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
productName	path	True	string	Die ID, die ein Produkt eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 01.05.2020.

Anforderungstext

Name	Typ	Beschreibung
properties.autoRenew	AutoRenew	Gibt an, ob die automatische Verlängerung für ein Produkt aktiviert oder deaktiviert ist.
properties.billingFrequency	BillingFrequency	Die Häufigkeit, mit der das Produkt in Rechnung gestellt wird.
properties.status	ProductStatusType	Die aktuelle status des Produkts.

Antworten

Name	Typ	Beschreibung
200 OK	Product	OK. Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

UpdateBillingProperty

Sample Request

HTTP

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

{
  "properties": {
    "autoRenew": "Off"
  }
}

Java

import com.azure.resourcemanager.billing.fluent.models.ProductInner;
import com.azure.resourcemanager.billing.models.AutoRenew;

/** Samples for Products Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json
     */
    /**
     * Sample code: UpdateBillingProperty.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void updateBillingProperty(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .products()
            .updateWithResponse(
                "{billingAccountName}",
                "{productName}",
                new ProductInner().withAutoRenew(AutoRenew.OFF),
                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

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/UpdateProduct.json
func ExampleProductsClient_Update() {
	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.NewProductsClient().Update(ctx, "{billingAccountName}", "{productName}", armbilling.Product{
		Properties: &armbilling.ProductProperties{
			AutoRenew: to.Ptr(armbilling.AutoRenewOff),
		},
	}, 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.Product = armbilling.Product{
	// 	Name: to.Ptr("{productName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/products"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}"),
	// 	Properties: &armbilling.ProductProperties{
	// 		AutoRenew: to.Ptr(armbilling.AutoRenewOff),
	// 		AvailabilityID: to.Ptr("AvailabilityId1"),
	// 		BillingFrequency: to.Ptr(armbilling.BillingFrequencyMonthly),
	// 		BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
	// 		DisplayName: to.Ptr("AIP Dev"),
	// 		InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
	// 		InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}"),
	// 		LastCharge: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](5000),
	// 		},
	// 		LastChargeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-15T17:32:28.000Z"); return t}()),
	// 		ProductType: to.Ptr("Subscription"),
	// 		ProductTypeID: to.Ptr("A12345"),
	// 		PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
	// 		Quantity: to.Ptr[float32](4),
	// 		SKUDescription: to.Ptr("Enterprise Agreement Development"),
	// 		SKUID: to.Ptr("0001"),
	// 		Status: to.Ptr(armbilling.ProductStatusTypeActive),
	// 		TenantID: to.Ptr("515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce"),
	// 	},
	// }
}

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 Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Updates the properties of a Product. Currently, auto renew 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/UpdateProduct.json
 */
async function updateBillingProperty() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const productName = "{productName}";
  const parameters = { autoRenew: "Off" };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.products.update(billingAccountName, productName, parameters);
  console.log(result);
}

updateBillingProperty().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:

200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}",
  "name": "{productName}",
  "type": "Microsoft.Billing/billingAccounts/products",
  "properties": {
    "autoRenew": "Off",
    "productTypeId": "A12345",
    "productType": "Subscription",
    "displayName": "AIP Dev",
    "status": "Active",
    "purchaseDate": "2018-05-01T17:32:28Z",
    "lastCharge": {
      "currency": "USD",
      "value": 5000
    },
    "lastChargeDate": "2018-06-15T17:32:28Z",
    "billingFrequency": "Monthly",
    "quantity": 4,
    "skuId": "0001",
    "skuDescription": "Enterprise Agreement Development",
    "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
    "availabilityId": "AvailabilityId1",
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
    "invoiceSectionDisplayName": "Contoso operations invoiceSection",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing"
  }
}

Definitionen

Name	Beschreibung
Amount	Der Betrag.
AutoRenew	Gibt an, ob die automatische Verlängerung für ein Produkt aktiviert oder deaktiviert ist.
BillingFrequency	Die Häufigkeit, mit der das Produkt in Rechnung gestellt wird.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
ErrorSubDetails
Product	Ein Produkt.
ProductStatusType	Die aktuelle status des Produkts.
Reseller	Details des Wiederverkäufers.

Amount

Der Betrag.

Name	Typ	Beschreibung
currency	string	Die Währung für den Betragswert.
value	number	Betragswert.

AutoRenew

Gibt an, ob die automatische Verlängerung für ein Produkt aktiviert oder deaktiviert ist.

Name	Typ	Beschreibung
Off	string
On	string

BillingFrequency

Die Häufigkeit, mit der das Produkt in Rechnung gestellt wird.

Name	Typ	Beschreibung
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorSubDetails[]	Die Unterdetails des Fehlers.
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des jeweiligen Fehlers.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ErrorSubDetails

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des jeweiligen Fehlers.

Product

Ein Produkt.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Name der Ressource.
properties.autoRenew	AutoRenew	Gibt an, ob die automatische Verlängerung für ein Produkt aktiviert oder deaktiviert ist.
properties.availabilityId	string	Die Verfügbarkeit des Produkts.
properties.billingFrequency	BillingFrequency	Die Häufigkeit, mit der das Produkt in Rechnung gestellt wird.
properties.billingProfileDisplayName	string	Der Name des Abrechnungsprofils, dem das Produkt abgerechnet wird.
properties.billingProfileId	string	Die ID des Abrechnungsprofils, dem das Produkt abgerechnet wird.
properties.customerDisplayName	string	Der Name des Kunden, für den das Produkt erworben wurde. Das Feld gilt nur für Microsoft Partner-Vereinbarung Abrechnungskonto.
properties.customerId	string	Die ID des Kunden, für den das Produkt erworben wurde. Das Feld gilt nur für Microsoft Partner-Vereinbarung Abrechnungskonto.
properties.displayName	string	Der Anzeigename des Produkts.
properties.endDate	string	Das Datum, an dem das Produkt verlängert oder storniert wird.
properties.invoiceSectionDisplayName	string	Der Name des Rechnungsabschnitts, dem das Produkt in Rechnung gestellt wird.
properties.invoiceSectionId	string	Die ID des Rechnungsabschnitts, dem das Produkt in Rechnung gestellt wird.
properties.lastCharge	Amount	Die Gebühren für den letzten Monat.
properties.lastChargeDate	string	Das Datum der letzten Gebühr.
properties.productType	string	Die Beschreibung des Produkttyps.
properties.productTypeId	string	Die ID des Produkttyps.
properties.purchaseDate	string	Das Datum, an dem das Produkt gekauft wurde.
properties.quantity	number	Die Menge, die für das Produkt erworben wurde.
properties.reseller	Reseller	Wiederverkäufer für dieses Produkt.
properties.skuDescription	string	Die sku-Beschreibung des Produkts.
properties.skuId	string	Die sku-ID des Produkts.
properties.status	ProductStatusType	Die aktuelle status des Produkts.
properties.tenantId	string	Die ID des Mandanten, in dem das Produkt verwendet wird.
type	string	Der Ressourcentyp.

ProductStatusType

Die aktuelle status des Produkts.

Name	Typ	Beschreibung
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

Details des Wiederverkäufers.

Name	Typ	Beschreibung
description	string	Der Name des Wiederverkäufers.
resellerId	string	Die MPN-ID des Wiederverkäufers.