Billing Subscriptions - List By Customer

Ссылка

Service:: Billing

API Version:: 2020-05-01

Список подписок для клиента. Операция поддерживается только для учетных записей выставления счетов с типом соглашения Соглашение с партнером Майкрософт.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string	Идентификатор, однозначно определяющий учетную запись выставления счетов.
customerName	path	True	string	Идентификатор, который уникально идентифицирует клиента.
api-version	query	True	string	Версия API, используемая с клиентским запросом. Текущая версия — 01.05.2020.

Ответы

Имя	Тип	Описание
200 OK	BillingSubscriptionsListResult	Все в порядке. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

BillingSubscriptionsListByCustomer

Sample Request

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

/** Samples for BillingSubscriptions ListByCustomer. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json
     */
    /**
     * Sample code: BillingSubscriptionsListByCustomer.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingSubscriptionsListByCustomer(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingSubscriptions()
            .listByCustomer("{billingAccountName}", "{customerName}", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_subscriptions_list_by_customer.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.billing_subscriptions.list_by_customer(
        billing_account_name="{billingAccountName}",
        customer_name="{customerName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.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

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/BillingSubscriptionsListByCustomer.json
func ExampleSubscriptionsClient_NewListByCustomerPager() {
	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)
	}
	pager := clientFactory.NewSubscriptionsClient().NewListByCustomerPager("{billingAccountName}", "{customerName}", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SubscriptionsListResult = armbilling.SubscriptionsListResult{
		// 	Value: []*armbilling.Subscription{
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId1"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				CustomerDisplayName: to.Ptr("Customer1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("My subscription"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](600),
		// 				},
		// 				Reseller: &armbilling.Reseller{
		// 					Description: to.Ptr("Reseller1"),
		// 					ResellerID: to.Ptr("89e87bdf-a2a2-4687-925f-4c18b27bccfd"),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				SKUID: to.Ptr("0002"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-f87744185aa3"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId2"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				CustomerDisplayName: to.Ptr("Customer1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("Test subscription"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](400),
		// 				},
		// 				Reseller: &armbilling.Reseller{
		// 					Description: to.Ptr("Reseller3"),
		// 					ResellerID: to.Ptr("3b65b5a8-bd4f-4084-90e9-e1bd667a2b19"),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				SKUID: to.Ptr("0002"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-6b96d3f2"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json
 */
async function billingSubscriptionsListByCustomer() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const customerName = "{customerName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingSubscriptions.listByCustomer(
    billingAccountName,
    customerName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

billingSubscriptionsListByCustomer().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

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
      "name": "billingSubscriptionId1",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "My subscription",
        "subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4994",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 5000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 600
        },
        "costCenter": "ABC1234",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer1",
        "reseller": {
          "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
          "description": "Reseller1"
        },
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
      "name": "billingSubscriptionId2",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "Test subscription",
        "subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4995",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 1000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 400
        },
        "costCenter": "ABC1234",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer1",
        "reseller": {
          "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
          "description": "Reseller3"
        },
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    }
  ]
}

Определения

Имя	Описание
Amount	Сумма.
BillingSubscription	Подписка на выставление счетов.
BillingSubscriptionsListResult	Список подписок на выставление счетов.
BillingSubscriptionStatusType	Текущее состояние выставления счетов подписки.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
ErrorSubDetails
Reseller	Сведения о торговом посреднике.

Amount

Сумма.

Имя	Тип	Описание
currency	string	Валюта для значения суммы.
value	number	Значение суммы.

BillingSubscription

Подписка на выставление счетов.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.billingProfileDisplayName	string	Имя профиля выставления счетов, за который выставляется счет за подписку.
properties.billingProfileId	string	Идентификатор профиля выставления счетов, за который выставляется счет за подписку.
properties.costCenter	string	Центр затрат, применяемый к подписке.
properties.customerDisplayName	string	Имя клиента, для которого была создана подписка. Поле применимо только для учетной записи выставления счетов Соглашение с партнером Майкрософт.
properties.customerId	string	Идентификатор клиента, для которого была создана подписка. Поле применимо только для учетной записи выставления счетов Соглашение с партнером Майкрософт.
properties.displayName	string	Имя подписки.
properties.invoiceSectionDisplayName	string	Имя раздела счета, для которого выставляется счет за подписку.
properties.invoiceSectionId	string	Идентификатор раздела счета, в котором выставляется счет за подписку.
properties.lastMonthCharges	Amount	Расходы за последний месяц.
properties.monthToDateCharges	Amount	Текущие расходы за текущий месяц.
properties.reseller	Reseller	Торговый посредник для этой подписки.
properties.skuDescription	string	Описание SKU плана Azure для подписки.
properties.skuId	string	Идентификатор SKU плана Azure для подписки.
properties.subscriptionBillingStatus	BillingSubscriptionStatusType	Текущее состояние выставления счетов подписки.
properties.subscriptionId	string	Идентификатор подписки.
properties.suspensionReasons	string[]	Причина приостановки подписки. Применяется только к подпискам в учетных записях выставления счетов программы Microsoft Online Services.
type	string	Тип ресурса.

BillingSubscriptionsListResult

Список подписок на выставление счетов.

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
totalCount	number	Общее количество записей.
value	BillingSubscription[]	Список подписок на выставление счетов.

BillingSubscriptionStatusType

Текущее состояние выставления счетов подписки.

Имя	Тип	Описание
Abandoned	string
Active	string
Deleted	string
Inactive	string
Warning	string

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	ErrorSubDetails[]	Дополнительные сведения об ошибке.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.
target	string	Целевой объект конкретной ошибки.

ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

ErrorSubDetails

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.
target	string	Целевой объект конкретной ошибки.

Reseller

Сведения о торговом посреднике.

Имя	Тип	Описание
description	string	Имя торгового посредника.
resellerId	string	Идентификатор MPN торгового посредника.

Billing Subscriptions - List By Customer

Параметры URI

Ответы

Безопасность

azure_auth

Scopes

Примеры

BillingSubscriptionsListByCustomer

Sample Request

Sample Response

Определения

Amount

BillingSubscription

BillingSubscriptionsListResult

BillingSubscriptionStatusType

ErrorDetails

ErrorResponse

ErrorSubDetails

Reseller

Дополнительные ресурсы