@azure/arm-commitmentplans 0.1.0 → 2.0.0-beta.1

package/review/arm-commitmentplans.api.md

@@ -0,0 +1,405 @@
+## API Report File for "@azure/arm-commitmentplans"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public (undocumented)
+export class AzureMLCommitmentPlansManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMLCommitmentPlansManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    commitmentAssociations: CommitmentAssociations;
+    // (undocumented)
+    commitmentPlans: CommitmentPlans;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    skus: Skus;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    usageHistory: UsageHistory;
+}
+
+// @public
+export interface AzureMLCommitmentPlansManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface CatalogSku {
+    readonly capabilities?: SkuCapability[];
+    readonly capacity?: SkuCapacity;
+    readonly costs?: SkuCost[];
+    readonly locations?: string[];
+    readonly name?: string;
+    readonly resourceType?: string;
+    readonly restrictions?: SkuRestrictions[];
+    readonly tier?: string;
+}
+
+// @public
+export type CommitmentAssociation = Resource & {
+    etag?: string;
+    properties?: CommitmentAssociationProperties;
+};
+
+// @public
+export interface CommitmentAssociationListResult {
+    nextLink?: string;
+    value?: CommitmentAssociation[];
+}
+
+// @public
+export interface CommitmentAssociationProperties {
+    readonly associatedResourceId?: string;
+    readonly commitmentPlanId?: string;
+    readonly creationDate?: Date;
+}
+
+// @public
+export interface CommitmentAssociations {
+    get(resourceGroupName: string, commitmentPlanName: string, commitmentAssociationName: string, options?: CommitmentAssociationsGetOptionalParams): Promise<CommitmentAssociationsGetResponse>;
+    list(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentAssociationsListOptionalParams): PagedAsyncIterableIterator<CommitmentAssociation>;
+    move(resourceGroupName: string, commitmentPlanName: string, commitmentAssociationName: string, movePayload: MoveCommitmentAssociationRequest, options?: CommitmentAssociationsMoveOptionalParams): Promise<CommitmentAssociationsMoveResponse>;
+}
+
+// @public
+export interface CommitmentAssociationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CommitmentAssociationsGetResponse = CommitmentAssociation;
+
+// @public
+export interface CommitmentAssociationsListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentAssociationsListNextResponse = CommitmentAssociationListResult;
+
+// @public
+export interface CommitmentAssociationsListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentAssociationsListResponse = CommitmentAssociationListResult;
+
+// @public
+export interface CommitmentAssociationsMoveOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CommitmentAssociationsMoveResponse = CommitmentAssociation;
+
+// @public
+export type CommitmentPlan = Resource & {
+    etag?: string;
+    readonly properties?: CommitmentPlanProperties;
+    sku?: ResourceSku;
+};
+
+// @public
+export interface CommitmentPlanListResult {
+    nextLink?: string;
+    value?: CommitmentPlan[];
+}
+
+// @public
+export interface CommitmentPlanPatchPayload {
+    sku?: ResourceSku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface CommitmentPlanProperties {
+    readonly chargeForOverage?: boolean;
+    readonly chargeForPlan?: boolean;
+    readonly creationDate?: Date;
+    readonly includedQuantities?: {
+        [propertyName: string]: PlanQuantity;
+    };
+    readonly maxAssociationLimit?: number;
+    readonly maxCapacityLimit?: number;
+    readonly minCapacityLimit?: number;
+    readonly planMeter?: string;
+    readonly refillFrequencyInDays?: number;
+    readonly suspendPlanOnOverage?: boolean;
+}
+
+// @public
+export interface CommitmentPlans {
+    createOrUpdate(resourceGroupName: string, commitmentPlanName: string, createOrUpdatePayload: CommitmentPlan, options?: CommitmentPlansCreateOrUpdateOptionalParams): Promise<CommitmentPlansCreateOrUpdateResponse>;
+    get(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansGetOptionalParams): Promise<CommitmentPlansGetResponse>;
+    list(options?: CommitmentPlansListOptionalParams): PagedAsyncIterableIterator<CommitmentPlan>;
+    listInResourceGroup(resourceGroupName: string, options?: CommitmentPlansListInResourceGroupOptionalParams): PagedAsyncIterableIterator<CommitmentPlan>;
+    patch(resourceGroupName: string, commitmentPlanName: string, patchPayload: CommitmentPlanPatchPayload, options?: CommitmentPlansPatchOptionalParams): Promise<CommitmentPlansPatchResponse>;
+    remove(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansRemoveOptionalParams): Promise<void>;
+}
+
+// @public
+export interface CommitmentPlansCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CommitmentPlansCreateOrUpdateResponse = CommitmentPlan;
+
+// @public
+export interface CommitmentPlansGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CommitmentPlansGetResponse = CommitmentPlan;
+
+// @public
+export interface CommitmentPlansListInResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentPlansListInResourceGroupNextResponse = CommitmentPlanListResult;
+
+// @public
+export interface CommitmentPlansListInResourceGroupOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentPlansListInResourceGroupResponse = CommitmentPlanListResult;
+
+// @public
+export interface CommitmentPlansListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentPlansListNextResponse = CommitmentPlanListResult;
+
+// @public
+export interface CommitmentPlansListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type CommitmentPlansListResponse = CommitmentPlanListResult;
+
+// @public
+export interface CommitmentPlansPatchOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CommitmentPlansPatchResponse = CommitmentPlan;
+
+// @public
+export interface CommitmentPlansRemoveOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export enum KnownResourceSkuRestrictionsReasonCode {
+    // (undocumented)
+    NotAvailableForSubscription = "NotAvailableForSubscription",
+    // (undocumented)
+    QuotaId = "QuotaId"
+}
+
+// @public
+export enum KnownResourceSkuRestrictionsType {
+    // (undocumented)
+    Location = "location",
+    // (undocumented)
+    Zone = "zone"
+}
+
+// @public
+export enum KnownSkuCapacityScaleType {
+    // (undocumented)
+    Automatic = "Automatic",
+    // (undocumented)
+    Manual = "Manual",
+    // (undocumented)
+    None = "None"
+}
+
+// @public
+export interface MoveCommitmentAssociationRequest {
+    destinationPlanId?: string;
+}
+
+// @public
+export interface OperationDisplayInfo {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationEntity {
+    display?: OperationDisplayInfo;
+    readonly name?: string;
+}
+
+// @public
+export interface OperationEntityListResult {
+    readonly value?: OperationEntity[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationEntity>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationEntityListResult;
+
+// @public
+export interface PlanQuantity {
+    readonly allowance?: number;
+    readonly amount?: number;
+    readonly includedQuantityMeter?: string;
+    readonly overageMeter?: string;
+}
+
+// @public
+export interface PlanUsageHistory {
+    planDeletionOverage?: {
+        [propertyName: string]: number;
+    };
+    planMigrationOverage?: {
+        [propertyName: string]: number;
+    };
+    planQuantitiesAfterUsage?: {
+        [propertyName: string]: number;
+    };
+    planQuantitiesBeforeUsage?: {
+        [propertyName: string]: number;
+    };
+    planUsageOverage?: {
+        [propertyName: string]: number;
+    };
+    usage?: {
+        [propertyName: string]: number;
+    };
+    usageDate?: Date;
+}
+
+// @public
+export interface PlanUsageHistoryListResult {
+    nextLink?: string;
+    value?: PlanUsageHistory[];
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    location: string;
+    readonly name?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceSku {
+    capacity?: number;
+    name?: string;
+    tier?: string;
+}
+
+// @public
+export type ResourceSkuRestrictionsReasonCode = string;
+
+// @public
+export type ResourceSkuRestrictionsType = string;
+
+// @public
+export interface SkuCapability {
+    readonly name?: string;
+    readonly value?: string;
+}
+
+// @public
+export interface SkuCapacity {
+    readonly default?: number;
+    readonly maximum?: number;
+    readonly minimum?: number;
+    readonly scaleType?: SkuCapacityScaleType;
+}
+
+// @public
+export type SkuCapacityScaleType = string;
+
+// @public
+export interface SkuCost {
+    readonly extendedUnit?: string;
+    readonly meterID?: string;
+    readonly quantity?: number;
+}
+
+// @public
+export interface SkuListResult {
+    readonly value?: CatalogSku[];
+}
+
+// @public
+export interface SkuRestrictions {
+    readonly reasonCode?: ResourceSkuRestrictionsReasonCode;
+    readonly type?: ResourceSkuRestrictionsType;
+    readonly values?: string[];
+}
+
+// @public
+export interface Skus {
+    list(options?: SkusListOptionalParams): PagedAsyncIterableIterator<CatalogSku>;
+}
+
+// @public
+export interface SkusListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SkusListResponse = SkuListResult;
+
+// @public
+export interface UsageHistory {
+    list(resourceGroupName: string, commitmentPlanName: string, options?: UsageHistoryListOptionalParams): PagedAsyncIterableIterator<PlanUsageHistory>;
+}
+
+// @public
+export interface UsageHistoryListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type UsageHistoryListNextResponse = PlanUsageHistoryListResult;
+
+// @public
+export interface UsageHistoryListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type UsageHistoryListResponse = PlanUsageHistoryListResult;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,31 +1,188 @@
-import nodeResolve from "rollup-plugin-node-resolve";
+/*
+ * 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 nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+/**
+ * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
+ *
+ * NOTE: this manual configuration is only needed because OpenTelemetry uses an
+ * __exportStar downleveled helper function to declare its exports which confuses
+ * rollup's automatic discovery mechanism.
+ *
+ * @returns an object reference that can be `...`'d into your cjs() configuration.
+ */
+export function openTelemetryCommonJs() {
+  const namedExports = {};
+
+  for (const key of [
+    "@opentelemetry/api",
+    "@azure/core-tracing/node_modules/@opentelemetry/api"
+  ]) {
+    namedExports[key] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "SpanStatusCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
+
+  for (const version of releasedOpenTelemetryVersions) {
+    namedExports[
+      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
+      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
+    ] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "StatusCode",
+      "CanonicalCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  return namedExports;
+}
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
 /**
- * @type {import('rollup').RollupFileOptions}
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
  */
-const config = {
-  input: './esm/azureMLCommitmentPlansManagementClient.js',
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
-  output: {
-    file: "./dist/arm-commitmentplans.js",
-    format: "umd",
-    name: "Azure.ArmCommitmentplans",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
     },
-    banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is
- * regenerated.
- */`
-  },
-  plugins: [
-    nodeResolve({ module: true })
-  ]
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs({
+        namedExports: {
+          // Chai's strange internal architecture makes it impossible to statically
+          // analyze its exports.
+          chai: [
+            "version",
+            "use",
+            "util",
+            "config",
+            "expect",
+            "should",
+            "assert"
+          ],
+          ...openTelemetryCommonJs()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
 };
-export default config;
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));