Partager via

Views - Get By Scope

  • Référence
Service:
Cost Management
Version d'API:
2024-08-01

Obtient l’affichage de l’étendue définie par nom d’affichage.

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

Paramètres URI

Nom Dans Obligatoire Type Description
scope
 path True

string

Étendue associée aux opérations d’affichage. Cela inclut « subscriptions/{subscriptionId} » pour l’étendue de l’abonnement, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour l’étendue resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' pour l’étendue du compte de facturation, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId} for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pour l’étendue EnrollmentAccount, « providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} » pour l’étendue BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' pour l’étendue du groupe d’administration, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} pour l’étendue du compte de facturation externe et « providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} » pour l’étendue d’abonnement externe.
viewName
 path True

string

Nom de l’affichage
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

View

D’ACCORD. La demande a réussi.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ResourceGroupView

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
      }
    ]
  }
}

Définitions

Nom Description
AccumulatedType

Afficher les coûts accumulés au fil du temps.
ChartType

Type de graphique de l’affichage principal dans Analyse des coûts. Obligatoire.
ErrorDetails

Détails de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».
FunctionType

Nom de la fonction d’agrégation à utiliser.
KpiProperties

Chaque indicateur de performance clé doit contenir une clé « type » et « enabled ».
KpiTypeType

Type d’indicateur de performance clé (Prévision, Budget).
MetricType

Métrique à utiliser lors de l’affichage des coûts.
OperatorType

Opérateur à utiliser pour la comparaison.
PivotProperties

Chaque tableau croisé dynamique doit contenir un « type » et un « nom ».
PivotTypeType

Type de données à afficher en mode.
QueryColumnType

Type de la colonne dans l’exportation.
ReportConfigAggregation

Expression d’agrégation à utiliser dans le rapport.
ReportConfigComparisonExpression

Expression de comparaison à utiliser dans le rapport.
ReportConfigDataset

Définition des données présentes dans le rapport.
ReportConfigDatasetConfiguration

Configuration du jeu de données dans le rapport.
ReportConfigFilter

Expression de filtre à utiliser dans le rapport.
ReportConfigGrouping

Groupe par expression à utiliser dans le rapport.
ReportConfigSorting

Ordre par expression à utiliser dans le rapport.
ReportConfigSortingType

Direction de tri.
ReportConfigTimePeriod

Date de début et de fin de l’extraction des données pour le rapport.
ReportGranularityType

Granularité des lignes dans le rapport.
ReportTimeframeType

Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.
ReportType

Type du rapport. L’utilisation représente l’utilisation réelle, la prévision représente les données prévues et UsageAndForecast représente à la fois l’utilisation et les données prévues. L’utilisation réelle et les données prévues peuvent être différenciées en fonction des dates.
View

États et configurations de l’analyse des coûts.

AccumulatedType

Afficher les coûts accumulés au fil du temps.

Nom Type Description
false

string

true

string

ChartType

Type de graphique de l’affichage principal dans Analyse des coûts. Obligatoire.

Nom Type Description
Area

string

GroupedColumn

string

Line

string

StackedColumn

string

Table

string

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.
message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».

Nom Type Description
error

ErrorDetails

Détails de l’erreur.

FunctionType

Nom de la fonction d’agrégation à utiliser.

Nom Type Description
Sum

string

KpiProperties

Chaque indicateur de performance clé doit contenir une clé « type » et « enabled ».

Nom Type Description
enabled

boolean

afficher l’indicateur de performance clé dans l’interface utilisateur ?
id

string

ID de ressource liée à la métrique (budget).
type

KpiTypeType

Type d’indicateur de performance clé (Prévision, Budget).

KpiTypeType

Type d’indicateur de performance clé (Prévision, Budget).

Nom Type Description
Budget

string

Forecast

string

MetricType

Métrique à utiliser lors de l’affichage des coûts.

Nom Type Description
AHUB

string

ActualCost

string

AmortizedCost

string

OperatorType

Opérateur à utiliser pour la comparaison.

Nom Type Description
Contains

string

In

string

PivotProperties

Chaque tableau croisé dynamique doit contenir un « type » et un « nom ».

Nom Type Description
name

string

Champ de données à afficher en mode.
type

PivotTypeType

Type de données à afficher en mode.

PivotTypeType

Type de données à afficher en mode.

Nom Type Description
Dimension

string

TagKey

string

QueryColumnType

Type de la colonne dans l’exportation.

Nom Type Description
Dimension

string

Dimension des données de coût.
TagKey

string

Balise associée aux données de coût.

ReportConfigAggregation

Expression d’agrégation à utiliser dans le rapport.

Nom Type Description
function

FunctionType

Nom de la fonction d’agrégation à utiliser.
name

string

Nom de la colonne à agréger.

ReportConfigComparisonExpression

Expression de comparaison à utiliser dans le rapport.

Nom Type Description
name

string

Nom de la colonne à utiliser en comparaison.
operator

OperatorType

Opérateur à utiliser pour la comparaison.
values

string[]

Tableau de valeurs à utiliser pour la comparaison

ReportConfigDataset

Définition des données présentes dans le rapport.

Nom Type Description
aggregation

<string,  ReportConfigAggregation>

