Views - Get By Scope

Referentie

Service:: Cost Management

API-versie:: 2024-08-01

Hiermee haalt u de weergave voor het gedefinieerde bereik op op weergavenaam.

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

URI-parameters

Name	In	Vereist	Type	Description
scope	path	True	string	Het bereik dat is gekoppeld aan weergavebewerkingen. Dit omvat abonnementen/{subscriptionId} voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het bereik van de factureringsrekening, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor het bereik EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, providers/Microsoft.Management/managementGroups/{managementGroupId} voor het bereik van beheergroepen, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} voor extern factureringsaccountbereik en providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} voor extern abonnementsbereik.
viewName	path	True	string	Weergavenaam
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	View	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ResourceGroupView

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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"
      }
    ]
  }
}

Definities

Name	Description
AccumulatedType	Kosten weergeven die in de loop van de tijd zijn verzameld.
ChartType	Grafiektype van de hoofdweergave in Kostenanalyse. Vereist.
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
FunctionType	De naam van de te gebruiken aggregatiefunctie.
KpiProperties	Elke KPI moet een sleutel 'type' en 'ingeschakeld' bevatten.
KpiTypeType	KPI-type (prognose, budget).
MetricType	Metrische waarde die moet worden gebruikt bij het weergeven van kosten.
OperatorType	De operator die moet worden gebruikt voor vergelijking.
PivotProperties	Elke draai moet een 'type' en 'naam' bevatten.
PivotTypeType	Gegevenstype dat moet worden weergegeven in de weergave.
QueryColumnType	Het type kolom in de export.
ReportConfigAggregation	De aggregatie-expressie die in het rapport moet worden gebruikt.
ReportConfigComparisonExpression	De vergelijkingsexpressie die in het rapport moet worden gebruikt.
ReportConfigDataset	De definitie van gegevens die aanwezig zijn in het rapport.
ReportConfigDatasetConfiguration	De configuratie van de gegevensset in het rapport.
ReportConfigFilter	De filterexpressie die moet worden gebruikt in het rapport.
ReportConfigGrouping	De groeperen op expressie die in het rapport moet worden gebruikt.
ReportConfigSorting	De volgorde per expressie die moet worden gebruikt in het rapport.
ReportConfigSortingType	Richting van soort.
ReportConfigTimePeriod	De begin- en einddatum voor het ophalen van gegevens voor het rapport.
ReportGranularityType	De granulariteit van rijen in het rapport.
ReportTimeframeType	Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
ReportType	Het type rapport. Het gebruik vertegenwoordigt het werkelijke gebruik, de prognose vertegenwoordigt voorspelde gegevens en UsageAndForecast vertegenwoordigt zowel het gebruik als de voorspelde gegevens. Het werkelijke gebruik en de voorspelde gegevens kunnen worden onderscheiden op basis van datums.
View	Statussen en configuraties van Kostenanalyse.

AccumulatedType

Kosten weergeven die in de loop van de tijd zijn verzameld.

Name	Type	Description
false	string
true	string

ChartType

Grafiektype van de hoofdweergave in Kostenanalyse. Vereist.

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

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

FunctionType

De naam van de te gebruiken aggregatiefunctie.

Name	Type	Description
Sum	string

KpiProperties

Elke KPI moet een sleutel 'type' en 'ingeschakeld' bevatten.

Name	Type	Description
enabled	boolean	de KPI weergeven in de gebruikersinterface?
id	string	Id van resource met betrekking tot metrische gegevens (budget).
type	KpiTypeType	KPI-type (prognose, budget).

KpiTypeType

KPI-type (prognose, budget).

Name	Type	Description
Budget	string
Forecast	string

MetricType

Metrische waarde die moet worden gebruikt bij het weergeven van kosten.

Name	Type	Description
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

De operator die moet worden gebruikt voor vergelijking.

Name	Type	Description
Contains	string
In	string

PivotProperties

Elke draai moet een 'type' en 'naam' bevatten.

Name	Type	Description
name	string	Gegevensveld dat moet worden weergegeven in de weergave.
type	PivotTypeType	Gegevenstype dat moet worden weergegeven in de weergave.

PivotTypeType

Gegevenstype dat moet worden weergegeven in de weergave.

Name	Type	Description
Dimension	string
TagKey	string

QueryColumnType

Het type kolom in de export.

Name	Type	Description
Dimension	string	De dimensie van kostengegevens.
TagKey	string	De tag die is gekoppeld aan de kostengegevens.

ReportConfigAggregation

De aggregatie-expressie die in het rapport moet worden gebruikt.

Name	Type	Description
function	FunctionType	De naam van de te gebruiken aggregatiefunctie.
name	string	De naam van de kolom die moet worden samengevoegd.

ReportConfigComparisonExpression

De vergelijkingsexpressie die in het rapport moet worden gebruikt.

Name	Type	Description
name	string	De naam van de kolom die moet worden gebruikt in vergelijking.
operator	OperatorType	De operator die moet worden gebruikt voor vergelijking.
values	string[]	Matrix met waarden die moeten worden gebruikt voor vergelijking

ReportConfigDataset

De definitie van gegevens die aanwezig zijn in het rapport.

