Products - Update

Referensi

Service:: Billing

API Version:: 2020-05-01

Updates properti Produk. Saat ini, perpanjangan otomatis dapat diperbarui. Operasi ini hanya didukung untuk akun penagihan dengan jenis perjanjian Perjanjian Pelanggan Microsoft.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
billingAccountName	path	True	string	ID yang secara unik mengidentifikasi akun penagihan.
productName	path	True	string	ID yang secara unik mengidentifikasi produk.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2020-05-01.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.autoRenew	AutoRenew	Menunjukkan apakah perpanjangan otomatis diaktifkan atau dinonaktifkan untuk produk.
properties.billingFrequency	BillingFrequency	Frekuensi di mana produk akan ditagih.
properties.status	ProductStatusType	Status produk saat ini.

Respons

Nama	Jenis	Deskripsi
200 OK	Product	OK. Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

UpdateBillingProperty

Sample Request

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

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

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

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

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

Definisi

Nama	Deskripsi
Amount	Jumlahnya.
AutoRenew	Menunjukkan apakah perpanjangan otomatis diaktifkan atau dinonaktifkan untuk produk.
BillingFrequency	Frekuensi di mana produk akan ditagih.
ErrorDetails	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
ErrorSubDetails
Product	Sebuah produk.
ProductStatusType	Status produk saat ini.
Reseller	Detail reseller.

Amount

Jumlahnya.

Nama	Jenis	Deskripsi
currency	string	Mata uang untuk nilai jumlah.
value	number	Nilai jumlah.

AutoRenew

Menunjukkan apakah perpanjangan otomatis diaktifkan atau dinonaktifkan untuk produk.

Nama	Jenis	Deskripsi
Off	string
On	string

BillingFrequency

Frekuensi di mana produk akan ditagih.

Nama	Jenis	Deskripsi
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	ErrorSubDetails[]	Subdetail kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.
target	string	Target kesalahan tertentu.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan.

ErrorSubDetails

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.
target	string	Target kesalahan tertentu.

Product

Sebuah produk.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
name	string	Nama sumber daya.
properties.autoRenew	AutoRenew	Menunjukkan apakah perpanjangan otomatis diaktifkan atau dinonaktifkan untuk produk.
properties.availabilityId	string	Ketersediaan produk.
properties.billingFrequency	BillingFrequency	Frekuensi di mana produk akan ditagih.
properties.billingProfileDisplayName	string	Nama profil penagihan tempat produk ditagih.
properties.billingProfileId	string	ID profil penagihan tempat produk ditagih.
properties.customerDisplayName	string	Nama pelanggan yang produknya dibeli. Bidang ini hanya berlaku untuk akun penagihan Perjanjian Mitra Microsoft.
properties.customerId	string	ID pelanggan yang produknya dibeli. Bidang ini hanya berlaku untuk akun penagihan Perjanjian Mitra Microsoft.
properties.displayName	string	Nama tampilan produk.
properties.endDate	string	Tanggal kapan produk akan diperbarui atau dibatalkan.
properties.invoiceSectionDisplayName	string	Nama bagian faktur tempat produk ditagih.
properties.invoiceSectionId	string	ID bagian faktur tempat produk ditagih.
properties.lastCharge	Amount	Biaya bulan lalu.
properties.lastChargeDate	string	Tanggal tagihan terakhir.
properties.productType	string	Deskripsi jenis produk.
properties.productTypeId	string	ID jenis produk.
properties.purchaseDate	string	Tanggal ketika produk dibeli.
properties.quantity	number	Kuantitas yang dibeli untuk produk.
properties.reseller	Reseller	Penjual untuk produk ini.
properties.skuDescription	string	Deskripsi sku produk.
properties.skuId	string	ID sku produk.
properties.status	ProductStatusType	Status produk saat ini.
properties.tenantId	string	Id penyewa tempat produk digunakan.
type	string	Jenis sumber daya

ProductStatusType

Status produk saat ini.

Nama	Jenis	Deskripsi
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

Detail reseller.

Nama	Jenis	Deskripsi
description	string	Nama penjual.
resellerId	string	ID MPN dari reseller.

Products - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

UpdateBillingProperty

Sample Request

Sample Response

Definisi

Amount

AutoRenew

BillingFrequency

ErrorDetails

ErrorResponse

ErrorSubDetails

Product

ProductStatusType

Reseller

Sumber Daya Tambahan: