@azure/arm-costmanagement 1.0.0-alpha.20230518.2

package/src/operations/generateDetailedCostReportOperationResults.ts

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { GenerateDetailedCostReportOperationResults } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { CostManagementClient } from "../costManagementClient";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
+import {
+  GenerateDetailedCostReportOperationResultsGetOptionalParams,
+  GenerateDetailedCostReportOperationResultsGetResponse
+} from "../models";
+
+/** Class containing GenerateDetailedCostReportOperationResults operations. */
+export class GenerateDetailedCostReportOperationResultsImpl
+  implements GenerateDetailedCostReportOperationResults {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class GenerateDetailedCostReportOperationResults class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Gets the result of the specified operation. The link with this operationId is provided as a response
+   * header of the initial request.
+   * @param operationId The target operation Id.
+   * @param scope The ARM Resource ID for subscription, resource group, billing account, or other billing
+   *              scopes. For details, see https://aka.ms/costmgmt/scopes.
+   * @param options The options parameters.
+   */
+  async beginGet(
+    operationId: string,
+    scope: string,
+    options?: GenerateDetailedCostReportOperationResultsGetOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<GenerateDetailedCostReportOperationResultsGetResponse>,
+      GenerateDetailedCostReportOperationResultsGetResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateDetailedCostReportOperationResultsGetResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { operationId, scope, options },
+      spec: getOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateDetailedCostReportOperationResultsGetResponse,
+      OperationState<GenerateDetailedCostReportOperationResultsGetResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Gets the result of the specified operation. The link with this operationId is provided as a response
+   * header of the initial request.
+   * @param operationId The target operation Id.
+   * @param scope The ARM Resource ID for subscription, resource group, billing account, or other billing
+   *              scopes. For details, see https://aka.ms/costmgmt/scopes.
+   * @param options The options parameters.
+   */
+  async beginGetAndWait(
+    operationId: string,
+    scope: string,
+    options?: GenerateDetailedCostReportOperationResultsGetOptionalParams
+  ): Promise<GenerateDetailedCostReportOperationResultsGetResponse> {
+    const poller = await this.beginGet(operationId, scope, options);
+    return poller.pollUntilDone();
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    201: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    202: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    204: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1, Parameters.operationId],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/generateDetailedCostReportOperationStatus.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { GenerateDetailedCostReportOperationStatus } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { CostManagementClient } from "../costManagementClient";
+import {
+  GenerateDetailedCostReportOperationStatusGetOptionalParams,
+  GenerateDetailedCostReportOperationStatusGetResponse
+} from "../models";
+
+/** Class containing GenerateDetailedCostReportOperationStatus operations. */
+export class GenerateDetailedCostReportOperationStatusImpl
+  implements GenerateDetailedCostReportOperationStatus {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class GenerateDetailedCostReportOperationStatus class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport
+   * creation request response header.
+   * @param operationId The target operation Id.
+   * @param scope The ARM Resource ID for subscription, resource group, billing account, or other billing
+   *              scopes. For details, see https://aka.ms/costmgmt/scopes.
+   * @param options The options parameters.
+   */
+  get(
+    operationId: string,
+    scope: string,
+    options?: GenerateDetailedCostReportOperationStatusGetOptionalParams
+  ): Promise<GenerateDetailedCostReportOperationStatusGetResponse> {
+    return this.client.sendOperationRequest(
+      { operationId, scope, options },
+      getOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationStatuses
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1, Parameters.operationId],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/generateReservationDetailsReport.ts

@@ -0,0 +1,319 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { GenerateReservationDetailsReport } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { CostManagementClient } from "../costManagementClient";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
+import {
+  GenerateReservationDetailsReportByBillingAccountIdOptionalParams,
+  GenerateReservationDetailsReportByBillingAccountIdResponse,
+  GenerateReservationDetailsReportByBillingProfileIdOptionalParams,
+  GenerateReservationDetailsReportByBillingProfileIdResponse
+} from "../models";
+
+/** Class containing GenerateReservationDetailsReport operations. */
+export class GenerateReservationDetailsReportImpl
+  implements GenerateReservationDetailsReport {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class GenerateReservationDetailsReport class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Generates the reservations details report for provided date range asynchronously based on enrollment
+   * id. The Reservation usage details can be viewed only by certain enterprise roles. For more details
+   * on the roles see,
+   * https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role
+   * @param billingAccountId Enrollment ID (Legacy BillingAccount ID)
+   * @param startDate Start Date
+   * @param endDate End Date
+   * @param options The options parameters.
+   */
+  async beginByBillingAccountId(
+    billingAccountId: string,
+    startDate: string,
+    endDate: string,
+    options?: GenerateReservationDetailsReportByBillingAccountIdOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<
+        GenerateReservationDetailsReportByBillingAccountIdResponse
+      >,
+      GenerateReservationDetailsReportByBillingAccountIdResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateReservationDetailsReportByBillingAccountIdResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { billingAccountId, startDate, endDate, options },
+      spec: byBillingAccountIdOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateReservationDetailsReportByBillingAccountIdResponse,
+      OperationState<GenerateReservationDetailsReportByBillingAccountIdResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Generates the reservations details report for provided date range asynchronously based on enrollment
+   * id. The Reservation usage details can be viewed only by certain enterprise roles. For more details
+   * on the roles see,
+   * https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role
+   * @param billingAccountId Enrollment ID (Legacy BillingAccount ID)
+   * @param startDate Start Date
+   * @param endDate End Date
+   * @param options The options parameters.
+   */
+  async beginByBillingAccountIdAndWait(
+    billingAccountId: string,
+    startDate: string,
+    endDate: string,
+    options?: GenerateReservationDetailsReportByBillingAccountIdOptionalParams
+  ): Promise<GenerateReservationDetailsReportByBillingAccountIdResponse> {
+    const poller = await this.beginByBillingAccountId(
+      billingAccountId,
+      startDate,
+      endDate,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * Generates the reservations details report for provided date range asynchronously by billing profile.
+   * The Reservation usage details can be viewed by only certain enterprise roles by default. For more
+   * details on the roles see,
+   * https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access
+   * @param billingAccountId Billing account ID
+   * @param billingProfileId Billing profile ID.
+   * @param startDate Start Date
+   * @param endDate End Date
+   * @param options The options parameters.
+   */
+  async beginByBillingProfileId(
+    billingAccountId: string,
+    billingProfileId: string,
+    startDate: string,
+    endDate: string,
+    options?: GenerateReservationDetailsReportByBillingProfileIdOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<
+        GenerateReservationDetailsReportByBillingProfileIdResponse
+      >,
+      GenerateReservationDetailsReportByBillingProfileIdResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateReservationDetailsReportByBillingProfileIdResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { billingAccountId, billingProfileId, startDate, endDate, options },
+      spec: byBillingProfileIdOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateReservationDetailsReportByBillingProfileIdResponse,
+      OperationState<GenerateReservationDetailsReportByBillingProfileIdResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Generates the reservations details report for provided date range asynchronously by billing profile.
+   * The Reservation usage details can be viewed by only certain enterprise roles by default. For more
+   * details on the roles see,
+   * https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access
+   * @param billingAccountId Billing account ID
+   * @param billingProfileId Billing profile ID.
+   * @param startDate Start Date
+   * @param endDate End Date
+   * @param options The options parameters.
+   */
+  async beginByBillingProfileIdAndWait(
+    billingAccountId: string,
+    billingProfileId: string,
+    startDate: string,
+    endDate: string,
+    options?: GenerateReservationDetailsReportByBillingProfileIdOptionalParams
+  ): Promise<GenerateReservationDetailsReportByBillingProfileIdResponse> {
+    const poller = await this.beginByBillingProfileId(
+      billingAccountId,
+      billingProfileId,
+      startDate,
+      endDate,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const byBillingAccountIdOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    201: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    202: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    204: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.startDate,
+    Parameters.endDate
+  ],
+  urlParameters: [Parameters.$host, Parameters.billingAccountId],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const byBillingProfileIdOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    201: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    202: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    204: {
+      bodyMapper: Mappers.OperationStatus
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.startDate,
+    Parameters.endDate
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.billingAccountId,
+    Parameters.billingProfileId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export * from "./operations";
+export * from "./views";
+export * from "./alerts";
+export * from "./forecast";
+export * from "./dimensions";
+export * from "./query";
+export * from "./generateReservationDetailsReport";
+export * from "./exports";
+export * from "./generateCostDetailsReport";
+export * from "./generateDetailedCostReport";
+export * from "./generateDetailedCostReportOperationResults";
+export * from "./generateDetailedCostReportOperationStatus";
+export * from "./priceSheet";
+export * from "./scheduledActions";
+export * from "./benefitRecommendations";
+export * from "./benefitUtilizationSummaries";