Lots - List By Billing Account

Service:

Consumption

API Version:

2021-10-01

Выводит список всех Microsoft Azure обязательств по потреблению для учетной записи выставления счетов. API поддерживается только для учетных записей выставления счетов Microsoft Customer Agreement (MCA) и Direct Соглашение Enterprise (EA).

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

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/lots?api-version=2021-10-01&$filter={$filter}

Параметры URI

Name	In	Required	Type	Description
billingAccountId	path	True	string	Идентификатор BillingAccount
api-version	query	True	string	Версия API, используемая с клиентским запросом. Текущая версия — 2021-10-01.
$filter	query		string	Может использоваться для фильтрации количества по состоянию, источнику и т. д. Фильтр поддерживает "eq", "lt", "gt", "le", "ge" и "and". В настоящее время он не поддерживает "ne", "or" или "not". Фильтр тегов — это строка пары "ключ-значение", где ключ и значение разделяются двоеточием (:).

Ответы

Name	Type	Description
200 OK	Lots	Все в порядке. Запрос выполнен успешно.
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

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

LotsListByBillingAccount

LotsListByBillingAccountWithStatusFilter

LotsListByBillingAccount

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/1234:5678/providers/Microsoft.Consumption/lots?api-version=2021-10-01

Java

import com.azure.core.util.Context;

/** Samples for LotsOperation ListByBillingAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/LotsListByBillingAccount.json
     */
    /**
     * Sample code: LotsListByBillingAccount.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void lotsListByBillingAccount(com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager.lotsOperations().listByBillingAccount("1234:5678", null, Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/LotsListByBillingAccount.json
func ExampleLotsClient_NewListByBillingAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewLotsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByBillingAccountPager("1234:5678",
		&armconsumption.LotsClientListByBillingAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Lists all Azure credits and Microsoft Azure consumption commitments for a billing account or a billing profile. Microsoft Azure consumption commitments are only supported for the billing account scope.
 *
 * @summary Lists all Azure credits and Microsoft Azure consumption commitments for a billing account or a billing profile. Microsoft Azure consumption commitments are only supported for the billing account scope.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/LotsListByBillingAccount.json
 */
async function lotsListByBillingAccount() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountId = "1234:5678";
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.lotsOperations.listByBillingAccount(billingAccountId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

lotsListByBillingAccount().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1",
      "name": "lot1",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 5000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 60.9
        },
        "source": "ConsumptionCommitment",
        "startDate": "2019-10-01T00:00:00Z",
        "expirationDate": "2019-11-01T00:00:00Z",
        "purchasedDate": "2019-09-01T00:00:00Z",
        "status": "Active"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot2",
      "name": "lot2",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 6000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 80.9
        },
        "source": "ConsumptionCommitment",
        "startDate": "2019-11-01T00:00:00Z",
        "expirationDate": "2019-12-31T00:00:00Z",
        "purchasedDate": "2019-09-01T00:00:00Z",
        "status": "Expired"
      }
    }
  ]
}

LotsListByBillingAccountWithStatusFilter

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/1234:5678/providers/Microsoft.Consumption/lots?api-version=2021-10-01&$filter=status eq 'active' AND source eq 'consumptioncommitment'

Java

import com.azure.core.util.Context;

/** Samples for LotsOperation ListByBillingAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/LotsListByBillingAccountWithFilters.json
     */
    /**
     * Sample code: LotsListByBillingAccountWithStatusFilter.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void lotsListByBillingAccountWithStatusFilter(
        com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager
            .lotsOperations()
            .listByBillingAccount(
                "1234:5678", "status eq 'active' AND source eq 'consumptioncommitment'", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Lists all Azure credits and Microsoft Azure consumption commitments for a billing account or a billing profile. Microsoft Azure consumption commitments are only supported for the billing account scope.
 *
 * @summary Lists all Azure credits and Microsoft Azure consumption commitments for a billing account or a billing profile. Microsoft Azure consumption commitments are only supported for the billing account scope.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/LotsListByBillingAccountWithFilters.json
 */
async function lotsListByBillingAccountWithStatusFilter() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountId = "1234:5678";
  const filter = "status eq 'active' AND source eq 'consumptioncommitment'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.lotsOperations.listByBillingAccount(billingAccountId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

lotsListByBillingAccountWithStatusFilter().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1",
      "name": "lot1",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 5000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 60.9
        },
        "source": "ConsumptionCommitment",
        "startDate": "2019-10-01T00:00:00Z",
        "expirationDate": "2019-11-01T00:00:00Z",
        "purchasedDate": "2019-09-01T00:00:00Z",
        "status": "Active"
      }
    }
  ]
}

Определения

amount	Сумма плюс валюта.
AmountWithExchangeRate	Сумма с обменным курсом.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.
Lots	Результат перечисления суммы лотов.
LotSource	Источник лота.
LotSummary	Много суммарного ресурса.
Reseller	Свойства торгового посредника.
Status	Состояние лота.

amount

Сумма плюс валюта.

Name	Type	Description
currency	string	Валюта суммы.
value	number	Сумма.

AmountWithExchangeRate

Сумма с обменным курсом.

Name	Type	Description
currency	string	Валюта суммы.
exchangeRate	number	Обменный курс.
exchangeRateMonth	integer	Месяц обмена.
value	number	Сумма.

ErrorDetails

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

Name	Type	Description
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ErrorResponse

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

Некоторые ответы на ошибки:

• 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.

• 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

Name	Type	Description
error	ErrorDetails	Сведения об ошибке.

Lots

Результат перечисления суммы лотов.

Name	Type	Description
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	LotSummary[]	Список суммарных результатов.

LotSource

Источник лота.

Name	Type	Description
ConsumptionCommitment	string
PromotionalCredit	string
PurchasedCredit	string

LotSummary

Много суммарного ресурса.

Name	Type	Description
eTag	string	eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.billingCurrency	string	Валюта выставления счетов лота.
properties.closedBalance	amount	Баланс до выставления последнего счета.
properties.closedBalanceInBillingCurrency	AmountWithExchangeRate	Баланс по состоянию на последний счет в валюте выставления счетов.
properties.creditCurrency	string	Валюта лота.
properties.eTag	string	ETag для ресурса.
properties.expirationDate	string	Дата окончания срока действия большого количества.
properties.originalAmount	amount	Первоначальное количество много.
properties.originalAmountInBillingCurrency	AmountWithExchangeRate	Первоначальное количество много в валюте выставления счетов.
properties.poNumber	string	Номер заказа на счет, по которому был добавлен лот. Это свойство недоступно для множества ConsumptionCommitment.
properties.purchasedDate	string	Дата добавления лота.
properties.reseller	Reseller	Торговый посредник лота.
properties.source	LotSource	Источник лота.
properties.startDate	string	Дата, когда лот стал эффективным.
properties.status	Status	Состояние лота.
type	string	Тип ресурса.

Reseller

Свойства торгового посредника.

Name	Type	Description
resellerDescription	string	Описание свойства торгового посредника.
resellerId	string	Идентификатор свойства торгового посредника.

Status

Состояние лота.

Name	Type	Description
Active	string
Canceled	string
Complete	string
Expired	string
Inactive	string
None	string