Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Ссылка

Служба:: Cost Management

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

Активирует создание отчета об использовании преимуществ для предоставленного плана экономии.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
savingsPlanId	path	True	string	Идентификатор плана экономии.
savingsPlanOrderId	path	True	string	Идентификатор заказа на экономию.
api-version	query	True	string	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
endDate	True	string	Дата окончания данных сводки, которые будут обслуживаться в отчете.
grain	True	grain	В отчете подается сводка данных. Допустимые значения: Daily или Monthly.
startDate	True	string	Дата начала сводки данных, которые будут обслуживаться в отчете.
benefitId		string	Идентификатор преимущества: отчет об использовании пособий предназначен для отчета. Требуется для области идентификатора преимущества. Не поддерживается для заказа на преимущества или каких-либо областей выставления счетов.
benefitOrderId		string	Идентификатор заказа на преимущества, для отчета об использовании преимуществ указан отчет об использовании. Требуется для порядка преимуществ и областей идентификаторов преимуществ. Не поддерживается для каких-либо областей выставления счетов.
billingAccountId		string	Для учетной записи выставления счетов указан отчет об использовании преимуществ. Требуется для учетных записей выставления счетов и областей профиля выставления счетов. Не поддерживается для каких-либо областей преимуществ.
billingProfileId		string	Идентификатор профиля выставления счетов— отчет об использовании преимуществ. Требуется для области профиля выставления счетов. Не поддерживается для учетной записи выставления счетов или каких-либо областей преимуществ.
kind		benefitKind	Тип запрошенных данных о преимуществах. Требуется для учетных записей выставления счетов и областей профиля выставления счетов. Подразумеваемые и не передаваемые в области преимуществ. Поддерживаемые значения : Резервирование и Сберегательный план

Ответы

Имя	Тип	Описание
200 OK	BenefitUtilizationSummariesOperationStatus	Состояние создания отчета об использовании преимуществ. Это может быть выполнено, завершилось сбоем или завершено.
202 Accepted		Принятый. Запрос будет обработан. Используйте заголовок расположения для проверки состояния. Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

BenefitUtilizationSummariesOperationStatus

Состояние создания отчета об использовании преимуществ. Это может быть выполнено, завершилось сбоем или завершено.

202 Accepted

Принятый. Запрос будет обработан. Используйте заголовок расположения для проверки состояния.

Заголовки

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

GenerateUtilizationSummariesReportBySavingsPlan

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

HTTP

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

