Freigeben über


@azure/arm-carbonoptimization package

Klassen

CarbonOptimizationManagementClient

Schnittstellen

CarbonEmissionData

Die grundlegende Antwort für verschiedene Abfrageberichte, alle Abfrageberichtsergebnisse enthalten diese Informationen

CarbonEmissionDataAvailableDateRange

Antwort auf verfügbare Datumsbereich von Co2-Emissionsdaten

CarbonEmissionDataListResult

Liste der Co2-Emissionsergebnisse

CarbonEmissionItemDetailData

Reaktion auf detaillierte Co2-Emissionen

CarbonEmissionMonthlySummaryData

Antwort auf die monatliche Co2-Emissionszusammenfassung

CarbonEmissionOverallSummaryData

Reaktion auf die Gesamtzusammenfassung der Co2-Emissionen

CarbonEmissionTopItemMonthlySummaryData

Antwort auf die wichtigsten Elemente Co2-Emissionen nach Monat

CarbonEmissionTopItemsSummaryData

Antwort für die wichtigsten Elemente nach Kategorietyp

CarbonOptimizationManagementClientOptionalParams

Optionale Parameter für den Client.

CarbonServiceOperations

Schnittstelle, die einen CarbonService-Betrieb darstellt.

CarbonServiceQueryCarbonEmissionDataAvailableDateRangeOptionalParams

Optionale Parameter.

CarbonServiceQueryCarbonEmissionReportsOptionalParams

Optionale Parameter.

DateRange

Datumsbereich, der mit QueryParameter verwendet werden soll, sollte innerhalb von 12 Monaten zwischen Start- und Enddatum liegen. In bestimmten Fällen müssen Anfangs- und Enddaten dasselbe Datum sein.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

ItemDetailsQueryFilter

Abfrageparameter für ItemDetailsReport

MonthlySummaryReportQueryFilter

Abfragefilterparameter zum Konfigurieren von MonthlySummaryReport-Abfragen.

Operation

Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird

OperationDisplay

Lokalisierte Anzeigeinformationen für und Den Betrieb.

OperationsListOptionalParams

Optionale Parameter.

OperationsOperations

Schnittstelle, die vorgänge darstellt.

OverallSummaryReportQueryFilter

Abfragefilterparameter zum Konfigurieren von OverallSummaryReport-Abfragen.

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

QueryFilter

Parameter für freigegebene Abfragefilter zum Konfigurieren von Co2-Emissionsdatenabfragen für alle verschiedenen Berichtstypen, die in ReportTypeEnum definiert sind.

ResourceCarbonEmissionItemDetailData

Reaktion auf detaillierte Co2-Emissionen der Ressource

ResourceCarbonEmissionTopItemMonthlySummaryData

Antwort auf die wichtigsten Elemente co2-Emissionen nach Monat für Ressource

ResourceCarbonEmissionTopItemsSummaryData

Antwort für die wichtigsten Elemente für Ressourcenkategorie

ResourceGroupCarbonEmissionItemDetailData

Reaktion auf die Ressourcengruppe detaillierte Co2-Emissionen

ResourceGroupCarbonEmissionTopItemMonthlySummaryData

Antwort auf die wichtigsten Elemente co2-Emissionen nach Monat für Ressourcengruppe

ResourceGroupCarbonEmissionTopItemsSummaryData

Antwort für die wichtigsten Elemente für ResourceGroup

SubscriptionAccessDecision

Zugriffsentscheidung für jedes Abonnement

TopItemsMonthlySummaryReportQueryFilter

Abfragefilterparameter zum Konfigurieren von TopItemsMonthlySummaryReport-Abfragen.

TopItemsSummaryReportQueryFilter

Abfragefilterparameter zum Konfigurieren von TopItemsSummaryReport-Abfragen.

Typaliase

AccessDecisionEnum

Enumeration für Zugriffsentscheidung
KnownAccessDecisionEnum kann austauschbar mit AccessDecisionEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erlaubt: Zugriff erlaubt
Verweigert: Zugriff verweigert

ActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownActionType kann austauschbar mit ActionType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Intern: Aktionen gelten nur für interne APIs.

CarbonEmissionDataUnion

Alias für CarbonEmissionDataUnion

CategoryTypeEnum