Name	Type	Description
aggregation	<string, ReportConfigAggregation>	Woordenlijst van aggregatie-expressie die in het rapport moet worden gebruikt. De sleutel van elk item in de woordenlijst is de alias voor de samengevoegde kolom. Rapport kan maximaal 2 aggregatiecomponenten bevatten.
configuration	ReportConfigDatasetConfiguration	Bevat configuratie-informatie voor de gegevens in het rapport. De configuratie wordt genegeerd als aggregatie en groepering worden opgegeven.
filter	ReportConfigFilter	Heeft filterexpressie die moet worden gebruikt in het rapport.
granularity	ReportGranularityType	De granulariteit van rijen in het rapport.
grouping	ReportConfigGrouping[]	Matrix van groeperen op expressie die in het rapport moet worden gebruikt. Rapport kan maximaal 2 group by-componenten bevatten.
sorting	ReportConfigSorting[]	Matrix van volgorde per expressie die in het rapport moet worden gebruikt.

ReportConfigDatasetConfiguration

De configuratie van de gegevensset in het rapport.

Name	Type	Description
columns	string[]	Matrix van kolomnamen die moeten worden opgenomen in het rapport. Elke geldige kolomnaam van het rapport is toegestaan. Als dit niet is opgegeven, bevat het rapport alle kolommen.

ReportConfigFilter

De filterexpressie die moet worden gebruikt in het rapport.

Name	Type	Description
and	ReportConfigFilter[]	De logische 'AND'-expressie. Moet ten minste 2 items bevatten.
dimensions	ReportConfigComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
or	ReportConfigFilter[]	De logische 'OR'-expressie. Moet ten minste 2 items bevatten.
tags	ReportConfigComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

ReportConfigGrouping

De groeperen op expressie die in het rapport moet worden gebruikt.

Name	Type	Description
name	string	De naam van de kolom die moet worden gegroepeerd. Deze versie ondersteunt het laagst mogelijke abonnement.
type	QueryColumnType	Heeft het type kolom dat moet worden gegroepeerd.

ReportConfigSorting

De volgorde per expressie die moet worden gebruikt in het rapport.

Name	Type	Description
direction	ReportConfigSortingType	Richting van soort.
name	string	De naam van de kolom die moet worden gesorteerd.

ReportConfigSortingType

Richting van soort.

Name	Type	Description
Ascending	string
Descending	string

ReportConfigTimePeriod

De begin- en einddatum voor het ophalen van gegevens voor het rapport.

Name	Type	Description
from	string	De begindatum waaruit gegevens moeten worden opgehaald.
to	string	De einddatum voor het ophalen van gegevens naar.

ReportGranularityType

De granulariteit van rijen in het rapport.

Name	Type	Description
Daily	string
Monthly	string

ReportTimeframeType

Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.

Name	Type	Description
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

Het type rapport. Het gebruik vertegenwoordigt het werkelijke gebruik, de prognose vertegenwoordigt voorspelde gegevens en UsageAndForecast vertegenwoordigt zowel het gebruik als de voorspelde gegevens. Het werkelijke gebruik en de voorspelde gegevens kunnen worden onderscheiden op basis van datums.

Name	Type	Description
Usage	string

View

Statussen en configuraties van Kostenanalyse.

Name	Type	Description
eTag	string	eTag van de resource. Voor het afhandelen van een gelijktijdig updatescenario wordt dit veld gebruikt om te bepalen of de gebruiker de nieuwste versie bijwerkt of niet.
id	string	Resource-id.
name	string	Resourcenaam.
properties.accumulated	AccumulatedType	Kosten weergeven die in de loop van de tijd zijn verzameld.
properties.chart	ChartType	Grafiektype van de hoofdweergave in Kostenanalyse. Vereist.
properties.createdOn	string	De datum waarop de gebruiker deze weergave heeft gemaakt.
properties.currency	string	Valuta van de huidige weergave.
properties.dateRange	string	Datumbereik van de huidige weergave.
properties.displayName	string	Invoernaam van de gebruiker van de weergave. Vereist.
properties.kpis	KpiProperties[]	Lijst met KPI's die moeten worden weergegeven in de gebruikersinterface van Cost Analysis.
properties.metric	MetricType	Metrische waarde die moet worden gebruikt bij het weergeven van kosten.
properties.modifiedOn	string	Datum waarop de gebruiker deze weergave het laatst heeft gewijzigd.
properties.pivots	PivotProperties[]	Configuratie van drie subweergaven in de gebruikersinterface van Cost Analysis.
properties.query.dataSet	ReportConfigDataset	Bevat definitie voor gegevens in deze rapportconfiguratie.
properties.query.includeMonetaryCommitment	boolean	Indien waar, bevat het rapport financiële toezegging.
properties.query.timePeriod	ReportConfigTimePeriod	Heeft een periode voor het ophalen van gegevens voor het rapport.
properties.query.timeframe	ReportTimeframeType	Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
properties.query.type	ReportType	Het type rapport. Het gebruik vertegenwoordigt het werkelijke gebruik, de prognose vertegenwoordigt voorspelde gegevens en UsageAndForecast vertegenwoordigt zowel het gebruik als de voorspelde gegevens. Het werkelijke gebruik en de voorspelde gegevens kunnen worden onderscheiden op basis van datums.
properties.scope	string	Cost Management-bereik om de weergave op te slaan. Dit omvat abonnementen/{subscriptionId} voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het bereik van de factureringsrekening, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor het bereik EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, providers/Microsoft.Management/managementGroups/{managementGroupId} voor het bereik van beheergroepen, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} voor het bereik ExternalBillingAccount en '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik ExternalSubscription.
type	string	Resourcetype.

Delen via