{
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

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

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

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60

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

{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Определения

Имя	Описание
AsyncOperationStatusProperties	Объект, представляющий URL-адрес отчета и допустимый до даты создания асинхронного отчета.
benefitKind	Резервирование или сберегательный план.
BenefitUtilizationSummariesOperationStatus	Состояние отчета об использовании преимуществ. Предоставляет url-адрес SAS запроса запроса, состояния и URL-адреса sas для использования преимуществ Async.
BenefitUtilizationSummariesRequest	Свойства запроса на использование асинхронных преимуществ.
BenefitUtilizationSummaryReportSchema	CSV-файл из ссылки blob-объекта reportUrl и secondaryReportUrl будет состоять из следующих столбцов данных об использовании преимуществ. ИспользуетсяPercentage будет 0 для отчетов о экономии планов и резервирований, не относящихся к данным. Процент использования будет составлять 0 для резервирований кирпичей данных.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
grain	Зерно использования. Поддерживаемые значения: "Почасово"
OperationStatusType	Состояние создания отчета об использовании преимуществ.

AsyncOperationStatusProperties

Объект, представляющий URL-адрес отчета и допустимый до даты создания асинхронного отчета.

Имя	Тип	Описание
reportUrl	BenefitUtilizationSummaryReportSchema	URL-адрес SAS в отчете об использовании асинхронных преимуществ. Будет пустым, если отчет находится в состоянии "Выполнение" или "Сбой".
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	URL-адрес sas для асинхронного использования сводные данные об использовании преимуществ в дополнительном хранилище в случае основного сбоя. Будет пустым, если отчет находится в состоянии "Выполнение" или "Сбой".
validUntil	string	Дата истечения срока действия URL-адреса sas, указанного в отчетеUrl.

benefitKind

Резервирование или сберегательный план.

Имя	Тип	Описание
IncludedQuantity	string	Преимущество включается в составQuantity.
Reservation	string	Преимущество — резервирование.
SavingsPlan	string	Преимуществом является SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Состояние отчета об использовании преимуществ. Предоставляет url-адрес SAS запроса запроса, состояния и URL-адреса sas для использования преимуществ Async.

Имя	Тип	Описание
input	BenefitUtilizationSummariesRequest	Входные данные, предоставленные для создания отчета об использовании преимуществ.
properties	AsyncOperationStatusProperties	Содержит URL-адрес sas в отчете об использовании асинхронных преимуществ и дате, до которую url-адрес действителен. Эти значения будут пустыми, если отчет находится в состоянии "Выполнение" или "Сбой"
status	OperationStatusType	Состояние создания отчета об использовании преимуществ.

BenefitUtilizationSummariesRequest

Свойства запроса на использование асинхронных преимуществ.

Имя	Тип	Описание
benefitId	string	Идентификатор преимущества: отчет об использовании пособий предназначен для отчета. Требуется для области идентификатора преимущества. Не поддерживается для заказа на преимущества или каких-либо областей выставления счетов.
benefitOrderId	string	Идентификатор заказа на преимущества, для отчета об использовании преимуществ указан отчет об использовании. Требуется для порядка преимуществ и областей идентификаторов преимуществ. Не поддерживается для каких-либо областей выставления счетов.
billingAccountId	string	Для учетной записи выставления счетов указан отчет об использовании преимуществ. Требуется для учетных записей выставления счетов и областей профиля выставления счетов. Не поддерживается для каких-либо областей преимуществ.
billingProfileId	string	Идентификатор профиля выставления счетов— отчет об использовании преимуществ. Требуется для области профиля выставления счетов. Не поддерживается для учетной записи выставления счетов или каких-либо областей преимуществ.
endDate	string	Дата окончания данных сводки, которые будут обслуживаться в отчете.
grain	grain	В отчете подается сводка данных. Допустимые значения: Daily или Monthly.
kind	benefitKind	Тип запрошенных данных о преимуществах. Требуется для учетных записей выставления счетов и областей профиля выставления счетов. Подразумеваемые и не передаваемые в области преимуществ. Поддерживаемые значения : Резервирование и Сберегательный план
startDate	string	Дата начала сводки данных, которые будут обслуживаться в отчете.

BenefitUtilizationSummaryReportSchema

CSV-файл из ссылки blob-объекта reportUrl и secondaryReportUrl будет состоять из следующих столбцов данных об использовании преимуществ. ИспользуетсяPercentage будет 0 для отчетов о экономии планов и резервирований, не относящихся к данным. Процент использования будет составлять 0 для резервирований кирпичей данных.

Имя	Тип	Описание
AvgUtilizationPercentage	string
BenefitId	string
BenefitOrderId	string
BenefitType	string
Kind	string
MaxUtilizationPercentage	string
MinUtilizationPercentage	string
UsageDate	string
UtilizedPercentage	string

ErrorDetails

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

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

ErrorResponse

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

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

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

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

grain

Зерно использования. Поддерживаемые значения: "Почасово"

Имя	Тип	Описание
Daily	string	Почасовое зерно соответствует значению в день.
Hourly	string	Почасовое зерно соответствует значению в час.
Monthly	string	Почасовое зерно соответствует значению в месяц.

OperationStatusType

Состояние создания отчета об использовании преимуществ.

Имя	Тип	Описание
Complete	string
Failed	string
Running	string

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

Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

GenerateUtilizationSummariesReportBySavingsPlan

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

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

Определения

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

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