Unterstützte Kategorietypen, die mit QueryParameter verwendet werden sollen. Jeder Typ stellt eine andere Ebene der Emissionsdatenaggregation dar.
KnownCategoryTypeEnum kann austauschbar mit CategoryTypeEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Abonnement: Emissionen, die auf Abonnementebene aggregiert werden.
ResourceGroup: Emissionen, die auf Ressourcengruppenebene aggregiert werden.
Standort: Emissionen, die auf Standortebene aggregiert werden.
Ressource: Emissionen, die auf Ressourcenebene aggregiert werden.
ResourceType: Emissionen, die auf Ressourcentypebene aggregiert werden.

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

EmissionScopeEnum

Unterstützte Co2-Emissionsbereiche, die mit QueryParameter verwendet werden sollen, wie vom GHG-Protokoll definiert. Mindestens ein Bereich muss angegeben werden. Die Ausgabe gibt eine Summe aller angegebenen Bereiche zurück.
KnownEmissionScopeEnum kann austauschbar mit EmissionScopeEnum verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Scope1: Scope1-Kohlenstoffemissionen
Scope2: Scope2-Kohlenstoffemissionen
Scope3: Scope3-Kohlenstoffemissionen

OrderByColumnEnum

Die Sortierung wird für Spalten in ItemDetailsReport unterstützt. Dieses Objekt enthält die Spaltennamen, für die die Sortierung zulässig ist. Wählen Sie einen der folgenden unterstützten Werte aus
KnownOrderByColumnEnum kann austauschbar mit OrderByColumnEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

ItemName: Der im ItemDetailsReport-Ergebnis abgelegte ItemName, weitere Informationen finden Sie unter CarbonEmissionItemDetailData.
LatestMonthEmissions: Der in ItemDetailsBerichtsergebnis abgelegte latestMonthEmissions finden Sie unter CarbonEmissionItemDetailData.
PreviousMonthEmissions: Die in ItemDetailsReport abgelegten previousMonthEmissionsReport Ergebnis, siehe CarbonEmissionItemDetailData für weitere Informationen.
MonthOverMonthEmissionsChangeRatio: Das MonthOverMonthEmissionsChangeRatio, das in ItemDetailsBerichtsergebnis abgelegt ist, weitere Informationen finden Sie unter CarbonEmissionItemDetailData.
MonthlyEmissionsChangeValue: Der monatliche EmissionsChangeValue, der im Ergebnis des ItemDetailsReport abgelegt wird, weitere Informationen finden Sie unter CarbonEmissionItemDetailData.
ResourceGroup: Das Ergebnis der in ResourceCarbonEmissionItemDetailData abgelegten resourceGroup, weitere Informationen finden Sie unter ResourceCarbonEmissionItemDetailData.

Origin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownOrigin kann austauschbar mit Origin verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

user: Gibt an, dass der Vorgang von einem Benutzer initiiert wird.
system: Gibt an, dass der Vorgang von einem System initiiert wird.
user,system: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wurde.

QueryFilterUnion

Alias für QueryFilterUnion

ReportTypeEnum

Enumeration für Berichtstyp, der unterschiedliche Berichtsformate für CO2-Emissionsdaten angibt. Jeder Berichtstyp gibt unterschiedliche Aggregationen von Co2-Emissionen in verschiedenen Kategorien, Datumsbereichen, Emissionsumfang und anderen Parametern zurück.
KnownReportTypeEnum kann austauschbar mit ReportTypeEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

OverallSummaryReport: Der zusammenfassende Gesamtbericht enthält die Gesamtkohlenstoffemissionen für den angegebenen Zeitraum und die Abfrageparameter sowie Vergleichswerte für einen allgemeinen Überblick. Dieser Berichtstyp kann unterschiedliche Werte in den Anfangs- und Endfeldern innerhalb von DateRange akzeptieren (z. B. Anfang: 2024-03-01 und Ende: 2024-06-01).
MonthlySummaryReport: MonthlySummaryReport stellt Kohlenstoffemissionsdaten nach Monat für die angegebenen Abfrageparameter bereit. Dieser Berichtstyp kann unterschiedliche Werte in den Anfangs- und Endfeldern innerhalb von DateRange akzeptieren (z. B. Anfang: 2024-03-01 und Ende: 2024-06-01).
TopItemsSummaryReport: TopItemsSummaryReport stellt die N Elemente mit der höchsten Ausgabe für die angegebenen Abfragefilter bereit. Dieser Bericht gibt Daten für einen einzelnen Monat gleichzeitig zurück, daher sind dieselben Werte für die Anfangs- und Endfelder innerhalb von DateRange erforderlich. Maximal N=10 Elemente können gleichzeitig zurückgegeben werden.
TopItemsMonthlySummaryReport: TopItemsMonthlyReport stellt die N Elemente mit der höchsten Ausgabe pro Monat für den angegebenen Abfragefilter bereit. Gibt Emissionsdaten für die obersten N-Elemente nach Monat innerhalb des angegebenen Datumsbereichs zurück. Maximal N=10 Elemente können gleichzeitig zurückgegeben werden.
ItemDetailsReport: ItemDetailsReport stellt eine detaillierte Liste von Elementen bereit, die auf dem angegebenen CategoryType (z. B. Resource, ResourceGroup, ResourceType, Location oder Subscription) für den Abfragefilter basieren. Dieser Bericht kann jeweils nur für einen Monat abgefragt werden, wobei die gleichen Werte in den Anfangs- und Endfeldern innerhalb von DateRange erforderlich sind.

