@azure/arm-changes 1.0.0

package/rollup.config.js

@@ -0,0 +1,122 @@
+/*
+ * 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";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+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/**"]
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs(),
+      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 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()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/changesClient.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import * as coreAuth from "@azure/core-auth";
+import { ChangesImpl } from "./operations";
+import { Changes } from "./operationsInterfaces";
+import { ChangesClientOptionalParams } from "./models";
+
+export class ChangesClient extends coreClient.ServiceClient {
+  $host: string;
+  subscriptionId: string;
+  apiVersion: string;
+
+  /**
+   * Initializes a new instance of the ChangesClient class.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
+   *                       00000000-0000-0000-0000-000000000000)
+   * @param options The parameter options
+   */
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: ChangesClientOptionalParams
+  ) {
+    if (credentials === undefined) {
+      throw new Error("'credentials' cannot be null");
+    }
+    if (subscriptionId === undefined) {
+      throw new Error("'subscriptionId' cannot be null");
+    }
+
+    // Initializing default values for options
+    if (!options) {
+      options = {};
+    }
+    const defaults: ChangesClientOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
+
+    const packageDetails = `azsdk-js-arm-changes/1.0.0`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
+
+    if (!options.credentialScopes) {
+      options.credentialScopes = ["https://management.azure.com/.default"];
+    }
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix
+      },
+      baseUri:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+      if (!bearerTokenAuthenticationPolicyFound) {
+        this.pipeline.removePolicy({
+          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+        });
+        this.pipeline.addPolicy(
+          coreRestPipeline.bearerTokenAuthenticationPolicy({
+            scopes: `${optionsWithDefaults.baseUri}/.default`,
+            challengeCallbacks: {
+              authorizeRequestOnChallenge:
+                coreClient.authorizeRequestOnClaimChallenge
+            }
+          })
+        );
+      }
+    }
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2022-05-01";
+    this.changes = new ChangesImpl(this);
+  }
+
+  changes: Changes;
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { ChangesClient } from "./changesClient";
+export * from "./operationsInterfaces";

package/src/models/index.ts

@@ -0,0 +1,213 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+
+/** The list of resources */
+export interface ChangeResourceListResult {
+  /** The link used to get the next page of Change Resources */
+  nextLink?: string;
+  /** The list of resources */
+  value?: ChangeResourceResult[];
+}
+
+/** The properties of a change */
+export interface ChangeProperties {
+  /**
+   * The fully qualified ID of the target resource that was changed
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly targetResourceId?: string;
+  /**
+   * The namespace and type of the resource
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly targetResourceType?: string;
+  /**
+   * The type of change that was captured in the resource
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly changeType?: ChangeType;
+  /** Details about the change resource */
+  changeAttributes?: ChangeAttributes;
+  /** A dictionary with changed property name as a key and the change details as the value */
+  changes?: { [propertyName: string]: ChangeBase };
+}
+
+/** Details about the change resource */
+export interface ChangeAttributes {
+  /**
+   * The ARM correlation ID of the change resource
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly correlationId?: string;
+  /**
+   * The time the change(s) on the target resource ocurred
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly timestamp?: string;
+  /**
+   * The number of changes this resource captures
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly changesCount?: number;
+  /**
+   * The GUID of the previous snapshot
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly previousResourceSnapshotId?: string;
+  /**
+   * The GUID of the new snapshot
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly newResourceSnapshotId?: string;
+}
+
+/** An individual change on the target resource */
+export interface ChangeBase {
+  /**
+   * The type of change that occurred
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly propertyChangeType?: PropertyChangeType;
+  /**
+   * The entity that made the change
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly changeCategory?: ChangeCategory;
+  /**
+   * The target resource property value before the change
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly previousValue?: string;
+  /**
+   * The target resource property value after the change
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly newValue?: string;
+}
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+  /**
+   * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The name of the resource
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export interface ErrorResponse {
+  /** The error object. */
+  error?: ErrorDetail;
+}
+
+/** The error detail. */
+export interface ErrorDetail {
+  /**
+   * The error code.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly code?: string;
+  /**
+   * The error message.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly message?: string;
+  /**
+   * The error target.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly target?: string;
+  /**
+   * The error details.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly details?: ErrorDetail[];
+  /**
+   * The error additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** The resource management error additional info. */
+export interface ErrorAdditionalInfo {
+  /**
+   * The additional info type.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly info?: Record<string, unknown>;
+}
+
+/** Change Resource */
+export type ChangeResourceResult = Resource & {
+  /** The properties of a change */
+  properties?: ChangeProperties;
+};
+/** Defines values for ChangeType. */
+export type ChangeType = "Update" | "Delete" | "Create";
+/** Defines values for PropertyChangeType. */
+export type PropertyChangeType = "Update" | "Insert" | "Remove";
+/** Defines values for ChangeCategory. */
+export type ChangeCategory = "User" | "System";
+
+/** Optional parameters. */
+export interface ChangesListOptionalParams extends coreClient.OperationOptions {
+  /** (Optional) Set the maximum number of results per response. */
+  top?: number;
+  /** (Optional) The page-continuation token */
+  skipToken?: string;
+}
+
+/** Contains response data for the list operation. */
+export type ChangesListResponse = ChangeResourceListResult;
+
+/** Optional parameters. */
+export interface ChangesGetOptionalParams extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type ChangesGetResponse = ChangeResourceResult;
+
+/** Optional parameters. */
+export interface ChangesListNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** (Optional) Set the maximum number of results per response. */
+  top?: number;
+  /** (Optional) The page-continuation token */
+  skipToken?: string;
+}
+
+/** Contains response data for the listNext operation. */
+export type ChangesListNextResponse = ChangeResourceListResult;
+
+/** Optional parameters. */
+export interface ChangesClientOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}