@azure/arm-carbonoptimization package

Classes

CarbonOptimizationManagementClient

Interfaces

CarbonEmissionData

La réponse de base pour différents rapports de requête, tous les résultats du rapport de requête auront ces informations

CarbonEmissionDataAvailableDateRange

Réponse pour la plage de dates disponible des données d’émission de carbone

CarbonEmissionDataListResult

Liste des résultats des émissions de carbone

CarbonEmissionItemDetailData

Réponse aux émissions de carbone détaillées

CarbonEmissionMonthlySummaryData

Réponse pour le résumé des émissions de carbone mensuelles

CarbonEmissionOverallSummaryData

Réponse au résumé global des émissions de carbone

CarbonEmissionTopItemMonthlySummaryData

Réponse pour les principaux éléments émissions de carbone par mois

CarbonEmissionTopItemsSummaryData

Réponse pour les éléments principaux par type de catégorie

CarbonOptimizationManagementClientOptionalParams

Paramètres facultatifs pour le client.

CarbonServiceOperations

Interface représentant une opération CarbonService.

CarbonServiceQueryCarbonEmissionDataAvailableDateRangeOptionalParams

Paramètres facultatifs.

CarbonServiceQueryCarbonEmissionReportsOptionalParams

Paramètres facultatifs.

DateRange

Plage de dates à utiliser avec QueryParameter, elle doit se trouver dans les 12 mois entre la date de début et la date de fin. Dans certains cas, les dates de début et de fin doivent être identiques.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué.

ItemDetailsQueryFilter

Paramètres de requête pour ItemDetailsReport

MonthlySummaryReportQueryFilter

Paramètre de filtre de requête pour configurer des requêtes MonthlySummaryReport.

Operation

Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources

OperationDisplay

Informations d’affichage localisées pour et opération.

OperationsListOptionalParams

Paramètres facultatifs.

OperationsOperations

Interface représentant des opérations.

OverallSummaryReportQueryFilter

Paramètre de filtre de requête pour configurer les requêtes OverallSummaryReport.

PageSettings

Options de la méthode byPage

PagedAsyncIterableIterator

Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.

QueryFilter

Paramètre de filtre de requête partagée pour configurer les requêtes de données sur les émissions de carbone pour tous les différents types de rapport définis dans ReportTypeEnum.

ResourceCarbonEmissionItemDetailData

Réponse aux émissions de carbone détaillées sur les ressources

ResourceCarbonEmissionTopItemMonthlySummaryData

Réponse pour les principaux éléments émissions de carbone par mois pour les ressources

ResourceCarbonEmissionTopItemsSummaryData

Réponse pour les éléments principaux pour la catégorie de ressource

ResourceGroupCarbonEmissionItemDetailData

Réponse pour les émissions de carbone détaillées du groupe de ressources

ResourceGroupCarbonEmissionTopItemMonthlySummaryData

Réponse pour les principaux éléments émissions de carbone par mois pour le groupe de ressources

ResourceGroupCarbonEmissionTopItemsSummaryData

Réponse pour les éléments principaux pour ResourceGroup

SubscriptionAccessDecision

Décision d’accès pour chaque abonnement

TopItemsMonthlySummaryReportQueryFilter

Paramètre de filtre de requête pour configurer les requêtes TopItemsMonthlySummaryReport.

TopItemsSummaryReportQueryFilter

Paramètre de filtre de requête pour configurer les requêtes TopItemsSummaryReport.

Alias de type

AccessDecisionEnum

Énumération pour la décision d’accès
KnownAccessDecisionEnum peut être utilisé de manière interchangeable avec AccessDecisionEnum, cette énumération contient les valeurs connues prises en charge par le service.

Valeurs connues prises en charge par le service

Autorisé : Accès autorisé
Refusé : Accès refusé

ActionType

Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.
KnownActionType peut être utilisé de manière interchangeable avec ActionType, cette énumération contient les valeurs connues prises en charge par le service.

Valeurs connues prises en charge par le service

Interne : les actions concernent les API internes uniquement.

CarbonEmissionDataUnion

Alias de CarbonEmissionDataUnion

