Views - Get By Scope

Reference

Služba:: Cost Management

Verze rozhraní API:: 2024-08-01

Získá zobrazení pro definovaný obor podle názvu zobrazení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	Obor přidružený k operacím zobrazení. To zahrnuje předplatná/{subscriptionId} pro rozsah předplatného. Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pro rozsah EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah BillingProfile, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId} pro rozsah InvoiceSection, providers/Microsoft.Management/managementGroups/{managementGroupId} pro rozsah skupiny pro správu, providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} pro rozsah externího fakturačního účtu a provider/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} pro rozsah externího předplatného.
viewName	path	True	string	Název zobrazení
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	View	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ResourceGroupView

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2024-08-01

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG",
    "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"
      }
    ]
  }
}

Definice

Name	Description
AccumulatedType	Zobrazit náklady kumulované v průběhu času
ChartType	Typ grafu hlavního zobrazení v analýze nákladů Požadovaný.
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.
FunctionType	Název agregační funkce, která se má použít.
KpiProperties	Každý klíčový ukazatel výkonu musí obsahovat "typ" a "povolený" klíč.
KpiTypeType	Typ klíčového ukazatele výkonu (Prognóza, Rozpočet).
MetricType	Metrika, která se má použít při zobrazení nákladů.
OperatorType	Operátor, který se má použít pro porovnání.
PivotProperties	Každý pivot musí obsahovat "typ" a "název".
PivotTypeType	Datový typ, který se má zobrazit v zobrazení.
QueryColumnType	Typ sloupce v exportu.
ReportConfigAggregation	Výraz agregace, který se má použít v sestavě.
ReportConfigComparisonExpression	Výraz porovnání, který se má použít v sestavě.
ReportConfigDataset	Definice dat, která jsou v sestavě přítomna.
ReportConfigDatasetConfiguration	Konfigurace datové sady v sestavě
ReportConfigFilter	Výraz filtru, který se má použít v sestavě.
ReportConfigGrouping	Seskupit podle výrazu, který se má použít v sestavě.
ReportConfigSorting	Pořadí podle výrazu, který se má použít v sestavě.
ReportConfigSortingType	Směr řazení.
ReportConfigTimePeriod	Počáteční a koncové datum pro načtení dat pro sestavu.
ReportGranularityType	Členitost řádků v sestavě
ReportTimeframeType	Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.
ReportType	Typ sestavy. Využití představuje skutečné využití, prognóza představuje předpověděná data a UsageAndForecast představuje jak data využití, tak i prognózovaná data. Skutečné využití a předpovídaná data se dají odlišit na základě kalendářních dat.
View	Stavy a konfigurace analýzy nákladů

AccumulatedType

Zobrazit náklady kumulované v průběhu času

Name	Typ	Description
false	string
true	string

ChartType

Typ grafu hlavního zobrazení v analýze nákladů Požadovaný.

Name	Typ	Description
Area	string
GroupedColumn	string
Line	string
StackedColumn	string
Table	string

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

FunctionType

Název agregační funkce, která se má použít.

Name	Typ	Description
Sum	string

KpiProperties

Každý klíčový ukazatel výkonu musí obsahovat "typ" a "povolený" klíč.

Name	Typ	Description
enabled	boolean	zobrazit klíčový ukazatel výkonu v uživatelském rozhraní?
id	string	ID prostředku souvisejícího s metrikou (rozpočet).
type	KpiTypeType	Typ klíčového ukazatele výkonu (Prognóza, Rozpočet).

KpiTypeType

Typ klíčového ukazatele výkonu (Prognóza, Rozpočet).

Name	Typ	Description
Budget	string
Forecast	string

MetricType

Metrika, která se má použít při zobrazení nákladů.

Name	Typ	Description
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

Operátor, který se má použít pro porovnání.

Name	Typ	Description
Contains	string
In	string

PivotProperties

Každý pivot musí obsahovat "typ" a "název".

Name	Typ	Description
name	string	Datové pole, které se má zobrazit v zobrazení
type	PivotTypeType	Datový typ, který se má zobrazit v zobrazení.

PivotTypeType

Datový typ, který se má zobrazit v zobrazení.

Name	Typ	Description
Dimension	string
TagKey	string

QueryColumnType

Typ sloupce v exportu.

Name	Typ	Description
Dimension	string	Dimenze nákladových dat.
TagKey	string	Značka přidružená k datům nákladů.

ReportConfigAggregation

Výraz agregace, který se má použít v sestavě.

Name	Typ	Description
function	FunctionType	Název agregační funkce, která se má použít.
name	string	Název sloupce, který se má agregovat.

ReportConfigComparisonExpression

Výraz porovnání, který se má použít v sestavě.

Name	Typ	Description
name	string	Název sloupce, který se má použít při porovnání.
operator	OperatorType	Operátor, který se má použít pro porovnání.
values	string[]	Pole hodnot, které se mají použít k porovnání

ReportConfigDataset

Definice dat, která jsou v sestavě přítomna.

