Billing Subscriptions - List By Billing Account

參考

Service:: Billing

API Version:: 2021-10-01

列出計費帳戶的訂用帳戶。目前支援合約類型為 Microsoft 客戶合約、Microsoft 合作夥伴合約和 Microsoft Online Services 方案的計費帳戶。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions?api-version=2021-10-01

URI 參數

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

回應

名稱	類型	Description
200 OK	BillingSubscriptionsListResult	正常。要求成功。
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	模擬您的用戶帳戶

範例

BillingSubscriptionsListByBillingAccount

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions?api-version=2021-10-01

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/examples/BillingSubscriptionsListByBillingAccount.json
// this example is just showing the usage of "BillingSubscriptions_ListByBillingAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this BillingSubscriptionResource
string billingAccountName = "{billingAccountName}";
BillingSubscriptionCollection collection = tenantResource.GetBillingSubscriptions(billingAccountName);

// invoke the operation and iterate over the result
await foreach (BillingSubscriptionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BillingSubscriptionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "totalCount": 3,
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07",
      "name": "418b0e9c-5dc3-4260-918f-30b90619fe07",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "autoRenew": "Off",
        "billingFrequency": "P1M",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664",
        "billingProfileDisplayName": "Contoso operations billing profile",
        "billingProfileName": "2b72f936-0166-47d6-91a3-ef9f84f36664",
        "displayName": "Subscription 1",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664/invoiceSections/5c562559-e31b-4bfe-b608-f8b5b3fbd073",
        "invoiceSectionDisplayName": "Contoso operations invoice section",
        "invoiceSectionName": "5c562559-e31b-4bfe-b608-f8b5b3fbd073",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 5000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 600
        },
        "productCategory": "UsageBased",
        "productType": "Usage based",
        "productTypeId": "DZH318Z0BPS6",
        "purchaseDate": "2021-10-01T00:00:00Z",
        "quantity": 1,
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan",
        "status": "Active",
        "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/9e030ae5-51ed-4e02-8e17-d51b3aa55980",
      "name": "9e030ae5-51ed-4e02-8e17-d51b3aa55980",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "autoRenew": "Off",
        "billingFrequency": "P1M",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664",
        "billingProfileDisplayName": "Contoso operations billing profile",
        "billingProfileName": "2b72f936-0166-47d6-91a3-ef9f84f36664",
        "displayName": "Subscription 2",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664/invoiceSections/5c562559-e31b-4bfe-b608-f8b5b3fbd073",
        "invoiceSectionDisplayName": "Contoso operations invoice section",
        "invoiceSectionName": "5c562559-e31b-4bfe-b608-f8b5b3fbd073",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 1000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 400
        },
        "productCategory": "UsageBased",
        "productType": "Usage based",
        "productTypeId": "DZH318Z0BPS6",
        "purchaseDate": "2021-10-01T00:00:00Z",
        "quantity": 1,
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan",
        "status": "Active",
        "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}billingSubscriptions/7f271b5e-a89e-45cc-8fa5-cd5c643f8b5e",
      "name": "7f271b5e-a89e-45cc-8fa5-cd5c643f8b5e",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "autoRenew": "Off",
        "billingFrequency": "P1M",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664",
        "billingProfileDisplayName": "Contoso operations billing profile",
        "billingProfileName": "2b72f936-0166-47d6-91a3-ef9f84f36664",
        "displayName": "Subscription 3",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664/invoiceSections/5c562559-e31b-4bfe-b608-f8b5b3fbd0730",
        "invoiceSectionDisplayName": "Contoso operations invoice section",
        "invoiceSectionName": "5c562559-e31b-4bfe-b608-f8b5b3fbd073",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 6000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 900
        },
        "productCategory": "SeatBased",
        "productType": "Microsoft 365 Business Standard",
        "productTypeId": "CFQ7TTC0LDPB",
        "purchaseDate": "2021-08-01T00:12:49.7261677+00:00",
        "quantity": 4,
        "skuId": "0001",
        "skuDescription": "Microsoft 365 Business Standard",
        "status": "Active",
        "termDuration": "P1Y",
        "termStartDate": "2021-10-01T00:00:00Z",
        "termEndDate": "2022-09-30T00:00:00Z"
      }
    }
  ]
}

定義

名稱	Description
Amount	金額。
AutoRenew	指出是否開啟或關閉訂閱的自動更新。
BillingSubscription	計費訂用帳戶。
BillingSubscriptionsListResult	計費訂用帳戶的清單。
BillingSubscriptionStatus	訂閱的狀態。此欄位不適用於 Enterprise 合約計費帳戶。
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。錯誤訊息中提供了原因。
ErrorSubDetails	錯誤的子詳細數據。
NextBillingCycleDetails	訂用帳戶的下一個計費週期詳細數據。
RenewalTermDetails	續約時訂閱的字詞詳細數據。
Reseller	轉銷商的詳細數據。
SubscriptionEnrollmentAccountStatus	訂用帳戶目前的註冊帳戶狀態。此欄位僅適用於 Enterprise 合約計費帳戶。

Amount

金額。

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

AutoRenew

指出是否開啟或關閉訂閱的自動更新。

名稱	類型	Description
Off	string
On	string

BillingSubscription