CategoryTypeEnum

Types de catégorie pris en charge à utiliser avec QueryParameter. Chaque type représente un niveau différent d’agrégation des données d’émission.
KnownCategoryTypeEnum peut être utilisé de manière interchangeable avec CategoryTypeEnum, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Abonnement : émissions agrégées au niveau de l’abonnement.
ResourceGroup : émissions agrégées au niveau du groupe de ressources.
Emplacement : Émissions agrégées au niveau de l’emplacement.
Ressource : Émissions agrégées au niveau de la ressource.
ResourceType : émissions agrégées au niveau du type de ressource.

ContinuablePage

Interface qui décrit une page de résultats.

EmissionScopeEnum

Étendues d’émission de carbone prises en charge à utiliser avec QueryParameter, comme défini par le protocole GES. Au moins une étendue doit être spécifiée. La sortie retourne un total de toutes les étendues spécifiées.
KnownEmissionScopeEnum peut être utilisé de manière interchangeable avec EmissionScopeEnum, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Scope1 : Émissions de carbone Scope1
Scope 2 : Émissions de carbone Scope2
Scope3 : Émissions de carbone Scope3

OrderByColumnEnum

Le tri est pris en charge pour les colonnes dans ItemDetailsReport. Cet objet inclut les noms de colonnes pour utilisant le tri. Sélectionnez l’une des valeurs prises en charge suivantes
KnownOrderByColumnEnum peut être utilisé de manière interchangeable avec OrderByColumnEnum, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

ItemName : Le résultat itemName déposé dans ItemDetailsReport, voir CarbonEmissionItemDetailData pour plus d’informations.
LatestMonthEmissions : le résultat latestMonthEmissions déposé dans ItemDetailsReport, voir CarbonEmissionItemDetailData pour plus d’informations.
PreviousMonthEmissions : Le résultat de previousMonthEmissions déposé dans ItemDetailsReport, voir CarbonEmissionItemDetailData pour plus d’informations.
MonthOverMonthEmissionsChangeRatio : Le résultat monthOverMonthEmissionsChangeRatio déposé dans ItemDetailsReport, voir CarbonEmissionItemDetailData pour plus d’informations.
MonthlyEmissionsChangeValue : Le résultat de monthlyEmissionsChangeValue déposé dans ItemDetailsReport, voir CarbonEmissionItemDetailData pour plus d’informations.
ResourceGroup : le résultat resourceGroup déposé dans ResourceCarbonEmissionItemDetailData, voir ResourceCarbonEmissionItemDetailData pour plus d’informations.

Origin

Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »
KnownOrigin peut être utilisé de manière interchangeable avec Origin, cette énumération contient les valeurs connues prises en charge par le service.

Valeurs connues prises en charge par le service

user : indique que l’opération est initiée par un utilisateur.
system : Indique que l’opération est initiée par un système.
user,system : indique que l’opération est initiée par un utilisateur ou un système.

QueryFilterUnion

Alias de QueryFilterUnion

ReportTypeEnum

Énumération pour le type de rapport, en spécifiant différents formats de rapport pour les données d’émissions de carbone. Chaque type de rapport retourne différentes agrégations d’émissions de carbone dans différentes catégories, plage de dates, étendue des émissions et autres paramètres.
KnownReportTypeEnum peut être utilisé de manière interchangeable avec ReportTypeEnum, cette énumération contient les valeurs connues prises en charge par le service.

Valeurs connues prises en charge par le service

