通过

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

Products - List By Billing Profile

  • 参考
Service:
Billing
API Version:
2020-05-01

列出计费对象信息的产品。 这些不包括根据使用情况计费的产品。 协议类型为 Microsoft 客户协议 或 Microsoft 合作伙伴协议 的计费帐户支持此操作。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products?api-version=2020-05-01
With optional parameters: 
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products?api-version=2020-05-01&$filter={$filter}

URI 参数

名称 在 必需 类型 说明
billingAccountName
 path True

string

唯一标识计费帐户的 ID。
billingProfileName
 path True

string

唯一标识计费配置文件的 ID。
api-version
 query True

string

要与客户端请求一起使用的 API 版本。 当前版本为 2020-05-01。
$filter
 query

string

可用于按产品类型进行筛选。 筛选器支持“eq”、“lt”、“gt”、“le”、“ge”和”。 它当前不支持“ne”、“or”或“not”。 标记筛选器是键值对字符串，其中键和值用冒号 (：) 分隔。

响应

名称 类型 说明
200 OK

ProductsListResult

没问题。 请求已成功。
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 模拟用户帐户

示例

ProductsListByBillingProfile

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Billing/billingAccounts/products",
      "properties": {
        "autoRenew": "On",
        "productTypeId": "A12345",
        "productType": "Reservation",
        "displayName": "Eng Reservation (1a13s21awe)",
        "status": "Active",
        "purchaseDate": "2018-05-01T17:32:28Z",
        "lastCharge": {
          "currency": "USD",
          "value": 5000
        },
        "lastChargeDate": "2018-06-15T17:32:28Z",
        "quantity": 4,
        "skuId": "0001",
        "skuDescription": "Enterprise Agreement Development",
        "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
        "availabilityId": "AvailabilityId1",
        "billingFrequency": "OneTime",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
        "billingProfileDisplayName": "Contoso operations billing"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
      "name": "10000000-0000-0000-0000-000000000001",
      "type": "Microsoft.Billing/billingAccounts/products",
      "properties": {
        "autoRenew": "On",
        "productTypeId": "A12345",
        "productType": "Azure subscription",
        "displayName": "Engineering Email",
        "status": "Active",
        "purchaseDate": "2018-04-01T17:32:28Z",
        "lastCharge": {
          "currency": "USD",
          "value": 5000
        },
        "lastChargeDate": "2018-06-15T17:32:28Z",
        "quantity": 4,
        "skuId": "0001",
        "skuDescription": "Enterprise Agreement Development",
        "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
        "availabilityId": "AvailabilityId1",
        "billingFrequency": "Monthly",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
        "billingProfileDisplayName": "Contoso operations billing"
      }
    }
  ],
  "totalCount": 2
}

定义

名称 说明
Amount

金额。
AutoRenew

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

产品计费的频率。
ErrorDetails

错误的详细信息。
ErrorResponse

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

产品。
ProductsListResult

产品列表。 它包含按购买日期按反向时间顺序排列的可用产品摘要列表。
ProductStatusType

产品的当前状态。
Reseller

经销商的详细信息。

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

资源类型。

ProductsListResult

产品列表。 它包含按购买日期按反向时间顺序排列的可用产品摘要列表。

名称 类型 说明
nextLink

string

链接 (url) 到结果的下一页。
totalCount

number

总记录数。
value

Product[]

产品列表。

ProductStatusType

产品的当前状态。

名称 类型 说明
Active

string

AutoRenew

string

Cancelled

string

Disabled

string

Expired

string

Expiring

string

Inactive

string

PastDue

string

Reseller

经销商的详细信息。

名称 类型 说明
description

string

经销商的名称。
resellerId

string

经销商的 MPN ID。