計費訂用帳戶。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.autoRenew	AutoRenew	指出是否開啟或關閉訂閱的自動更新。
properties.beneficiaryTenantId	string	訂用帳戶的布建租使用者。
properties.billingFrequency	string	ISO8601格式的訂用帳戶計費頻率。範例：P1M、P3M、P1Y
properties.billingPolicies	object	與訂用帳戶相關聯的計費原則字典。
properties.billingProfileDisplayName	string	計費訂用帳戶之帳單配置檔的顯示名稱。此欄位僅適用於 Microsoft 客戶合約計費帳戶。
properties.billingProfileId	string	訂用帳戶所要計費之帳單配置檔的標識碼。此欄位僅適用於 Microsoft 客戶合約計費帳戶。
properties.billingProfileName	string	計費訂用帳戶的帳單配置檔名稱。此欄位僅適用於 Microsoft 客戶合約計費帳戶。
properties.consumptionCostCenter	string	套用至訂用帳戶的成本中心。此欄位僅適用於 Microsoft 客戶合約類型計費帳戶的取用帳戶。
properties.customerDisplayName	string	建立訂用帳戶的客戶名稱。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.customerId	string	建立訂用帳戶的客戶標識碼。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.customerName	string	建立訂用帳戶的客戶名稱。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.displayName	string	訂閱的名稱。
properties.enrollmentAccountDisplayName	string	與訂用帳戶相關聯的註冊帳戶名稱。此欄位僅適用於 Enterprise 合約計費帳戶。
properties.enrollmentAccountId	string	與訂用帳戶相關聯的註冊帳戶標識碼。此欄位僅適用於 Enterprise 合約計費帳戶。
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string	註冊帳戶和訂用帳戶關聯開始日期。此欄位僅適用於 Enterprise 合約計費帳戶。
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	訂用帳戶目前的註冊帳戶狀態。此欄位僅適用於 Enterprise 合約計費帳戶。
properties.invoiceSectionDisplayName	string	訂用帳戶計費的發票區段顯示名稱。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.invoiceSectionId	string	訂用帳戶計費的發票區段標識碼。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.invoiceSectionName	string	訂用帳戶計費的發票區段名稱。欄位僅適用於 Microsoft 合作夥伴合約計費帳戶。
properties.lastMonthCharges	Amount	上個月的費用。此欄位僅適用於 Microsoft 客戶合約計費帳戶的使用量型訂用帳戶。
properties.monthToDateCharges	Amount	目前月份到日期的費用。此欄位僅適用於 Microsoft 客戶合約計費帳戶的使用量型訂用帳戶。
properties.nextBillingCycleDetails	NextBillingCycleDetails	訂用帳戶的下一個計費週期詳細數據。
properties.offerId	string	訂用帳戶的供應項目標識碼。此字段僅適用於 Microsoft Online Services 方案計費帳戶。
properties.productCategory	string	購買訂閱的產品類別。可能的值包括：AzureSupport、Hardware、ReservationOrder、SaaS、SavingsPlanOrder、Software、UsageBased、Other
properties.productType	string	購買訂閱的產品類型
properties.productTypeId	string	購買訂閱的產品標識碼
properties.purchaseDate	string	以UTC時間為單位的訂閱購買日期。
properties.quantity	integer	為訂用帳戶購買的授權數目
properties.renewalTermDetails	RenewalTermDetails	下一次續約時訂閱的字詞詳細數據。
properties.reseller	Reseller	建立訂用帳戶的轉銷商。此欄位適用於 Microsoft 合作夥伴合約計費帳戶。
properties.skuDescription	string	購買訂用帳戶之產品的 SKU 描述。此欄位僅適用於 Microsoft 客戶合約計費帳戶。
properties.skuId	string	購買訂用帳戶之產品的 SKU 標識符。此欄位僅適用於 Microsoft 客戶合約計費帳戶。
properties.status	BillingSubscriptionStatus	訂閱的狀態。此欄位不適用於 Enterprise 合約計費帳戶。
properties.subscriptionId	string	以使用量為基礎的訂用帳戶標識碼。此欄位僅適用於 Microsoft 客戶合約計費帳戶的使用方式型訂用帳戶。
properties.suspensionReasons	string[]	訂閱的暫停原因。此欄位不適用於 Enterprise 合約計費帳戶。
properties.termDuration	string	您可以使用訂用帳戶的持續時間。範例 P1Y 和 P1M
properties.termEndDate	string	以UTC時間表示之字詞的結束日期。
properties.termStartDate	string	以UTC時間表示的字詞開始日期。
type	string	資源類型。

BillingSubscriptionsListResult

計費訂用帳戶的清單。

名稱	類型	Description
nextLink	string	連結 (url) 至下一頁的結果。
totalCount	number	總記錄數。
value	BillingSubscription[]	計費訂用帳戶的清單。

BillingSubscriptionStatus

訂閱的狀態。此欄位不適用於 Enterprise 合約計費帳戶。

名稱	類型	Description
Active	string
AutoRenew	string
Cancelled	string
Deleted	string
Disabled	string
Expired	string
Expiring	string
Suspended	string
Unknown	string
Warned	string

ErrorDetails

錯誤的詳細數據。

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

ErrorResponse

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

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

ErrorSubDetails

錯誤的子詳細數據。

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

NextBillingCycleDetails

訂用帳戶的下一個計費週期詳細數據。

名稱	類型	Description
billingFrequency	string	下一個計費週期中訂用帳戶的計費頻率。

RenewalTermDetails

續約時訂閱的字詞詳細數據。

名稱	類型	Description
billingFrequency	string	訂用帳戶的計費頻率。
productTypeId	string	產品的識別碼。
quantity	integer	授權數目
skuId	string	產品的 SKU 識別碼
termDuration	string	訂用帳戶的期間。範例 P1M 和 P1Y

Reseller

轉銷商的詳細數據。

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

SubscriptionEnrollmentAccountStatus

訂用帳戶目前的註冊帳戶狀態。此欄位僅適用於 Enterprise 合約計費帳戶。

名稱	類型	Description
Active	string
Cancelled	string
Deleted	string
Expired	string
TransferredOut	string
Transferring	string