Views - Get

Ссылка

Служба:: Cost Management

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

Возвращает представление по имени представления.

GET https://management.azure.com/providers/Microsoft.CostManagement/views/{viewName}?api-version=2024-08-01

Параметры URI

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

Ответы

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

PrivateView

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

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2024-08-01

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

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

{
  "id": "/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}

Определения

Имя	Описание
AccumulatedType	Показать затраты, накопленные с течением времени.
ChartType	Тип диаграммы основного представления в анализе затрат. Обязательно.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
FunctionType	Имя используемой функции агрегирования.
KpiProperties	Каждый ключевой показатель эффективности должен содержать ключ "type" и "enabled".
KpiTypeType	Тип ключевого показателя эффективности (прогноз, бюджет).
MetricType	Метрика, используемая при отображении затрат.
OperatorType	Оператор, используемый для сравнения.
PivotProperties	Каждая сводная таблица должна содержать тип и имя.
PivotTypeType	Тип данных для отображения в представлении.
QueryColumnType	Тип столбца в экспорте.
ReportConfigAggregation	Выражение агрегирования, используемое в отчете.
ReportConfigComparisonExpression	Выражение сравнения, используемое в отчете.
ReportConfigDataset	Определение данных, присутствующих в отчете.
ReportConfigDatasetConfiguration	Конфигурация набора данных в отчете.
ReportConfigFilter	Выражение фильтра, используемое в отчете.
ReportConfigGrouping	Группа по выражению, используемая в отчете.
ReportConfigSorting	Порядок по выражению, который будет использоваться в отчете.
ReportConfigSortingType	Направление сортировки.
ReportConfigTimePeriod	Дата начала и окончания извлечения данных для отчета.
ReportGranularityType	Степень детализации строк в отчете.
ReportTimeframeType	Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.
ReportType	Тип отчета. Использование представляет фактическое использование, прогноз представляет прогнозируемые данные и UsageAndForecast представляет как данные об использовании, так и прогнозируемых данных. Фактические данные об использовании и прогнозируемых данных можно различать на основе дат.
View	Состояния и конфигурации анализа затрат.

AccumulatedType

Показать затраты, накопленные с течением времени.

Имя	Тип	Описание
false	string
true	string

ChartType

Тип диаграммы основного представления в анализе затрат. Обязательно.

Имя	Тип	Описание
Area	string
GroupedColumn	string
Line	string
StackedColumn	string
Table	string

ErrorDetails

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

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

ErrorResponse

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

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

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

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

FunctionType

Имя используемой функции агрегирования.

Имя	Тип	Описание
Sum	string

KpiProperties

Каждый ключевой показатель эффективности должен содержать ключ "type" и "enabled".

Имя	Тип	Описание
enabled	boolean	отображение ключевого показателя эффективности в пользовательском интерфейсе?
id	string	Идентификатор ресурса, связанного с метрикой (бюджетом).
type	KpiTypeType	Тип ключевого показателя эффективности (прогноз, бюджет).

KpiTypeType

Тип ключевого показателя эффективности (прогноз, бюджет).

Имя	Тип	Описание
Budget	string
Forecast	string

MetricType

Метрика, используемая при отображении затрат.

Имя	Тип	Описание
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

Оператор, используемый для сравнения.

Имя	Тип	Описание
Contains	string
In	string

PivotProperties

Каждая сводная таблица должна содержать тип и имя.

Имя	Тип	Описание
name	string	Поле данных для отображения в представлении.
type	PivotTypeType	Тип данных для отображения в представлении.

PivotTypeType

Тип данных для отображения в представлении.

Имя	Тип	Описание
Dimension	string
TagKey	string

QueryColumnType

Тип столбца в экспорте.

Имя	Тип	Описание
Dimension	string	Измерение данных о затратах.
TagKey	string	Тег, связанный с данными затрат.

ReportConfigAggregation

Выражение агрегирования, используемое в отчете.

Имя	Тип	Описание
function	FunctionType	Имя используемой функции агрегирования.
name	string	Имя столбца для статистической обработки.

ReportConfigComparisonExpression

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

Имя	Тип	Описание
name	string	Имя столбца, используемого в сравнении.
operator	OperatorType	Оператор, используемый для сравнения.
values	string[]	Массив значений, используемых для сравнения

ReportConfigDataset

Определение данных, присутствующих в отчете.

Имя	Тип	Описание
aggregation	<string, ReportConfigAggregation>	Словарь выражения агрегирования для использования в отчете. Ключ каждого элемента в словаре — это псевдоним для агрегированного столбца. В отчете может быть до 2 предложений агрегирования.
configuration	ReportConfigDatasetConfiguration	Содержит сведения о конфигурации данных в отчете. Конфигурация будет игнорироваться, если предоставляется агрегирование и группирование.
filter	ReportConfigFilter	Имеет выражение фильтра для использования в отчете.
granularity	ReportGranularityType	Степень детализации строк в отчете.
grouping	ReportConfigGrouping[]	Массив групп по выражению для использования в отчете. Отчет может содержать до 2 групп по предложениям.
sorting	ReportConfigSorting[]	Массив порядка по выражению для использования в отчете.

ReportConfigDatasetConfiguration

Конфигурация набора данных в отчете.

Имя	Тип	Описание
columns	string[]	Массив имен столбцов для включения в отчет. Разрешено любое допустимое имя столбца отчета. Если он не указан, отчет содержит все столбцы.

ReportConfigFilter

Выражение фильтра, используемое в отчете.

Имя	Тип	Описание
and	ReportConfigFilter[]	Логическое выражение "AND". Должно быть не менее 2 элементов.
dimensions	ReportConfigComparisonExpression	Имеет выражение сравнения для измерения
or	ReportConfigFilter[]	Логическое выражение OR. Должно быть не менее 2 элементов.
tags	ReportConfigComparisonExpression	Имеет выражение сравнения для тега

ReportConfigGrouping

Группа по выражению, используемая в отчете.

Имя	Тип	Описание
name	string	Имя столбца для группировки. Эта версия поддерживает наименьшее возможное зерно подписки.
type	QueryColumnType	Имеет тип столбца для группировки.

ReportConfigSorting

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

Имя	Тип	Описание
direction	ReportConfigSortingType	Направление сортировки.
name	string	Имя столбца для сортировки.

ReportConfigSortingType

Направление сортировки.

Имя	Тип	Описание
Ascending	string
Descending	string

ReportConfigTimePeriod

Дата начала и окончания извлечения данных для отчета.

Имя	Тип	Описание
from	string	Дата начала извлечения данных.
to	string	Дата окончания извлечения данных.

ReportGranularityType

Степень детализации строк в отчете.

Имя	Тип	Описание
Daily	string
Monthly	string

ReportTimeframeType

Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.

Имя	Тип	Описание
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

Тип отчета. Использование представляет фактическое использование, прогноз представляет прогнозируемые данные и UsageAndForecast представляет как данные об использовании, так и прогнозируемых данных. Фактические данные об использовании и прогнозируемых данных можно различать на основе дат.

Имя	Тип	Описание
Usage	string

View

Состояния и конфигурации анализа затрат.

Имя	Тип	Описание
eTag	string	eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию или нет.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.accumulated	AccumulatedType	Показать затраты, накопленные с течением времени.
properties.chart	ChartType	Тип диаграммы основного представления в анализе затрат. Обязательно.
properties.createdOn	string	Дата создания этого представления пользователем.
properties.currency	string	Валюта текущего представления.
properties.dateRange	string	Диапазон дат текущего представления.
properties.displayName	string	Имя входных данных пользователя представления. Обязательно.
properties.kpis	KpiProperties[]	Список ключевых показателей эффективности для отображения в пользовательском интерфейсе анализа затрат.
properties.metric	MetricType	Метрика, используемая при отображении затрат.
properties.modifiedOn	string	Дата последнего изменения этого представления пользователем.
properties.pivots	PivotProperties[]	Настройка 3 вложенных представлений в пользовательском интерфейсе анализа затрат.
properties.query.dataSet	ReportConfigDataset	Содержит определение данных в этой конфигурации отчета.
properties.query.includeMonetaryCommitment	boolean	Если верно, отчет включает денежные обязательства.
properties.query.timePeriod	ReportConfigTimePeriod	Имеет период времени для извлечения данных для отчета.
properties.query.timeframe	ReportTimeframeType	Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.
properties.query.type	ReportType	Тип отчета. Использование представляет фактическое использование, прогноз представляет прогнозируемые данные и UsageAndForecast представляет как данные об использовании, так и прогнозируемых данных. Фактические данные об использовании и прогнозируемых данных можно различать на основе дат.
properties.scope	string	Область управления затратами для сохранения представления. Это включает в себя "подписки/{subscriptionId}" для области подписки. "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области учетной записи выставления счетов, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}" для области отдела", "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' для области EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для области BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" для области InvoiceSection, "providers/Microsoft.Management/managementGroups/{managementGroupId}" для области группы управления, "/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}" для области ExternalBillingAccount и "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" для области ExternalSubscription.
type	string	Тип ресурса.

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