OverallSummaryReport : le rapport récapitulatif global fournit les émissions totales de carbone pour la plage de dates spécifiée et les paramètres de requête, ainsi que des valeurs comparatives pour une vue d’ensemble de haut niveau. Ce type de rapport peut accepter différentes valeurs dans les champs de début et de fin dans DateRange (par exemple, start : 2024-03-01 et end : 2024-06-01).
MonthlySummaryReport : MonthlySummaryReport fournit des données sur les émissions de carbone par mois pour les paramètres de requête spécifiés. Ce type de rapport peut accepter différentes valeurs dans les champs de début et de fin dans DateRange (par exemple, start : 2024-03-01 et end : 2024-06-01).
TopItemsSummaryReport : TopItemsSummaryReport fournit les N éléments les plus émetteurs pour les filtres de requête spécifiés. Ce rapport retourne des données d’un seul mois à la fois, ce qui nécessite les mêmes valeurs pour les champs de début et de fin dans DateRange. Un maximum de N=10 éléments peut être retourné à la fois.
TopItemsMonthlySummaryReport : TopItemsMonthlyReport fournit les N éléments les plus émetteurs par mois pour le filtre de requête spécifié. Retourne les données d’émission pour les principaux éléments N par mois dans la plage de dates donnée. Un maximum de N=10 éléments peut être retourné à la fois.
ItemDetailsReport : ItemDetailsReport fournit une liste granulaire d’éléments en fonction du type de catégorie spécifié (par exemple, Resource, ResourceGroup, ResourceType, Location ou Subscription) pour le filtre de requête. Ce rapport peut être interrogé pendant un seul mois à la fois, nécessitant les mêmes valeurs dans les champs de début et de fin dans DateRange.

ResponseDataTypeEnum

Le type de données de réponse Données d’émission de carbone
KnownResponseDataTypeEnum peut être utilisé de manière interchangeable avec ResponseDataTypeEnum, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

OverallSummaryData : type de données de réponse pour OverallSummaryReport
MonthlySummaryData : type de données de réponse pour MonthlySummaryReport
TopItemsSummaryData : type de données de réponse pour TopItemsSummaryReport
ResourceTopItemsSummaryData : type de données de réponse pour le TopItemsSummaryReport de la ressource
ResourceGroupTopItemsSummaryData : type de données de réponse pour le TopItemsSummaryReport de ResourceGroup
TopItemsMonthlySummaryData : type de données de réponse pour TopItemsMonthlySummaryReport
ResourceTopItemsMonthlySummaryData : type de données de réponse pour le TopItemsMonthlySummaryReport de la ressource
ResourceGroupTopItemsMonthlySummaryData : type de données de réponse pour le rapport TopItemsMonthlySummaryReport de ResourceGroup
ItemDetailsData : type de données de réponse pour ItemDetailsReport
ResourceItemDetailsData : type de données de réponse pour le rapport ItemDetailsReport de la ressource
ResourceGroupItemDetailsData : type de données de réponse pour le rapport ItemDetailsReport de ResourceGroup

SortDirectionEnum

Le tri est pris en charge pour les colonnes dans ItemDetailsReport. Cet objet définit le sens du tri.
KnownSortDirectionEnum peut être utilisé de manière interchangeable avec SortDirectionEnum, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Desc : ordre décroissant du résultat de la requête.
Asc : ordre croissant du résultat de la requête.

Énumérations

KnownAccessDecisionEnum

Énumération pour décision d’accès

KnownActionType

Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.

KnownCategoryTypeEnum

Types de catégorie pris en charge à utiliser avec QueryParameter. Chaque type représente un niveau différent d’agrégation des données d’émission.

KnownEmissionScopeEnum

Étendues d’émission de carbone prises en charge à utiliser avec QueryParameter, comme défini par le protocole GES. Au moins une étendue doit être spécifiée. La sortie retourne un total de toutes les étendues spécifiées.

KnownOrderByColumnEnum

Le tri est pris en charge pour les colonnes dans ItemDetailsReport. Cet objet inclut les noms de colonnes pour utilisant le tri. Sélectionnez l’une de ces valeurs prises en charge

KnownOrigin

Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »

KnownReportTypeEnum

Énumération pour le type de rapport, en spécifiant différents formats de rapport pour les données d’émissions de carbone. Chaque type de rapport retourne différentes agrégations d’émissions de carbone dans différentes catégories, plage de dates, étendue des émissions et autres paramètres.

KnownResponseDataTypeEnum

Type de données de réponse des données d’émission de carbone

KnownSortDirectionEnum

Le tri est pris en charge pour les colonnes dans ItemDetailsReport. Cet objet définit le sens du tri.

KnownVersions

Versions d’API disponibles.