@azure/arm-costmanagement 1.0.0-alpha.20230518.2

package/src/operations/forecast.ts

@@ -0,0 +1,137 @@
+/*
+ * 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 { Forecast } 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 {
+  ForecastDefinition,
+  ForecastUsageOptionalParams,
+  ForecastUsageResponse,
+  ExternalCloudProviderType,
+  ForecastExternalCloudProviderUsageOptionalParams,
+  ForecastExternalCloudProviderUsageResponse
+} from "../models";
+
+/** Class containing Forecast operations. */
+export class ForecastImpl implements Forecast {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class Forecast class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Lists the forecast charges for scope defined.
+   * @param scope The scope associated with forecast operations. This includes
+   *              '/subscriptions/{subscriptionId}/' for subscription scope,
+   *              '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope,
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for
+   *              Department scope,
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'
+   *              for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}
+   *              for Management Group scope,
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'
+   *              for billingProfile scope,
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
+   *              for invoiceSection scope, and
+   *              '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific
+   *              for partners.
+   * @param parameters Parameters supplied to the CreateOrUpdate Forecast Config operation.
+   * @param options The options parameters.
+   */
+  usage(
+    scope: string,
+    parameters: ForecastDefinition,
+    options?: ForecastUsageOptionalParams
+  ): Promise<ForecastUsageResponse> {
+    return this.client.sendOperationRequest(
+      { scope, parameters, options },
+      usageOperationSpec
+    );
+  }
+
+  /**
+   * Lists the forecast charges for external cloud provider type defined.
+   * @param externalCloudProviderType The external cloud provider type associated with dimension/query
+   *                                  operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts'
+   *                                  for consolidated account.
+   * @param externalCloudProviderId This can be '{externalSubscriptionId}' for linked account or
+   *                                '{externalBillingAccountId}' for consolidated account used with dimension/query operations.
+   * @param parameters Parameters supplied to the CreateOrUpdate Forecast Config operation.
+   * @param options The options parameters.
+   */
+  externalCloudProviderUsage(
+    externalCloudProviderType: ExternalCloudProviderType,
+    externalCloudProviderId: string,
+    parameters: ForecastDefinition,
+    options?: ForecastExternalCloudProviderUsageOptionalParams
+  ): Promise<ForecastExternalCloudProviderUsageResponse> {
+    return this.client.sendOperationRequest(
+      {
+        externalCloudProviderType,
+        externalCloudProviderId,
+        parameters,
+        options
+      },
+      externalCloudProviderUsageOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const usageOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.CostManagement/forecast",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ForecastResult
+    },
+    204: {},
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters2,
+  queryParameters: [Parameters.apiVersion, Parameters.filter],
+  urlParameters: [Parameters.$host, Parameters.scope1],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const externalCloudProviderUsageOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ForecastResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters2,
+  queryParameters: [Parameters.apiVersion, Parameters.filter],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.externalCloudProviderType,
+    Parameters.externalCloudProviderId
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};

package/src/operations/generateCostDetailsReport.ts

