你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Products - Move

Service:

Billing

API Version:

2020-05-01

将产品的费用移动到新的发票科目。 新发票科目必须与现有发票科目属于同一计费配置文件。 只有以定期费用购买的产品以及协议类型为Microsoft 客户协议的计费帐户，才支持此操作。

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

URI 参数

名称	在	必需	类型	说明
billingAccountName	path	True	string	唯一标识计费帐户的 ID。
productName	path	True	string	唯一标识产品的 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 版本。 当前版本为 2020-05-01。

请求正文

名称	类型	说明
destinationInvoiceSectionId	string	目标发票科目 ID。

响应

名称	类型	说明
200 OK	Product	没问题。 请求已成功。
202 Accepted		已接受 Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

MoveProduct

Sample Request

HTTP

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

{
  "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
}

Java

import com.azure.resourcemanager.billing.models.TransferProductRequestProperties;

/** Samples for Products Move. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json
     */
    /**
     * Sample code: MoveProduct.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void moveProduct(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .products()
            .moveWithResponse(
                "{billingAccountName}",
                "{productName}",
                new TransferProductRequestProperties()
                    .withDestinationInvoiceSectionId(
                        "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"),
                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 move_product.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.products.move(
        billing_account_name="{billingAccountName}",
        product_name="{productName}",
        parameters={
            "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"
        },
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.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/MoveProduct.json
func ExampleProductsClient_Move() {
	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().Move(ctx, "{billingAccountName}", "{productName}", armbilling.TransferProductRequestProperties{
		DestinationInvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}"),
	}, 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}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}/products/{productName}"),
	// 	Properties: &armbilling.ProductProperties{
	// 		AutoRenew: to.Ptr(armbilling.AutoRenewOn),
	// 		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("Test Product"),
	// 		InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
	// 		InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{newBillingProfileName}/invoiceSections/{newInvoiceSectionName}"),
	// 		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 Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json
 */
async function moveProduct() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const productName = "{productName}";
  const parameters = {
    destinationInvoiceSectionId:
      "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.products.move(billingAccountName, productName, parameters);
  console.log(result);
}

moveProduct().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}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}/products/{productName}",
  "name": "{productName}",
  "type": "Microsoft.Billing/billingAccounts/products",
  "properties": {
    "autoRenew": "On",
    "productTypeId": "A12345",
    "productType": "Subscription",
    "displayName": "Test Product",
    "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/{newBillingProfileName}/invoiceSections/{newInvoiceSectionName}",
    "invoiceSectionDisplayName": "Contoso operations invoiceSection",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing"
  }
}

Status code:

202

Location: https://management.azure.com/providers/Microsoft.Billing/operationResults/44000000-0000-0000-0000-000000000000?api-version=2020-05-01
Retry-After: 60
OData-EntityId: 44000000-0000-0000-0000-000000000000

定义

名称	说明
Amount	金额。
AutoRenew	指示是打开还是关闭产品的自动续订。
BillingFrequency	产品计费的频率。
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。 错误消息中提供了原因。
ErrorSubDetails
Product	产品。
ProductStatusType	产品的当前状态。
Reseller	经销商的详细信息。
TransferProductRequestProperties	要启动转移的产品的属性。

Amount

金额。

名称	类型	说明
currency	string	金额值的货币。
value	number	金额值。

AutoRenew

指示是打开还是关闭产品的自动续订。

名称	类型	说明
Off	string
On	string

BillingFrequency

产品计费的频率。

名称	类型	说明
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

错误的详细信息。

名称	类型	说明
code	string	错误代码。
details	ErrorSubDetails[]	错误的子详细信息。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

ErrorSubDetails

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

Product

产品。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.autoRenew	AutoRenew	指示是打开还是关闭产品的自动续订。
properties.availabilityId	string	产品的可用性。
properties.billingFrequency	BillingFrequency	产品计费的频率。
properties.billingProfileDisplayName	string	向产品计费的计费对象信息的名称。
properties.billingProfileId	string	计费对象信息的 ID。
properties.customerDisplayName	string	为其购买产品的客户的名称。 字段仅适用于Microsoft 合作伙伴协议计费帐户。
properties.customerId	string	为其购买产品的客户的 ID。 字段仅适用于Microsoft 合作伙伴协议计费帐户。
properties.displayName	string	产品的显示名称。
properties.endDate	string	产品续订或取消的日期。
properties.invoiceSectionDisplayName	string	计费产品的发票科目的名称。
properties.invoiceSectionId	string	向产品计费的发票科目的 ID。
properties.lastCharge	Amount	上个月的费用。
properties.lastChargeDate	string	上次收费的日期。
properties.productType	string	产品类型的说明。
properties.productTypeId	string	产品类型的 ID。
properties.purchaseDate	string	购买产品的日期。
properties.quantity	number	为产品购买的数量。
properties.reseller	Reseller	此产品的经销商。
properties.skuDescription	string	产品的 SKU 说明。
properties.skuId	string	产品的 SKU ID。
properties.status	ProductStatusType	产品的当前状态。
properties.tenantId	string	在其中使用产品的租户的 ID。
type	string	资源类型。

ProductStatusType

产品的当前状态。

名称	类型	说明
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

经销商的详细信息。

名称	类型	说明
description	string	经销商的名称。
resellerId	string	经销商的 MPN ID。

TransferProductRequestProperties

要启动转移的产品的属性。

名称	类型	说明
destinationInvoiceSectionId	string	目标发票科目 ID。