Views - Get By Scope

Referens

Tjänst:: Cost Management

API-version:: 2024-08-01

Hämtar vyn för det definierade omfånget efter visningsnamn.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	Omfånget som är associerat med visningsåtgärder. Detta inkluderar "subscriptions/{subscriptionId} " för prenumerationsomfånget, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfånget Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} för BillingProfile-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för InvoiceSection-omfång, "providers/Microsoft.Management/managementGroups/{managementGroupId}" för hanteringsgruppsomfång, "providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} för omfånget externt faktureringskonto och "providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" för omfånget extern prenumeration.
viewName	path	True	string	Visningsnamn
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	View	OKEJ. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ResourceGroupView

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
AccumulatedType	Visa kostnader som ackumulerats över tid.
ChartType	Diagramtyp för huvudvyn i Kostnadsanalys. Krävs.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
FunctionType	Namnet på den sammansättningsfunktion som ska användas.
KpiProperties	Varje KPI måste innehålla en "typ" och "aktiverad" nyckel.
KpiTypeType	KPI-typ (prognos, budget).
MetricType	Mått som ska användas vid visning av kostnader.
OperatorType	Operatorn som ska användas för jämförelse.
PivotProperties	Varje pivot måste innehålla en "typ" och "namn".
PivotTypeType	Datatyp som ska visas i vyn.
QueryColumnType	Typen av kolumn i exporten.
ReportConfigAggregation	Det sammansättningsuttryck som ska användas i rapporten.
ReportConfigComparisonExpression	Jämförelseuttrycket som ska användas i rapporten.
ReportConfigDataset	Definitionen av data som finns i rapporten.
ReportConfigDatasetConfiguration	Konfigurationen av datamängden i rapporten.
ReportConfigFilter	Filteruttrycket som ska användas i rapporten.
ReportConfigGrouping	Gruppen efter uttryck som ska användas i rapporten.
ReportConfigSorting	Ordningen efter uttryck som ska användas i rapporten.
ReportConfigSortingType	Sorteringsriktning.
ReportConfigTimePeriod	Start- och slutdatumet för att hämta data för rapporten.
ReportGranularityType	Kornigheten för rader i rapporten.
ReportTimeframeType	Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.
ReportType	Rapportens typ. Användning representerar faktisk användning, prognos representerar prognostiserade data och UsageAndForecast representerar både användning och prognostiserade data. Faktisk användning och prognostiserade data kan särskiljas baserat på datum.
View	Tillstånd och konfigurationer av kostnadsanalys.

AccumulatedType

Visa kostnader som ackumulerats över tid.

Name	Typ	Description
false	string
true	string

ChartType

Diagramtyp för huvudvyn i Kostnadsanalys. Krävs.

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

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

Name	Typ	Description
error	ErrorDetails	Information om felet.

FunctionType

Namnet på den sammansättningsfunktion som ska användas.

Name	Typ	Description
Sum	string

KpiProperties

Varje KPI måste innehålla en "typ" och "aktiverad" nyckel.

Name	Typ	Description
enabled	boolean	visa KPI:n i användargränssnittet?
id	string	ID för resurs som är relaterad till mått (budget).
type	KpiTypeType	KPI-typ (prognos, budget).

KpiTypeType

KPI-typ (prognos, budget).

Name	Typ	Description
Budget	string
Forecast	string

MetricType

Mått som ska användas vid visning av kostnader.

Name	Typ	Description
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

Operatorn som ska användas för jämförelse.

Name	Typ	Description
Contains	string
In	string

PivotProperties

Varje pivot måste innehålla en "typ" och "namn".

Name	Typ	Description
name	string	Datafält som ska visas i vyn.
type	PivotTypeType	Datatyp som ska visas i vyn.

PivotTypeType

Datatyp som ska visas i vyn.

Name	Typ	Description
Dimension	string
TagKey	string

QueryColumnType

Typen av kolumn i exporten.

Name	Typ	Description
Dimension	string	Dimensionen av kostnadsdata.
TagKey	string	Taggen som är associerad med kostnadsdata.

ReportConfigAggregation

Det sammansättningsuttryck som ska användas i rapporten.

Name	Typ	Description
function	FunctionType	Namnet på den sammansättningsfunktion som ska användas.
name	string	Namnet på kolumnen som ska aggregeras.

ReportConfigComparisonExpression

Jämförelseuttrycket som ska användas i rapporten.

Name	Typ	Description
name	string	Namnet på kolumnen som ska användas i jämförelse.
operator	OperatorType	Operatorn som ska användas för jämförelse.
values	string[]	Matris med värden som ska användas för jämförelse

ReportConfigDataset

Definitionen av data som finns i rapporten.

