@azure/arm-carbonoptimization 1.0.0-beta.1 → 1.0.0

package/review/arm-carbonoptimization.api.md

@@ -1,391 +0,0 @@
-## API Report File for "@azure/arm-carbonoptimization"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { ClientOptions } from '@azure-rest/core-client';
-import { OperationOptions } from '@azure-rest/core-client';
-import { Pipeline } from '@azure/core-rest-pipeline';
-import { TokenCredential } from '@azure/core-auth';
-
-// @public
-export type AccessDecisionEnum = string;
-
-// @public
-export type ActionType = string;
-
-// @public
-export interface CarbonEmissionData {
-    dataType: ResponseDataTypeEnum;
-    latestMonthEmissions: number;
-    monthlyEmissionsChangeValue?: number;
-    monthOverMonthEmissionsChangeRatio?: number;
-    previousMonthEmissions: number;
-}
-
-// @public
-export interface CarbonEmissionDataAvailableDateRange {
-    endDate: string;
-    startDate: string;
-}
-
-// @public
-export interface CarbonEmissionDataListResult {
-    skipToken?: string;
-    subscriptionAccessDecisionList?: SubscriptionAccessDecision[];
-    value: CarbonEmissionDataUnion[];
-}
-
-// @public
-export type CarbonEmissionDataUnion = CarbonEmissionOverallSummaryData | CarbonEmissionMonthlySummaryData | CarbonEmissionTopItemsSummaryData | ResourceCarbonEmissionTopItemsSummaryData | ResourceGroupCarbonEmissionTopItemsSummaryData | CarbonEmissionTopItemMonthlySummaryData | ResourceCarbonEmissionTopItemMonthlySummaryData | ResourceGroupCarbonEmissionTopItemMonthlySummaryData | CarbonEmissionItemDetailData | ResourceCarbonEmissionItemDetailData | ResourceGroupCarbonEmissionItemDetailData | CarbonEmissionData;
-
-// @public
-export interface CarbonEmissionItemDetailData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ItemDetailsData";
-    itemName: string;
-}
-
-// @public
-export interface CarbonEmissionMonthlySummaryData extends CarbonEmissionData {
-    carbonIntensity: number;
-    dataType: "MonthlySummaryData";
-    date: string;
-}
-
-// @public
-export interface CarbonEmissionOverallSummaryData extends CarbonEmissionData {
-    dataType: "OverallSummaryData";
-}
-
-// @public
-export interface CarbonEmissionTopItemMonthlySummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "TopItemsMonthlySummaryData";
-    date: string;
-    itemName: string;
-}
-
-// @public
-export interface CarbonEmissionTopItemsSummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "TopItemsSummaryData";
-    itemName: string;
-}
-
-// @public (undocumented)
-export class CarbonOptimizationManagementClient {
-    constructor(credential: TokenCredential, options?: CarbonOptimizationManagementClientOptionalParams);
-    readonly carbonService: CarbonServiceOperations;
-    readonly operations: OperationsOperations;
-    readonly pipeline: Pipeline;
-}
-
-// @public
-export interface CarbonOptimizationManagementClientOptionalParams extends ClientOptions {
-    apiVersion?: string;
-}
-
-// @public
-export interface CarbonServiceOperations {
-    queryCarbonEmissionDataAvailableDateRange: (options?: CarbonServiceQueryCarbonEmissionDataAvailableDateRangeOptionalParams) => Promise<CarbonEmissionDataAvailableDateRange>;
-    queryCarbonEmissionReports: (queryParameters: QueryFilterUnion, options?: CarbonServiceQueryCarbonEmissionReportsOptionalParams) => Promise<CarbonEmissionDataListResult>;
-}
-
-// @public
-export interface CarbonServiceQueryCarbonEmissionDataAvailableDateRangeOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface CarbonServiceQueryCarbonEmissionReportsOptionalParams extends OperationOptions {
-}
-
-// @public
-export type CategoryTypeEnum = string;
-
-// @public
-export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
-    continuationToken?: string;
-};
-
-// @public
-export interface DateRange {
-    end: string;
-    start: string;
-}
-
-// @public
-export type EmissionScopeEnum = string;
-
-// @public
-export interface ErrorAdditionalInfo {
-    readonly info?: Record<string, any>;
-    readonly type?: string;
-}
-
-// @public
-export interface ErrorDetail {
-    readonly additionalInfo?: ErrorAdditionalInfo[];
-    readonly code?: string;
-    readonly details?: ErrorDetail[];
-    readonly message?: string;
-    readonly target?: string;
-}
-
-// @public
-export interface ErrorResponse {
-    error?: ErrorDetail;
-}
-
-// @public
-export interface ItemDetailsQueryFilter extends QueryFilter {
-    categoryType: CategoryTypeEnum;
-    orderBy: OrderByColumnEnum;
-    pageSize: number;
-    reportType: "ItemDetailsReport";
-    skipToken?: string;
-    sortDirection: SortDirectionEnum;
-}
-
-// @public
-export enum KnownAccessDecisionEnum {
-    Allowed = "Allowed",
-    Denied = "Denied"
-}
-
-// @public
-export enum KnownActionType {
-    Internal = "Internal"
-}
-
-// @public
-export enum KnownCategoryTypeEnum {
-    Location = "Location",
-    Resource = "Resource",
-    ResourceGroup = "ResourceGroup",
-    ResourceType = "ResourceType",
-    Subscription = "Subscription"
-}
-
-// @public
-export enum KnownEmissionScopeEnum {
-    Scope1 = "Scope1",
-    Scope2 = "Scope2",
-    Scope3 = "Scope3"
-}
-
-// @public
-export enum KnownOrderByColumnEnum {
-    ItemName = "ItemName",
-    LatestMonthEmissions = "LatestMonthEmissions",
-    MonthlyEmissionsChangeValue = "MonthlyEmissionsChangeValue",
-    MonthOverMonthEmissionsChangeRatio = "MonthOverMonthEmissionsChangeRatio",
-    PreviousMonthEmissions = "PreviousMonthEmissions",
-    ResourceGroup = "ResourceGroup"
-}
-
-// @public
-export enum KnownOrigin {
-    System = "system",
-    User = "user",
-    UserSystem = "user,system"
-}
-
-// @public
-export enum KnownReportTypeEnum {
-    ItemDetailsReport = "ItemDetailsReport",
-    MonthlySummaryReport = "MonthlySummaryReport",
-    OverallSummaryReport = "OverallSummaryReport",
-    TopItemsMonthlySummaryReport = "TopItemsMonthlySummaryReport",
-    TopItemsSummaryReport = "TopItemsSummaryReport"
-}
-
-// @public
-export enum KnownResponseDataTypeEnum {
-    ItemDetailsData = "ItemDetailsData",
-    MonthlySummaryData = "MonthlySummaryData",
-    OverallSummaryData = "OverallSummaryData",
-    ResourceGroupItemDetailsData = "ResourceGroupItemDetailsData",
-    ResourceGroupTopItemsMonthlySummaryData = "ResourceGroupTopItemsMonthlySummaryData",
-    ResourceGroupTopItemsSummaryData = "ResourceGroupTopItemsSummaryData",
-    ResourceItemDetailsData = "ResourceItemDetailsData",
-    ResourceTopItemsMonthlySummaryData = "ResourceTopItemsMonthlySummaryData",
-    ResourceTopItemsSummaryData = "ResourceTopItemsSummaryData",
-    TopItemsMonthlySummaryData = "TopItemsMonthlySummaryData",
-    TopItemsSummaryData = "TopItemsSummaryData"
-}
-
-// @public
-export enum KnownSortDirectionEnum {
-    Asc = "Asc",
-    Desc = "Desc"
-}
-
-// @public
-export enum KnownVersions {
-    V20250401 = "2025-04-01"
-}
-
-// @public
-export interface MonthlySummaryReportQueryFilter extends QueryFilter {
-    reportType: "MonthlySummaryReport";
-}
-
-// @public
-export interface Operation {
-    readonly actionType?: ActionType;
-    display?: OperationDisplay;
-    readonly isDataAction?: boolean;
-    readonly name?: string;
-    readonly origin?: Origin;
-}
-
-// @public
-export interface OperationDisplay {
-    readonly description?: string;
-    readonly operation?: string;
-    readonly provider?: string;
-    readonly resource?: string;
-}
-
-// @public
-export interface OperationsListOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface OperationsOperations {
-    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
-}
-
-// @public
-export type OrderByColumnEnum = string;
-
-// @public
-export type Origin = string;
-
-// @public
-export interface OverallSummaryReportQueryFilter extends QueryFilter {
-    reportType: "OverallSummaryReport";
-}
-
-// @public
-export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
-    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
-    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
-    next(): Promise<IteratorResult<TElement>>;
-}
-
-// @public
-export interface PageSettings {
-    continuationToken?: string;
-}
-
-// @public
-export interface QueryFilter {
-    carbonScopeList: EmissionScopeEnum[];
-    dateRange: DateRange;
-    locationList?: string[];
-    reportType: ReportTypeEnum;
-    resourceGroupUrlList?: string[];
-    resourceTypeList?: string[];
-    subscriptionList: string[];
-}
-
-// @public
-export type QueryFilterUnion = OverallSummaryReportQueryFilter | MonthlySummaryReportQueryFilter | TopItemsSummaryReportQueryFilter | TopItemsMonthlySummaryReportQueryFilter | ItemDetailsQueryFilter | QueryFilter;
-
-// @public
-export type ReportTypeEnum = string;
-
-// @public
-export interface ResourceCarbonEmissionItemDetailData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceItemDetailsData";
-    itemName: string;
-    location?: string;
-    resourceGroup: string;
-    resourceId: string;
-    resourceType?: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface ResourceCarbonEmissionTopItemMonthlySummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceTopItemsMonthlySummaryData";
-    date: string;
-    itemName: string;
-    resourceGroup: string;
-    resourceId: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface ResourceCarbonEmissionTopItemsSummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceTopItemsSummaryData";
-    itemName: string;
-    resourceGroup: string;
-    resourceId: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface ResourceGroupCarbonEmissionItemDetailData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceGroupItemDetailsData";
-    itemName: string;
-    resourceGroupUrl: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface ResourceGroupCarbonEmissionTopItemMonthlySummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceGroupTopItemsMonthlySummaryData";
-    date: string;
-    itemName: string;
-    resourceGroupUrl: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface ResourceGroupCarbonEmissionTopItemsSummaryData extends CarbonEmissionData {
-    categoryType: CategoryTypeEnum;
-    dataType: "ResourceGroupTopItemsSummaryData";
-    itemName: string;
-    resourceGroupUrl: string;
-    subscriptionId: string;
-}
-
-// @public
-export type ResponseDataTypeEnum = string;
-
-// @public
-export type SortDirectionEnum = string;
-
-// @public
-export interface SubscriptionAccessDecision {
-    decision: AccessDecisionEnum;
-    denialReason?: string;
-    subscriptionId: string;
-}
-
-// @public
-export interface TopItemsMonthlySummaryReportQueryFilter extends QueryFilter {
-    categoryType: CategoryTypeEnum;
-    reportType: "TopItemsMonthlySummaryReport";
-    topItems: number;
-}
-
-// @public
-export interface TopItemsSummaryReportQueryFilter extends QueryFilter {
-    categoryType: CategoryTypeEnum;
-    reportType: "TopItemsSummaryReport";
-    topItems: number;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```