Name	Typ	Description
aggregation	<string, ReportConfigAggregation>	Slovník agregačního výrazu, který se má použít v sestavě. Klíč každé položky ve slovníku je alias agregovaného sloupce. Sestava může mít až 2 agregační klauzule.
configuration	ReportConfigDatasetConfiguration	Obsahuje informace o konfiguraci dat v sestavě. Konfigurace bude ignorována, pokud jsou k dispozici agregace a seskupení.
filter	ReportConfigFilter	Obsahuje výraz filtru, který se má použít v sestavě.
granularity	ReportGranularityType	Členitost řádků v sestavě
grouping	ReportConfigGrouping[]	Pole seskupování podle výrazu pro použití v sestavě Sestava může mít až 2 klauzule seskupit podle.
sorting	ReportConfigSorting[]	Pole pořadí podle výrazu, které se má použít v sestavě.

ReportConfigDatasetConfiguration

Konfigurace datové sady v sestavě

Name	Typ	Description
columns	string[]	Pole názvů sloupců, které se mají zahrnout do sestavy. Je povolený libovolný platný název sloupce sestavy. Pokud není zadaný, sestava obsahuje všechny sloupce.

ReportConfigFilter

Výraz filtru, který se má použít v sestavě.

Name	Typ	Description
and	ReportConfigFilter[]	Logický výraz AND. Musí obsahovat alespoň 2 položky.
dimensions	ReportConfigComparisonExpression	Obsahuje porovnávací výraz pro dimenzi.
or	ReportConfigFilter[]	Logický výraz OR. Musí obsahovat alespoň 2 položky.
tags	ReportConfigComparisonExpression	Obsahuje výraz porovnání pro značku.

ReportConfigGrouping

Seskupit podle výrazu, který se má použít v sestavě.

Name	Typ	Description
name	string	Název sloupce, který se má seskupit. Tato verze podporuje nejnižší možnou úroveň předplatného.
type	QueryColumnType	Má typ sloupce, který se má seskupit.

ReportConfigSorting

Pořadí podle výrazu, který se má použít v sestavě.

Name	Typ	Description
direction	ReportConfigSortingType	Směr řazení.
name	string	Název sloupce, který chcete seřadit.

ReportConfigSortingType

Směr řazení.

Name	Typ	Description
Ascending	string
Descending	string

ReportConfigTimePeriod

Počáteční a koncové datum pro načtení dat pro sestavu.

Name	Typ	Description
from	string	Počáteční datum pro načtení dat.
to	string	Koncové datum pro načtení dat.

ReportGranularityType

Členitost řádků v sestavě

Name	Typ	Description
Daily	string
Monthly	string

ReportTimeframeType

Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.

Name	Typ	Description
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

Typ sestavy. Využití představuje skutečné využití, prognóza představuje předpověděná data a UsageAndForecast představuje jak data využití, tak i prognózovaná data. Skutečné využití a předpovídaná data se dají odlišit na základě kalendářních dat.

Name	Typ	Description
Usage	string

View

Stavy a konfigurace analýzy nákladů

Name	Typ	Description
eTag	string	eTag prostředku. Pro zpracování scénáře souběžné aktualizace se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi, nebo ne.
id	string	ID prostředku.
name	string	Název prostředku
properties.accumulated	AccumulatedType	Zobrazit náklady kumulované v průběhu času
properties.chart	ChartType	Typ grafu hlavního zobrazení v analýze nákladů Požadovaný.
properties.createdOn	string	Datum, kdy uživatel vytvořil toto zobrazení
properties.currency	string	Měna aktuálního zobrazení
properties.dateRange	string	Rozsah dat aktuálního zobrazení
properties.displayName	string	Uživatelské jméno zobrazení. Požadovaný.
properties.kpis	KpiProperties[]	Seznam klíčových ukazatelů výkonu, které se mají zobrazit v uživatelském rozhraní analýzy nákladů
properties.metric	MetricType	Metrika, která se má použít při zobrazení nákladů.
properties.modifiedOn	string	Datum poslední změny tohoto zobrazení uživatelem
properties.pivots	PivotProperties[]	Konfigurace 3 dílčích zobrazení v uživatelském rozhraní analýzy nákladů
properties.query.dataSet	ReportConfigDataset	Obsahuje definici dat v této konfiguraci sestavy.
properties.query.includeMonetaryCommitment	boolean	Pokud je pravda, sestava obsahuje peněžní závazek.
properties.query.timePeriod	ReportConfigTimePeriod	Má časové období pro načítání dat pro sestavu.
properties.query.timeframe	ReportTimeframeType	Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.
properties.query.type	ReportType	Typ sestavy. Využití představuje skutečné využití, prognóza představuje předpověděná data a UsageAndForecast představuje jak data využití, tak i prognózovaná data. Skutečné využití a předpovídaná data se dají odlišit na základě kalendářních dat.
properties.scope	string	Rozsah služby Cost Management pro uložení zobrazení To zahrnuje předplatná/{subscriptionId} pro rozsah předplatného. Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pro rozsah EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah BillingProfile, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId} pro rozsah InvoiceSection, providers/Microsoft.Management/managementGroups/{managementGroupId} pro rozsah skupiny pro správu, /providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} pro obor ExternalBillingAccount a /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} pro obor ExternalSubscription.
type	string	Typ prostředku.

Sdílet prostřednictvím