@azure/arm-costmanagement 1.0.0-alpha.20230518.2

package/src/models/parameters.ts

@@ -0,0 +1,436 @@
+/*
+ * 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 {
+  OperationParameter,
+  OperationURLParameter,
+  OperationQueryParameter
+} from "@azure/core-client";
+import {
+  View as ViewMapper,
+  DismissAlertPayload as DismissAlertPayloadMapper,
+  ForecastDefinition as ForecastDefinitionMapper,
+  QueryDefinition as QueryDefinitionMapper,
+  Export as ExportMapper,
+  GenerateCostDetailsReportRequestDefinition as GenerateCostDetailsReportRequestDefinitionMapper,
+  GenerateDetailedCostReportDefinition as GenerateDetailedCostReportDefinitionMapper,
+  ScheduledAction as ScheduledActionMapper,
+  CheckNameAvailabilityRequest as CheckNameAvailabilityRequestMapper
+} from "../models/mappers";
+
+export const accept: OperationParameter = {
+  parameterPath: "accept",
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Accept",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const $host: OperationURLParameter = {
+  parameterPath: "$host",
+  mapper: {
+    serializedName: "$host",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const apiVersion: OperationQueryParameter = {
+  parameterPath: "apiVersion",
+  mapper: {
+    defaultValue: "2022-10-01",
+    isConstant: true,
+    serializedName: "api-version",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const nextLink: OperationURLParameter = {
+  parameterPath: "nextLink",
+  mapper: {
+    serializedName: "nextLink",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const scope: OperationURLParameter = {
+  parameterPath: "scope",
+  mapper: {
+    serializedName: "scope",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const viewName: OperationURLParameter = {
+  parameterPath: "viewName",
+  mapper: {
+    serializedName: "viewName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const contentType: OperationParameter = {
+  parameterPath: ["options", "contentType"],
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Content-Type",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const parameters: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: ViewMapper
+};
+
+export const scope1: OperationURLParameter = {
+  parameterPath: "scope",
+  mapper: {
+    serializedName: "scope",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const alertId: OperationURLParameter = {
+  parameterPath: "alertId",
+  mapper: {
+    serializedName: "alertId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const parameters1: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: DismissAlertPayloadMapper
+};
+
+export const externalCloudProviderType: OperationURLParameter = {
+  parameterPath: "externalCloudProviderType",
+  mapper: {
+    serializedName: "externalCloudProviderType",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const externalCloudProviderId: OperationURLParameter = {
+  parameterPath: "externalCloudProviderId",
+  mapper: {
+    serializedName: "externalCloudProviderId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const parameters2: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: ForecastDefinitionMapper
+};
+
+export const filter: OperationQueryParameter = {
+  parameterPath: ["options", "filter"],
+  mapper: {
+    serializedName: "$filter",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const expand: OperationQueryParameter = {
+  parameterPath: ["options", "expand"],
+  mapper: {
+    serializedName: "$expand",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const skiptoken: OperationQueryParameter = {
+  parameterPath: ["options", "skiptoken"],
+  mapper: {
+    serializedName: "$skiptoken",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const top: OperationQueryParameter = {
+  parameterPath: ["options", "top"],
+  mapper: {
+    constraints: {
+      InclusiveMaximum: 1000,
+      InclusiveMinimum: 1
+    },
+    serializedName: "$top",
+    type: {
+      name: "Number"
+    }
+  }
+};
+
+export const parameters3: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: QueryDefinitionMapper
+};
+
+export const billingAccountId: OperationURLParameter = {
+  parameterPath: "billingAccountId",
+  mapper: {
+    serializedName: "billingAccountId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const startDate: OperationQueryParameter = {
+  parameterPath: "startDate",
+  mapper: {
+    serializedName: "startDate",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const endDate: OperationQueryParameter = {
+  parameterPath: "endDate",
+  mapper: {
+    serializedName: "endDate",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const billingProfileId: OperationURLParameter = {
+  parameterPath: "billingProfileId",
+  mapper: {
+    serializedName: "billingProfileId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const exportName: OperationURLParameter = {
+  parameterPath: "exportName",
+  mapper: {
+    serializedName: "exportName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const parameters4: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: ExportMapper
+};
+
+export const parameters5: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: GenerateCostDetailsReportRequestDefinitionMapper
+};
+
+export const operationId: OperationURLParameter = {
+  parameterPath: "operationId",
+  mapper: {
+    serializedName: "operationId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const parameters6: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: GenerateDetailedCostReportDefinitionMapper
+};
+
+export const billingAccountName: OperationURLParameter = {
+  parameterPath: "billingAccountName",
+  mapper: {
+    constraints: {
+      Pattern: new RegExp(
+        "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}"
+      )
+    },
+    serializedName: "billingAccountName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const billingProfileName: OperationURLParameter = {
+  parameterPath: "billingProfileName",
+  mapper: {
+    constraints: {
+      Pattern: new RegExp("([A-Za-z0-9]+(-[A-Za-z0-9]+)+)")
+    },
+    serializedName: "billingProfileName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const invoiceName: OperationURLParameter = {
+  parameterPath: "invoiceName",
+  mapper: {
+    constraints: {
+      Pattern: new RegExp("[A-Za-z0-9]+")
+    },
+    serializedName: "invoiceName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const scheduledAction: OperationParameter = {
+  parameterPath: "scheduledAction",
+  mapper: ScheduledActionMapper
+};
+
+export const name: OperationURLParameter = {
+  parameterPath: "name",
+  mapper: {
+    serializedName: "name",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const ifMatch: OperationParameter = {
+  parameterPath: ["options", "ifMatch"],
+  mapper: {
+    serializedName: "If-Match",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const checkNameAvailabilityRequest: OperationParameter = {
+  parameterPath: "checkNameAvailabilityRequest",
+  mapper: CheckNameAvailabilityRequestMapper
+};
+
+export const orderby: OperationQueryParameter = {
+  parameterPath: ["options", "orderby"],
+  mapper: {
+    serializedName: "$orderby",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const billingScope: OperationURLParameter = {
+  parameterPath: "billingScope",
+  mapper: {
+    serializedName: "billingScope",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const grainParameter: OperationQueryParameter = {
+  parameterPath: ["options", "grainParameter"],
+  mapper: {
+    serializedName: "grainParameter",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const filter1: OperationQueryParameter = {
+  parameterPath: ["options", "filter"],
+  mapper: {
+    serializedName: "filter",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const savingsPlanOrderId: OperationURLParameter = {
+  parameterPath: "savingsPlanOrderId",
+  mapper: {
+    serializedName: "savingsPlanOrderId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const savingsPlanId: OperationURLParameter = {
+  parameterPath: "savingsPlanId",
+  mapper: {
+    serializedName: "savingsPlanId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};

package/src/operations/alerts.ts

@@ -0,0 +1,225 @@
+/*
+ * 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 { Alerts } 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 {
+  AlertsListOptionalParams,
+  AlertsListResponse,
+  AlertsGetOptionalParams,
+  AlertsGetResponse,
+  DismissAlertPayload,
+  AlertsDismissOptionalParams,
+  AlertsDismissResponse,
+  ExternalCloudProviderType,
+  AlertsListExternalOptionalParams,
+  AlertsListExternalResponse
+} from "../models";
+
+/** Class containing Alerts operations. */
+export class AlertsImpl implements Alerts {
+  private readonly client: CostManagementClient;
+
+  /**
+   * Initialize a new instance of the class Alerts class.
+   * @param client Reference to the service client
+   */
+  constructor(client: CostManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Lists the alerts for scope defined.
+   * @param scope The scope associated with alerts 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 options The options parameters.
+   */
+  list(
+    scope: string,
+    options?: AlertsListOptionalParams
+  ): Promise<AlertsListResponse> {
+    return this.client.sendOperationRequest(
+      { scope, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * Gets the alert for the scope by alert ID.
+   * @param scope The scope associated with alerts 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 alertId Alert ID
+   * @param options The options parameters.
+   */
+  get(
+    scope: string,
+    alertId: string,
+    options?: AlertsGetOptionalParams
+  ): Promise<AlertsGetResponse> {
+    return this.client.sendOperationRequest(
+      { scope, alertId, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * Dismisses the specified alert
+   * @param scope The scope associated with alerts 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 alertId Alert ID
+   * @param parameters Parameters supplied to the Dismiss Alert operation.
+   * @param options The options parameters.
+   */
+  dismiss(
+    scope: string,
+    alertId: string,
+    parameters: DismissAlertPayload,
+    options?: AlertsDismissOptionalParams
+  ): Promise<AlertsDismissResponse> {
+    return this.client.sendOperationRequest(
+      { scope, alertId, parameters, options },
+      dismissOperationSpec
+    );
+  }
+
+  /**
+   * Lists the Alerts 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 options The options parameters.
+   */
+  listExternal(
+    externalCloudProviderType: ExternalCloudProviderType,
+    externalCloudProviderId: string,
+    options?: AlertsListExternalOptionalParams
+  ): Promise<AlertsListExternalResponse> {
+    return this.client.sendOperationRequest(
+      { externalCloudProviderType, externalCloudProviderId, options },
+      listExternalOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.CostManagement/alerts",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.AlertsResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.Alert
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1, Parameters.alertId],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const dismissOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}",
+  httpMethod: "PATCH",
+  responses: {
+    200: {
+      bodyMapper: Mappers.Alert
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters1,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope1, Parameters.alertId],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const listExternalOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.AlertsResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.externalCloudProviderType,
+    Parameters.externalCloudProviderId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};