Billing Subscriptions - List By Enrollment Account
列出注册帐户的订阅。 协议类型为企业协议的计费帐户支持此操作。
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
billing
|
path | True |
string |
唯一标识计费帐户的 ID。 |
enrollment
|
path | True |
string pattern: ^[a-zA-Z\d-_]{1,128}$ |
注册帐户的名称。 |
api-version
|
query | True |
string |
要用于客户端请求的 API 的版本。 当前版本为 2024-04-01。 |
count
|
query |
boolean |
Count 查询选项允许客户端请求响应中资源中包含的匹配资源的计数。 |
|
filter
|
query |
string |
筛选器查询选项允许客户端筛选请求 URL 寻址的资源集合。 |
|
order
|
query |
string |
orderby 查询选项允许客户端按特定顺序请求资源。 |
|
search
|
query |
string |
搜索查询选项允许客户端请求与自由文本搜索表达式匹配的集合中的项。 仅字符串字段支持搜索。 |
|
skip
|
query |
integer (int64) |
skip 查询选项请求要跳过且不包含在结果中的查询集合中的项数。 |
|
top
|
query |
integer (int64) |
顶部查询选项请求将查询集合中的项数包含在结果中。 顶部支持的最大值为 50。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
计费订阅的列表。 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
示例
BillingSubscriptionsListByEnrollmentAccount
示例请求
示例响应
{
"value": [
{
"id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000000",
"name": "90000000-0000-0000-0000-000000000000",
"properties": {
"consumptionCostCenter": "123",
"displayName": "TestSubscription",
"enrollmentAccountId": "172988",
"enrollmentAccountDisplayName": "billtest332211@outlook.com",
"enrollmentAccountSubscriptionDetails": {
"enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z"
},
"offerId": "MS-AZR-0017P",
"subscriptionId": "90000000-0000-0000-0000-000000000000"
},
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions"
},
{
"id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000001",
"name": "90000000-0000-0000-0000-000000000001",
"properties": {
"consumptionCostCenter": "",
"displayName": "Microsoft Azure Enterprise-1",
"enrollmentAccountId": "172988",
"enrollmentAccountDisplayName": "billtest332211@outlook.com",
"enrollmentAccountSubscriptionDetails": {
"enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z",
"subscriptionEnrollmentAccountStatus": "Deleted"
},
"offerId": "MS-AZR-0136P",
"subscriptionId": "90000000-0000-0000-0000-000000000001"
},
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions"
}
]
}
定义
名称 | 说明 |
---|---|
Amount |
金额。 |
Auto |
指示产品是否打开或关闭自动续订。 |
Beneficiary |
受益者的详细信息。 |
Billing |
订阅的计费属性。 |
Billing |
资源列表的容器 |
Billing |
订阅上操作的状态。 无时,没有正在进行的操作。 LockedForUpdate 时,计费订阅上的写入操作将被阻止。 另一个是默认值,可能需要参考最新的 API 版本以获取更多详细信息。 |
Billing |
订阅的状态。 此字段不适用于企业协议计费帐户 |
Billing |
订阅的暂停详细信息。 此字段不适用于企业协议计费帐户。 |
Cancellation |
订阅的策略替代指示是允许自助取消还是允许减少席位。 |
created |
创建资源的标识的类型。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Next |
产品的计费周期详细信息。 |
Provisioning |
长时间运行的操作期间资源的预配状态。 |
Renewal |
订阅的下一个续订期限的详细信息。 |
Reseller |
经销商的详细信息。 |
Subscription |
订阅的当前注册帐户状态。 此字段仅适用于企业协议类型。 |
Subscription |
订阅的暂停原因。 此字段不适用于企业协议计费帐户。 |
system |
与创建和上次修改资源相关的元数据。 |
System |
系统施加了规范订阅行为的策略。 |
Amount
金额。
名称 | 类型 | 说明 |
---|---|---|
currency |
string |
金额值的货币。 |
value |
number |
金额值。 例如,如果货币是美元,则值 600 将为 $600.00。 |
AutoRenew
指示产品是否打开或关闭自动续订。
值 | 说明 |
---|---|
Off | |
On |
Beneficiary
受益者的详细信息。
名称 | 类型 | 说明 |
---|---|---|
objectId |
string |
唯一标识租户中的用户的 ID。 |
tenantId |
string |
唯一标识租户的 ID。 |
BillingSubscription
订阅的计费属性。
名称 | 类型 | 说明 |
---|---|---|
id |
string (arm-id) |
资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
name |
string |
资源的名称 |
properties.autoRenew |
指示产品是否打开或关闭自动续订。 |
|
properties.beneficiary |
计费订阅的受益者。 |
|
properties.beneficiaryTenantId |
string |
订阅的预配租户。 |
properties.billingFrequency |
string |
订阅中产品ISO8601格式的计费频率。 示例:P1M、P3M、P1Y |
properties.billingPolicies |
object |
与订阅关联的计费策略字典。 |
properties.billingProfileDisplayName |
string |
计费配置文件的名称。 |
properties.billingProfileId |
string |
唯一标识计费配置文件的完全限定 ID。 |
properties.billingProfileName |
string |
唯一标识计费配置文件的 ID。 |
properties.consumptionCostCenter |
string |
应用于订阅的成本中心。 此字段仅适用于Microsoft客户协议或企业协议类型计费帐户的消耗订阅。 |
properties.customerDisplayName |
string |
客户的名称。 |
properties.customerId |
string |
唯一标识客户的完全限定 ID。 |
properties.customerName |
string |
唯一标识客户的 ID。 |
properties.displayName |
string |
计费订阅的名称。 |
properties.enrollmentAccountDisplayName |
string |
与订阅关联的注册帐户名称。 此字段仅适用于企业协议类型计费帐户。 |
properties.enrollmentAccountId |
string |
与订阅关联的注册帐户 ID。 此字段仅适用于企业协议类型计费帐户。 |
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate |
string (date-time) |
注册帐户和订阅关联开始日期。 此字段仅适用于企业协议类型。 |
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus |
订阅的当前注册帐户状态。 此字段仅适用于企业协议类型。 |
|
properties.invoiceSectionDisplayName |
string |
发票科目的名称。 |
properties.invoiceSectionId |
string |
唯一标识发票科目的完全限定 ID。 |
properties.invoiceSectionName |
string |
唯一标识发票科目的 ID。 |
properties.lastMonthCharges |
上个月的费用。 此字段仅适用于Microsoft客户协议计费帐户的基于使用情况的订阅。 |
|
properties.monthToDateCharges |
本月至今费用。 此字段仅适用于Microsoft客户协议计费帐户的基于使用情况的订阅。 |
|
properties.nextBillingCycleDetails |
订阅的下一个计费周期详细信息。 |
|
properties.offerId |
string |
订阅的产品/服务 ID。 此字段仅适用于Microsoft联机服务计划计费帐户或协议类型为企业协议的计费帐户。 |
properties.operationStatus |
订阅上操作的状态。 无时,没有正在进行的操作。 LockedForUpdate 时,计费订阅上的写入操作将被阻止。 另一个是默认值,可能需要参考最新的 API 版本以获取更多详细信息。 |
|
properties.productCategory |
string |
为其购买订阅的产品类别。 可能的值包括:AzureSupport、Hardware、ReservationOrder、SaaS、SavingsPlanOrder、Software、UsageBased、Other。 |
properties.productType |
string |
为其购买订阅的产品的类型。 |
properties.productTypeId |
string |
为其购买订阅的产品 ID。 |
properties.provisioningState |
长时间运行的操作期间资源的预配状态。 |
|
properties.provisioningTenantId |
string |
在其中预配订阅的租户。 |
properties.purchaseDate |
string (date-time) |
以 UTC 时间购买产品的购买日期。 |
properties.quantity |
integer (int64) |
订阅的许可证或履行单位数量。 |
properties.renewalTermDetails |
订阅的下一个续订期限的详细信息。 |
|
properties.reseller |
此订阅的经销商。 字段不适用于Microsoft合作伙伴协议计费帐户。 |
|
properties.resourceUri |
string |
链接资源的唯一标识符。 |
properties.skuDescription |
string |
为其购买订阅的产品的 SKU 说明。 此字段仅适用于协议类型Microsoft客户协议和Microsoft合作伙伴协议的计费帐户。 |
properties.skuId |
string |
为其购买订阅的产品的 SKU ID。 此字段仅适用于Microsoft客户协议计费帐户。 |
properties.status |
订阅的状态。 此字段不适用于企业协议计费帐户 |
|
properties.subscriptionId |
string |
订阅的 ID。 |
properties.suspensionReasonDetails |
订阅的暂停详细信息。 此字段不适用于企业协议计费帐户。 |
|
properties.suspensionReasons |
string[] |
订阅的暂停原因。 此字段不适用于企业协议计费帐户。 |
properties.systemOverrides |
系统施加了规范订阅行为的策略。 |
|
properties.termDuration |
string |
可以使用订阅的ISO8601格式的持续时间。 示例:P1M、P3M、P1Y |
properties.termEndDate |
string (date-time) |
以 UTC 时间表示的术语结束日期。 |
properties.termStartDate |
string (date-time) |
以 UTC 时间表示的术语开始日期。 |
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
与资源关联的元数据字典。 它可能不会针对所有资源类型进行填充。 支持的最大键/值长度为 256 个字符。 键/值不应为空值,也不应为 null。 键不能包含 <> % & \ ? / |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
BillingSubscriptionListResult
资源列表的容器
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
指向下一页结果的链接(url)。 |
totalCount |
number (int32) |
记录总数。 |
value |
资源列表。 |
BillingSubscriptionOperationStatus
订阅上操作的状态。 无时,没有正在进行的操作。 LockedForUpdate 时,计费订阅上的写入操作将被阻止。 另一个是默认值,可能需要参考最新的 API 版本以获取更多详细信息。
值 | 说明 |
---|---|
LockedForUpdate | |
None | |
Other |
BillingSubscriptionStatus
订阅的状态。 此字段不适用于企业协议计费帐户
值 | 说明 |
---|---|
Active | |
AutoRenew | |
Cancelled | |
Deleted | |
Disabled | |
Expired | |
Expiring | |
Failed | |
Other | |
Suspended | |
Unknown | |
Warned |
BillingSubscriptionStatusDetails
订阅的暂停详细信息。 此字段不适用于企业协议计费帐户。
名称 | 类型 | 说明 |
---|---|---|
effectiveDate |
string (date-time) |
订阅的暂停生效日期。 此字段不适用于企业协议计费帐户。 |
reason |
订阅的暂停原因。 此字段不适用于企业协议计费帐户。 |
Cancellation
订阅的策略替代指示是允许自助取消还是允许减少席位。
值 | 说明 |
---|---|
Allowed | |
NotAllowed |
createdByType
创建资源的标识的类型。
值 | 说明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
NextBillingCycleDetails
产品的计费周期详细信息。
名称 | 类型 | 说明 |
---|---|---|
billingFrequency |
string |
订阅下产品的计费频率。 |
ProvisioningState
长时间运行的操作期间资源的预配状态。
值 | 说明 |
---|---|
Canceled | |
Failed | |
New | |
Pending | |
Provisioning | |
Succeeded |
RenewalTermDetails
订阅的下一个续订期限的详细信息。
名称 | 类型 | 说明 |
---|---|---|
billingFrequency |
string |
订阅中产品ISO8601格式的计费频率。 示例:P1M、P3M、P1Y |
productId |
string |
为其购买订阅的产品 ID。 |
productTypeId |
string |
购买订阅的产品的类型 ID。 |
quantity |
integer (int64) |
订阅的许可证或履行单位数量。 |
skuId |
string |
为其购买订阅的产品的 SKU ID。 此字段仅适用于Microsoft客户协议计费帐户。 |
termDuration |
string |
可以使用订阅的ISO8601格式的持续时间。 示例:P1M、P3M、P1Y |
termEndDate |
string (date-time) |
以 UTC 时间表示的术语结束日期。 |
Reseller
经销商的详细信息。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
经销商的名称。 |
resellerId |
string |
经销商的 MPN ID。 |
SubscriptionEnrollmentAccountStatus
订阅的当前注册帐户状态。 此字段仅适用于企业协议类型。
值 | 说明 |
---|---|
Active | |
Cancelled | |
Deleted | |
Expired | |
Inactive | |
TransferredOut | |
Transferring |
SubscriptionStatusReason
订阅的暂停原因。 此字段不适用于企业协议计费帐户。
值 | 说明 |
---|---|
Cancelled | |
Expired | |
None | |
Other | |
PastDue | |
PolicyViolation | |
SpendingLimitReached | |
SuspiciousActivity | |
Transferred |
systemData
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |
SystemOverrides
系统施加了规范订阅行为的策略。
名称 | 类型 | 说明 |
---|---|---|
cancellation |
订阅的策略替代指示是允许自助取消还是允许减少席位。 |
|
cancellationAllowedEndDate |
string (date-time) |
自助取消结束时的 UTC 时间结束日期。 |