Name	Typ	Description
aggregation	<string, ReportConfigAggregation>	Ordlista med sammansättningsuttryck som ska användas i rapporten. Nyckeln för varje objekt i ordlistan är aliaset för den aggregerade kolumnen. Rapporten kan ha upp till 2 aggregeringssatser.
configuration	ReportConfigDatasetConfiguration	Har konfigurationsinformation för data i rapporten. Konfigurationen ignoreras om sammansättning och gruppering tillhandahålls.
filter	ReportConfigFilter	Har filteruttryck att använda i rapporten.
granularity	ReportGranularityType	Kornigheten för rader i rapporten.
grouping	ReportConfigGrouping[]	Matris med grupper efter uttryck som ska användas i rapporten. Rapporten kan ha upp till 2 gruppera efter-satser.
sorting	ReportConfigSorting[]	Matris med ordning efter uttryck som ska användas i rapporten.

ReportConfigDatasetConfiguration

Konfigurationen av datamängden i rapporten.

Name	Typ	Description
columns	string[]	Matris med kolumnnamn som ska ingå i rapporten. Alla giltiga rapportkolumnnamn tillåts. Om det inte anges innehåller rapporten alla kolumner.

ReportConfigFilter

Filteruttrycket som ska användas i rapporten.

Name	Typ	Description
and	ReportConfigFilter[]	Det logiska "AND"-uttrycket. Måste ha minst 2 objekt.
dimensions	ReportConfigComparisonExpression	Har jämförelseuttryck för en dimension
or	ReportConfigFilter[]	Det logiska "OR"-uttrycket. Måste ha minst 2 objekt.
tags	ReportConfigComparisonExpression	Har jämförelseuttryck för en tagg

ReportConfigGrouping

Gruppen efter uttryck som ska användas i rapporten.

Name	Typ	Description
name	string	Namnet på kolumnen som ska grupperas. Den här versionen stöder prenumerationens lägsta möjliga kornighet.
type	QueryColumnType	Har typen av kolumn som ska grupperas.

ReportConfigSorting

Ordningen efter uttryck som ska användas i rapporten.

Name	Typ	Description
direction	ReportConfigSortingType	Sorteringsriktning.
name	string	Namnet på den kolumn som ska sorteras.

ReportConfigSortingType

Sorteringsriktning.

Name	Typ	Description
Ascending	string
Descending	string

ReportConfigTimePeriod

Start- och slutdatumet för att hämta data för rapporten.

Name	Typ	Description
from	string	Startdatumet för att hämta data från.
to	string	Slutdatumet för att hämta data till.

ReportGranularityType

Kornigheten för rader i rapporten.

Name	Typ	Description
Daily	string
Monthly	string

ReportTimeframeType

Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.

Name	Typ	Description
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

Rapportens typ. Användning representerar faktisk användning, prognos representerar prognostiserade data och UsageAndForecast representerar både användning och prognostiserade data. Faktisk användning och prognostiserade data kan särskiljas baserat på datum.

Name	Typ	Description
Usage	string

View

Tillstånd och konfigurationer av kostnadsanalys.

Name	Typ	Description
eTag	string	eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte.
id	string	Resurs-ID.
name	string	Resursnamn.
properties.accumulated	AccumulatedType	Visa kostnader som ackumulerats över tid.
properties.chart	ChartType	Diagramtyp för huvudvyn i Kostnadsanalys. Krävs.
properties.createdOn	string	Datum då användaren skapade den här vyn.
properties.currency	string	Valuta för den aktuella vyn.
properties.dateRange	string	Datumintervall för den aktuella vyn.
properties.displayName	string	Användarens indatanamn för vyn. Krävs.
properties.kpis	KpiProperties[]	Lista över KPI:er som ska visas i användargränssnittet för kostnadsanalys.
properties.metric	MetricType	Mått som ska användas vid visning av kostnader.
properties.modifiedOn	string	Datum då användaren senast ändrade den här vyn.
properties.pivots	PivotProperties[]	Konfiguration av tre undervyer i användargränssnittet för kostnadsanalys.
properties.query.dataSet	ReportConfigDataset	Har definition för data i den här rapportkonfigurationen.
properties.query.includeMonetaryCommitment	boolean	Om det är sant innehåller rapporten ett ekonomiskt åtagande.
properties.query.timePeriod	ReportConfigTimePeriod	Har en tidsperiod för att hämta data för rapporten.
properties.query.timeframe	ReportTimeframeType	Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.
properties.query.type	ReportType	Rapportens typ. Användning representerar faktisk användning, prognos representerar prognostiserade data och UsageAndForecast representerar både användning och prognostiserade data. Faktisk användning och prognostiserade data kan särskiljas baserat på datum.
properties.scope	string	Cost Management-omfång för att spara vyn på. Detta inkluderar "subscriptions/{subscriptionId} " för prenumerationsomfånget, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfånget Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} för BillingProfile-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för InvoiceSection-omfång, "providers/Microsoft.Management/managementGroups/{managementGroupId}" för hanteringsgruppsomfång, "/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} för ExternalBillingAccount-omfånget och "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" för ExternalSubscription-omfånget.
type	string	Resurstyp.

Dela via