@@ -0,0 +1,302 @@
+/*
+ * 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 { GenerateCostDetailsReport } 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 {
+  GenerateCostDetailsReportRequestDefinition,
+  GenerateCostDetailsReportCreateOperationOptionalParams,
+  GenerateCostDetailsReportCreateOperationResponse,
+  GenerateCostDetailsReportGetOperationResultsOptionalParams,
+  GenerateCostDetailsReportGetOperationResultsResponse
+} from "../models";
+
+/** Class containing GenerateCostDetailsReport operations. */
+export class GenerateCostDetailsReportImpl
+  implements GenerateCostDetailsReport {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class GenerateCostDetailsReport class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * This API is the replacement for all previously release Usage Details APIs. Request to generate a
+   * cost details report for the provided date range, billing period (Only enterprise customers) or
+   * Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202
+   * with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll
+   * to get the result of the report generation. The 'Retry-After' provides the duration to wait before
+   * polling for the generated report. A call to poll the report operation will provide a 202 response
+   * with a 'Location' header if the operation is still in progress. Once the report generation operation
+   * completes, the polling endpoint will provide a 200 response along with details on the report blob(s)
+   * that are available for download. The details on the file(s) available for download will be available
+   * in the polling response body. To Understand cost details (formerly known as usage details) fields
+   * found in files ,see
+   * https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields
+   * @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 parameters Parameters supplied to the Create cost details operation.
+   * @param options The options parameters.
+   */
+  async beginCreateOperation(
+    scope: string,
+    parameters: GenerateCostDetailsReportRequestDefinition,
+    options?: GenerateCostDetailsReportCreateOperationOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<GenerateCostDetailsReportCreateOperationResponse>,
+      GenerateCostDetailsReportCreateOperationResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateCostDetailsReportCreateOperationResponse> => {
+      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: { scope, parameters, options },
+      spec: createOperationOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateCostDetailsReportCreateOperationResponse,
+      OperationState<GenerateCostDetailsReportCreateOperationResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * This API is the replacement for all previously release Usage Details APIs. Request to generate a
+   * cost details report for the provided date range, billing period (Only enterprise customers) or
+   * Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202
+   * with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll
+   * to get the result of the report generation. The 'Retry-After' provides the duration to wait before
+   * polling for the generated report. A call to poll the report operation will provide a 202 response
+   * with a 'Location' header if the operation is still in progress. Once the report generation operation
+   * completes, the polling endpoint will provide a 200 response along with details on the report blob(s)
+   * that are available for download. The details on the file(s) available for download will be available
+   * in the polling response body. To Understand cost details (formerly known as usage details) fields
+   * found in files ,see
+   * https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields
+   * @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 parameters Parameters supplied to the Create cost details operation.
+   * @param options The options parameters.
+   */
+  async beginCreateOperationAndWait(
+    scope: string,
+    parameters: GenerateCostDetailsReportRequestDefinition,
+    options?: GenerateCostDetailsReportCreateOperationOptionalParams
+  ): Promise<GenerateCostDetailsReportCreateOperationResponse> {
+    const poller = await this.beginCreateOperation(scope, parameters, options);
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * Get the result of the specified operation. This link is provided in the CostDetails creation request
+   * response Location header.
+   * @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 operationId The target operation Id.
+   * @param options The options parameters.
+   */
+  async beginGetOperationResults(
+    scope: string,
+    operationId: string,
+    options?: GenerateCostDetailsReportGetOperationResultsOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<GenerateCostDetailsReportGetOperationResultsResponse>,
+      GenerateCostDetailsReportGetOperationResultsResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateCostDetailsReportGetOperationResultsResponse> => {
+      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: { scope, operationId, options },
+      spec: getOperationResultsOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateCostDetailsReportGetOperationResultsResponse,
+      OperationState<GenerateCostDetailsReportGetOperationResultsResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Get the result of the specified operation. This link is provided in the CostDetails creation request
+   * response Location header.
+   * @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 operationId The target operation Id.
+   * @param options The options parameters.
+   */
+  async beginGetOperationResultsAndWait(
+    scope: string,
+    operationId: string,
+    options?: GenerateCostDetailsReportGetOperationResultsOptionalParams
+  ): Promise<GenerateCostDetailsReportGetOperationResultsResponse> {
+    const poller = await this.beginGetOperationResults(
+      scope,
+      operationId,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const createOperationOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    201: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    202: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    204: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    default: {
+      bodyMapper: Mappers.GenerateCostDetailsReportErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters5,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const getOperationResultsOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    201: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    202: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    204: {
+      bodyMapper: Mappers.CostDetailsOperationResults
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1, Parameters.operationId],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/generateDetailedCostReport.ts

@@ -0,0 +1,166 @@
+/*
+ * 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 { GenerateDetailedCostReport } 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 {
+  GenerateDetailedCostReportDefinition,
+  GenerateDetailedCostReportCreateOperationOptionalParams,
+  GenerateDetailedCostReportCreateOperationResponse
+} from "../models";
+
+/** Class containing GenerateDetailedCostReport operations. */
+export class GenerateDetailedCostReportImpl
+  implements GenerateDetailedCostReport {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class GenerateDetailedCostReport class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Generates the detailed cost report for provided date range, billing period(only enterprise
+   * customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header
+   * Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation
+   * will provide the status and if the operation is completed the blob file where generated detailed
+   * cost report is being stored.
+   * @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 parameters Parameters supplied to the Create detailed cost report operation.
+   * @param options The options parameters.
+   */
+  async beginCreateOperation(
+    scope: string,
+    parameters: GenerateDetailedCostReportDefinition,
+    options?: GenerateDetailedCostReportCreateOperationOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<GenerateDetailedCostReportCreateOperationResponse>,
+      GenerateDetailedCostReportCreateOperationResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<GenerateDetailedCostReportCreateOperationResponse> => {
+      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: { scope, parameters, options },
+      spec: createOperationOperationSpec
+    });
+    const poller = await createHttpPoller<
+      GenerateDetailedCostReportCreateOperationResponse,
+      OperationState<GenerateDetailedCostReportCreateOperationResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Generates the detailed cost report for provided date range, billing period(only enterprise
+   * customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header
+   * Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation
+   * will provide the status and if the operation is completed the blob file where generated detailed
+   * cost report is being stored.
+   * @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 parameters Parameters supplied to the Create detailed cost report operation.
+   * @param options The options parameters.
+   */
+  async beginCreateOperationAndWait(
+    scope: string,
+    parameters: GenerateDetailedCostReportDefinition,
+    options?: GenerateDetailedCostReportCreateOperationOptionalParams
+  ): Promise<GenerateDetailedCostReportCreateOperationResponse> {
+    const poller = await this.beginCreateOperation(scope, parameters, options);
+    return poller.pollUntilDone();
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const createOperationOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    201: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    202: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    204: {
+      bodyMapper: Mappers.GenerateDetailedCostReportOperationResult
+    },
+    default: {
+      bodyMapper: Mappers.GenerateDetailedCostReportErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters6,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};