Products - Get

Service:

Billing

API Version:

2020-05-01

依標識碼取得產品。 只有合約類型為 Microsoft 客戶合約的計費帳戶才支援此作業。

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

URI 參數

名稱	位於	必要	類型	Description
billingAccountName	path	True	string	可唯一識別計費帳戶的標識碼。
productName	path	True	string	可唯一識別產品的標識碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。 目前的版本為 2020-05-01。

回應

名稱	類型	Description
200 OK	Product	正常。 要求已成功。
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

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Product

Sample Request

HTTP

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

Java

/** Samples for Products Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
     */
    /**
     * Sample code: Product.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void product(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.products().getWithResponse("{billingAccountName}", "{productName}", 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 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.get(
        billing_account_name="{billingAccountName}",
        product_name="{productName}",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.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/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/Product.json
func ExampleProductsClient_Get() {
	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().Get(ctx, "{billingAccountName}", "{productName}", 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.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("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 Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Gets a product by ID. 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/Product.json
 */
async function product() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const productName = "{productName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.products.get(billingAccountName, productName);
  console.log(result);
}

product().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": "On",
    "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"
  }
}

定義

名稱	Description
Amount	數量。
AutoRenew	指出產品是否開啟或關閉自動更新。
BillingFrequency	產品的計費頻率。
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。 錯誤訊息中會提供原因。
ErrorSubDetails
Product	產品。
ProductStatusType	產品的目前狀態。
Reseller	轉銷商的詳細數據。

Amount

數量。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	金額值。

AutoRenew

指出產品是否開啟或關閉自動更新。

名稱	類型	Description
Off	string
On	string

BillingFrequency

產品的計費頻率。

名稱	類型	Description
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorSubDetails[]	錯誤的子詳細數據。
message	string	錯誤訊息，指出作業失敗的原因。
target	string	特定錯誤的目標。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中會提供原因。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據。

ErrorSubDetails

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。
target	string	特定錯誤的目標。

Product

產品。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.autoRenew	AutoRenew	指出產品是否開啟或關閉自動更新。
properties.availabilityId	string	產品的可用性。
properties.billingFrequency	BillingFrequency	產品的計費頻率。
properties.billingProfileDisplayName	string	計費產品的帳單配置檔名稱。
properties.billingProfileId	string	計費產品的帳單配置檔標識碼。
properties.customerDisplayName	string	購買產品的客戶名稱。 欄位僅適用於 Microsoft 合作夥伴合約 計費帳戶。
properties.customerId	string	購買產品之客戶的標識碼。 欄位僅適用於 Microsoft 合作夥伴合約 計費帳戶。
properties.displayName	string	產品的顯示名稱。
properties.endDate	string	產品將會更新或取消的日期。
properties.invoiceSectionDisplayName	string	要向產品計費的發票區段名稱。
properties.invoiceSectionId	string	要向產品計費之發票區段的標識碼。
properties.lastCharge	Amount	上個月的費用。
properties.lastChargeDate	string	上次收費的日期。
properties.productType	string	產品類型的描述。
properties.productTypeId	string	產品類型的標識碼。
properties.purchaseDate	string	購買產品的日期。
properties.quantity	number	為產品購買的數量。
properties.reseller	Reseller	此產品的轉銷商。
properties.skuDescription	string	產品的 SKU 描述。
properties.skuId	string	產品的 SKU 識別碼。
properties.status	ProductStatusType	產品的目前狀態。
properties.tenantId	string	使用產品之租用戶的標識碼。
type	string	資源類型。

ProductStatusType

產品的目前狀態。

名稱	類型	Description
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

轉銷商的詳細數據。

名稱	類型	Description
description	string	轉銷商的名稱。
resellerId	string	轉銷商的 MPN 識別碼。