Dictionnaire d’expression d’agrégation à utiliser dans le rapport. La clé de chaque élément du dictionnaire est l’alias de la colonne agrégée. Le rapport peut avoir jusqu’à 2 clauses d’agrégation.
configuration

ReportConfigDatasetConfiguration

Contient des informations de configuration pour les données du rapport. La configuration est ignorée si l’agrégation et le regroupement sont fournis.
filter

ReportConfigFilter

A l’expression de filtre à utiliser dans le rapport.
granularity

ReportGranularityType

Granularité des lignes dans le rapport.
grouping

ReportConfigGrouping[]

Tableau de groupes par expression à utiliser dans le rapport. Le rapport peut comporter jusqu’à 2 clauses group by.
sorting

ReportConfigSorting[]

Tableau d’ordre par expression à utiliser dans le rapport.

ReportConfigDatasetConfiguration

Configuration du jeu de données dans le rapport.

Nom Type Description
columns

string[]

Tableau de noms de colonnes à inclure dans le rapport. Tout nom de colonne de rapport valide est autorisé. S’il n’est pas fourni, le rapport inclut toutes les colonnes.

ReportConfigFilter

Expression de filtre à utiliser dans le rapport.

Nom Type Description
and

ReportConfigFilter[]

Expression logique « AND ». Doit avoir au moins 2 éléments.
dimensions

ReportConfigComparisonExpression

A une expression de comparaison pour une dimension
or

ReportConfigFilter[]

Expression logique « OR ». Doit avoir au moins 2 éléments.
tags

ReportConfigComparisonExpression

A une expression de comparaison pour une balise

ReportConfigGrouping

Groupe par expression à utiliser dans le rapport.

Nom Type Description
name

string

Nom de la colonne à regrouper. Cette version prend en charge l’abonnement le plus bas possible.
type

QueryColumnType

A le type de la colonne à regrouper.

ReportConfigSorting

Ordre par expression à utiliser dans le rapport.

Nom Type Description
direction

ReportConfigSortingType

Direction de tri.
name

string

Nom de la colonne à trier.

ReportConfigSortingType

Direction de tri.

Nom Type Description
Ascending

string

Descending

string

ReportConfigTimePeriod

Date de début et de fin de l’extraction des données pour le rapport.

Nom Type Description
from

string

Date de début à partir de laquelle extraire des données.
to

string

Date de fin vers laquelle extraire des données.

ReportGranularityType

Granularité des lignes dans le rapport.

Nom Type Description
Daily

string

Monthly

string

ReportTimeframeType

Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.

Nom Type Description
Custom

string

MonthToDate

string

WeekToDate

string

YearToDate

string

ReportType

Type du rapport. L’utilisation représente l’utilisation réelle, la prévision représente les données prévues et UsageAndForecast représente à la fois l’utilisation et les données prévues. L’utilisation réelle et les données prévues peuvent être différenciées en fonction des dates.

Nom Type Description
Usage

string

View

États et configurations de l’analyse des coûts.

Nom Type Description
eTag

string

eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non.
id

string

ID de ressource.
name

string

Nom de la ressource.
properties.accumulated

AccumulatedType

Afficher les coûts accumulés au fil du temps.
properties.chart

ChartType

Type de graphique de l’affichage principal dans Analyse des coûts. Obligatoire.
properties.createdOn

string

Date de création de cette vue par l’utilisateur.
properties.currency

string

Devise de l’affichage actuel.
properties.dateRange

string

Plage de dates de l’affichage actuel.
properties.displayName

string

Nom d’entrée utilisateur de la vue. Obligatoire.
properties.kpis

KpiProperties[]

Liste des indicateurs de performance clés à afficher dans l’interface utilisateur Analyse des coûts.
properties.metric

MetricType

Métrique à utiliser lors de l’affichage des coûts.
properties.modifiedOn

string

Date à laquelle l’utilisateur a modifié cette vue pour la dernière fois.
properties.pivots

PivotProperties[]

Configuration de 3 sous-vues dans l’interface utilisateur Analyse des coûts.
properties.query.dataSet

ReportConfigDataset

A la définition des données dans cette configuration de rapport.
properties.query.includeMonetaryCommitment

boolean

Si la valeur est vraie, le rapport inclut l’engagement financier.
properties.query.timePeriod

ReportConfigTimePeriod

A la période d’extraction des données pour le rapport.
properties.query.timeframe

ReportTimeframeType

Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.
properties.query.type

ReportType

Type du rapport. L’utilisation représente l’utilisation réelle, la prévision représente les données prévues et UsageAndForecast représente à la fois l’utilisation et les données prévues. L’utilisation réelle et les données prévues peuvent être différenciées en fonction des dates.
properties.scope

string

Étendue Cost Management pour enregistrer l’affichage. Cela inclut « subscriptions/{subscriptionId} » pour l’étendue de l’abonnement, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour l’étendue resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' pour l’étendue du compte de facturation, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId} for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pour l’étendue EnrollmentAccount, « providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} » pour l’étendue BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' pour l’étendue du groupe d’administration, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName} pour l’étendue ExternalBillingAccount et « /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} » pour l’étendue ExternalSubscription.
type

string

Type de ressource.