Lots - List By Customer

  • Ссылка
Service:
Consumption
API Version:
2021-10-01

Перечисляет все кредиты Azure для клиента. API поддерживается только для учетных записей выставления счетов с партнерскими соглашениями Майкрософт (MPA).

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

Параметры URI

Name In Required Type Description
billingAccountId
 path True
  • string

Идентификатор BillingAccount
customerId
 path True
  • string

ИД клиента
api-version
 query True
  • string

Версия API, используемая с клиентским запросом. Текущая версия — 2021-10-01.
$filter
 query
  • string

Может использоваться для фильтрации количества по состоянию, источнику и т. д. Фильтр поддерживает "eq", "lt", "gt", "le", "ge" и "and". Фильтр тегов — это строка пары "значение ключа", где ключ и значение разделяются двоеточием (:).

Ответы

Name Type Description
200 OK

Все в порядке. Запрос выполнен успешно.
Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

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

Примеры

LotsListByCustomer
LotsListByCustomerWithFilter

LotsListByCustomer

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot1",
      "name": "lot1",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 5000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 60.9
        },
        "source": "PurchasedCredit",
        "startDate": "2021-05-01T00:00:00Z",
        "expirationDate": "2021-05-01T00:00:00Z",
        "poNumber": "3524"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot2",
      "name": "lot2",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 6000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 80.9
        },
        "source": "PurchasedCredit",
        "startDate": "2021-05-01T00:00:00Z",
        "expirationDate": "2019-12-31T00:00:00Z",
        "poNumber": "31224"
      }
    }
  ]
}

LotsListByCustomerWithFilter

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot1",
      "name": "lot1",
      "type": "Microsoft.Consumption/lots",
      "properties": {
        "originalAmount": {
          "currency": "USD",
          "value": 5000
        },
        "closedBalance": {
          "currency": "USD",
          "value": 60.9
        },
        "source": "PurchasedCredit",
        "startDate": "2021-05-01T00:00:00Z",
        "expirationDate": "2021-05-01T00:00:00Z",
        "poNumber": "3524"
      }
    }
  ]
}

Определения

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

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

Lots

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

Name Type Description
nextLink
  • string

Ссылка (URL-адрес) на следующую страницу результатов.
value

Список суммарных сумм.

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

Баланс до выставления последнего счета.
properties.closedBalanceInBillingCurrency

Баланс по состоянию на последний счет в валюте выставления счетов.
properties.creditCurrency
  • string

Валюта лота.
properties.eTag
  • string

ETag для ресурса.
properties.expirationDate
  • string

Дата окончания срока действия большого количества.
properties.originalAmount

Исходное количество много.
properties.originalAmountInBillingCurrency

Первоначальное количество много в валюте выставления счетов.
properties.poNumber
  • string

Номер заказа, по которому был добавлен лот. Это свойство недоступно для объекта ConsumptionCommitment.
properties.purchasedDate
  • string

Дата добавления лота.
properties.reseller

Торговый посредник лота.
properties.source

Источник лота.
properties.startDate
  • string

Дата, когда лот стал эффективным.
properties.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