Price Sheet - Get By Billing Period

Ссылка

Служба:: Consumption

Версия API:: 2024-08-01

Получите ценовую таблицу для области по идентификатору подписки и периоду выставления счетов. Ценовая таблица доступна только через этот API только 1 мая 2014 г. или более поздней версии.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}&api-version=2024-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingPeriodName	path	True	string	Имя периода выставления счетов.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2023-03-01.
$expand	query		string	Может использоваться для расширения свойств/meterDetails в ценовой таблице. По умолчанию эти поля не включаются при возврате ценового листа.
$skiptoken	query		string	Skiptoken используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр skiptoken, указывающий начальную точку для последующих вызовов.
$top	query		integer (int32) minimum: 1 maximum: 1000	Можно использовать для ограничения количества результатов до первых N результатов.

Ответы

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

PriceSheetExpand

PriceSheetForBillingPeriod

PriceSheetExpand

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?$expand=meterDetails&api-version=2024-08-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1",
        "meterDetails": {
          "meterName": "Data Transfer Out (GB)",
          "meterCategory": "Networking",
          "unit": "GB",
          "meterLocation": "Zone 2",
          "totalIncludedQuantity": 0,
          "pretaxStandardRate": 0.138
        }
      }
    ]
  }
}

PriceSheetForBillingPeriod

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1"
      }
    ]
  }
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After. Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.
MeterDetails	Свойства сведений о счетчике.
PriceSheetProperties	Свойства ценовой таблицы.
PriceSheetResult	Ресурс ценовой таблицы.
SavingsPlan	Свойства сберегательного плана.

ErrorDetails

Object

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

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

ErrorResponse

Object

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

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

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.

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

MeterDetails

Object

Свойства сведений о счетчике.

Имя	Тип	Описание
meterCategory	string	Категория измерения, например "Облачные службы", "Сети" и т. д.
meterLocation	string	Расположение, в котором доступна служба Azure.
meterName	string	Имя счетчика в пределах заданной категории измерения
meterSubCategory	string	Подкатегорию счетчика, например "Облачные службы A6", "ExpressRoute (IXP)" и т. д.
pretaxStandardRate	number (decimal)	Цена предварительного описания.
serviceName	string	Имя службы.
serviceTier	string	Уровень служб.
totalIncludedQuantity	number (decimal)	Общее количество, связанное с предложением.
unit	string	Единица, в которой взимается плата за использование счетчика, например "Часы", "ГБ" и т. д.

PriceSheetProperties

Object

Свойства ценовой таблицы.

Имя	Тип	Описание
billingPeriodId	string	Идентификатор ресурса периода выставления счетов, к которому принадлежит использование.
currencyCode	string	Код Валюты
includedQuantity	number (decimal)	Включенное качество предложения
meterDetails	MeterDetails	Сведения о счетчике. По умолчанию это не заполняется, если он не указан в $expand.
meterId	string (uuid)	Идентификатор измерения (GUID)
offerId	string	Идентификатор предложения
partNumber	string	Номер части
savingsPlan	SavingsPlan	Сведения о сберегательном плане
unitOfMeasure	string	Единица измерения
unitPrice	number (decimal)	Цена за единицу

PriceSheetResult

Object

Ресурс ценовой таблицы.

Имя	Тип	Описание
etag	string	Etag для ресурса.
id	string	Полный идентификатор ARM события.
name	string	Идентификатор, который однозначно идентифицирует событие.
properties.download	MeterDetails	Сведения о скачивании прайс-листа.
properties.nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
properties.pricesheets	PriceSheetProperties[]	прейскурант;
tags	object	Теги ресурсов.
type	string	Тип ресурса.

SavingsPlan

Object

Свойства сберегательного плана.

Имя	Тип	Описание
effectivePrice	number (decimal)	Экономия эффективная цена
marketPrice	number (decimal)	Цена на рынок Сберегательного плана
term	string	Термин "Сберегательная план"

Поделиться через

Price Sheet - Get By Billing Period

Параметры URI

Ответы

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

azure_auth

Области

Примеры

PriceSheetExpand

Образец запроса

Пример ответа

PriceSheetForBillingPeriod

Образец запроса

Пример ответа

Определения

ErrorDetails

ErrorResponse

MeterDetails

PriceSheetProperties

PriceSheetResult

SavingsPlan