ResponseDataTypeEnum

Der Antwortdatentyp von CO2-Emissionsdaten
KnownResponseDataTypeEnum kann austauschbar mit ResponseDataTypeEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

OverallSummaryData: Der Antwortdatentyp für OverallSummaryReport
MonthlySummaryData: Der Antwortdatentyp für MonthlySummaryReport
TopItemsSummaryData: Der Antwortdatentyp für TopItemsSummaryReport
ResourceTopItemsSummaryData: Der Antwortdatentyp für den TopItemsSummaryReport der Ressource
ResourceGroupTopItemsSummaryData: Der Antwortdatentyp für den TopItemsSummaryReport von ResourceGroup
TopItemsMonthlySummaryData: Der Antwortdatentyp für TopItemsMonthlySummaryReport
ResourceTopItemsMonthlySummaryData: Der Antwortdatentyp für den TopItemsMonthlySummaryReport der Ressource
ResourceGroupTopItemsMonthlySummaryData: Der Antwortdatentyp für den TopItemsMonthlySummaryReport von ResourceGroup
ItemDetailsData: Der Antwortdatentyp für ItemDetailsReport
ResourceItemDetailsData: Der Antwortdatentyp für den ItemDetailsReport der Ressource
ResourceGroupItemDetailsData: Der Antwortdatentyp für den ItemDetailsReport von ResourceGroup

SortDirectionEnum

Die Sortierung wird für Spalten in ItemDetailsReport unterstützt. Dieses Objekt definiert die Sortierrichtung.
KnownSortDirectionEnum kann austauschbar mit SortDirectionEnum verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Beschreibung: Absteigende Reihenfolge für das Abfrageergebnis.
Asc: Aufsteigende Reihenfolge für das Abfrageergebnis.

Enumerationen

KnownAccessDecisionEnum

Aufzählung der Zugriffsentscheidung

KnownActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.

KnownCategoryTypeEnum

Unterstützte Kategorietypen, die mit QueryParameter verwendet werden sollen. Jeder Typ stellt eine andere Ebene der Emissionsdatenaggregation dar.

KnownEmissionScopeEnum

Unterstützte Co2-Emissionsbereiche, die mit QueryParameter verwendet werden sollen, wie vom GHG-Protokoll definiert. Mindestens ein Bereich muss angegeben werden. Die Ausgabe gibt eine Summe aller angegebenen Bereiche zurück.

KnownOrderByColumnEnum

Die Sortierung wird für Spalten in ItemDetailsReport unterstützt. Dieses Objekt enthält die Spaltennamen, für die die Sortierung zulässig ist. Wählen Sie einen dieser unterstützten Werte aus.

KnownOrigin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"

KnownReportTypeEnum

Enumeration für Berichtstyp, der unterschiedliche Berichtsformate für CO2-Emissionsdaten angibt. Jeder Berichtstyp gibt unterschiedliche Aggregationen von Co2-Emissionen in verschiedenen Kategorien, Datumsbereichen, Emissionsumfang und anderen Parametern zurück.

KnownResponseDataTypeEnum

Der Antwortdatentyp der Co2-Emissionsdaten

KnownSortDirectionEnum

Die Sortierung wird für Spalten in ItemDetailsReport unterstützt. Dieses Objekt definiert die Sortierrichtung.

KnownVersions

Die verfügbaren API-Versionen.