@azure/arm-resourcehealth 4.0.1-alpha.20231016.1 → 4.1.0-alpha.20231023.1

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/microsoftResourceHealth.ts

@@ -43,7 +43,7 @@ import { MicrosoftResourceHealthOptionalParams } from "./models";
 export class MicrosoftResourceHealth extends coreClient.ServiceClient {
   $host: string;
   apiVersion: string;
-  subscriptionId: string;
+  subscriptionId?: string;
 
   /**
    * Initializes a new instance of the MicrosoftResourceHealth class.
@@ -55,12 +55,26 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
     credentials: coreAuth.TokenCredential,
     subscriptionId: string,
     options?: MicrosoftResourceHealthOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: MicrosoftResourceHealthOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionIdOrOptions?: MicrosoftResourceHealthOptionalParams | string,
+    options?: MicrosoftResourceHealthOptionalParams
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
     }
-    if (subscriptionId === undefined) {
-      throw new Error("'subscriptionId' cannot be null");
+
+    let subscriptionId: string | undefined;
+
+    if (typeof subscriptionIdOrOptions === "string") {
+      subscriptionId = subscriptionIdOrOptions;
+    } else if (typeof subscriptionIdOrOptions === "object") {
+      options = subscriptionIdOrOptions;
     }
 
     // Initializing default values for options
@@ -72,7 +86,7 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-resourcehealth/4.0.1`;
+    const packageDetails = `azsdk-js-arm-resourcehealth/4.1.0-beta.2`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -125,7 +139,7 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-10-01";
+    this.apiVersion = options.apiVersion || "2023-10-01-preview";
     this.availabilityStatuses = new AvailabilityStatusesImpl(this);
     this.operations = new OperationsImpl(this);
     this.metadata = new MetadataImpl(this);

package/src/models/index.ts

@@ -453,6 +453,31 @@ export interface EventImpactedResource extends ProxyResource {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly targetRegion?: string;
+  /**
+   * Resource name of the impacted resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly resourceName?: string;
+  /**
+   * Resource group name of the impacted resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly resourceGroup?: string;
+  /**
+   * Status of the impacted resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly status?: string;
+  /**
+   * Start time of maintenance for the impacted resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly maintenanceStartTime?: string;
+  /**
+   * End time of maintenance for the impacted resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly maintenanceEndTime?: string;
   /** Additional information. */
   info?: KeyValueItem[];
 }
@@ -461,6 +486,8 @@ export interface EventImpactedResource extends ProxyResource {
 export interface Event extends ProxyResource {
   /** Type of event. */
   eventType?: EventTypeValues;
+  /** Sub type of the event. Currently used to determine retirement communications for health advisory events */
+  eventSubType?: EventSubTypeValues;
   /** Source of event. */
   eventSource?: EventSourceValues;
   /** Current status of event. */
@@ -515,6 +542,12 @@ export interface Event extends ProxyResource {
   duration?: number;
   /** The type of the impact */
   impactType?: string;
+  /** Unique identifier for planned maintenance event. */
+  maintenanceId?: string;
+  /** The type of planned maintenance event. */
+  maintenanceType?: string;
+  /** Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations. */
+  argQuery?: string;
 }
 
 /** The Get EmergingIssues operation response. */
@@ -652,6 +685,21 @@ export enum KnownEventTypeValues {
  */
 export type EventTypeValues = string;
 
+/** Known values of {@link EventSubTypeValues} that the service accepts. */
+export enum KnownEventSubTypeValues {
+  /** Retirement */
+  Retirement = "Retirement"
+}
+
+/**
+ * Defines values for EventSubTypeValues. \
+ * {@link KnownEventSubTypeValues} can be used interchangeably with EventSubTypeValues,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Retirement**
+ */
+export type EventSubTypeValues = string;
+
 /** Known values of {@link EventSourceValues} that the service accepts. */
 export enum KnownEventSourceValues {
   /** ResourceHealth */

package/src/models/mappers.ts

@@ -1265,6 +1265,41 @@ export const EventImpactedResource: coreClient.CompositeMapper = {
           name: "String"
         }
       },
+      resourceName: {
+        serializedName: "properties.resourceName",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      resourceGroup: {
+        serializedName: "properties.resourceGroup",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      status: {
+        serializedName: "properties.status",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      maintenanceStartTime: {
+        serializedName: "properties.maintenanceStartTime",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      maintenanceEndTime: {
+        serializedName: "properties.maintenanceEndTime",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
       info: {
         serializedName: "properties.info",
         type: {
@@ -1293,6 +1328,12 @@ export const Event: coreClient.CompositeMapper = {
           name: "String"
         }
       },
+      eventSubType: {
+        serializedName: "properties.eventSubType",
+        type: {
+          name: "String"
+        }
+      },
       eventSource: {
         serializedName: "properties.eventSource",
         type: {
@@ -1475,6 +1516,24 @@ export const Event: coreClient.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      maintenanceId: {
+        serializedName: "properties.maintenanceId",
+        type: {
+          name: "String"
+        }
+      },
+      maintenanceType: {
+        serializedName: "properties.maintenanceType",
+        type: {
+          name: "String"
+        }
+      },
+      argQuery: {
+        serializedName: "properties.argQuery",
+        type: {
+          name: "String"
+        }
       }
     }
   }

package/src/models/parameters.ts

@@ -39,7 +39,7 @@ export const $host: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2022-10-01",
+    defaultValue: "2023-10-01-preview",
     isConstant: true,
     serializedName: "api-version",
     type: {

package/types/arm-resourcehealth.d.ts

@@ -370,6 +370,8 @@ export declare interface ErrorResponse {
 declare interface Event_2 extends ProxyResource {
     /** Type of event. */
     eventType?: EventTypeValues;
+    /** Sub type of the event. Currently used to determine retirement communications for health advisory events */
+    eventSubType?: EventSubTypeValues;
     /** Source of event. */
     eventSource?: EventSourceValues;
     /** Current status of event. */
@@ -424,6 +426,12 @@ declare interface Event_2 extends ProxyResource {
     duration?: number;
     /** The type of the impact */
     impactType?: string;
+    /** Unique identifier for planned maintenance event. */
+    maintenanceId?: string;
+    /** The type of planned maintenance event. */
+    maintenanceType?: string;
+    /** Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations. */
+    argQuery?: string;
 }
 export { Event_2 as Event }
 
@@ -480,6 +488,31 @@ export declare interface EventImpactedResource extends ProxyResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly targetRegion?: string;
+    /**
+     * Resource name of the impacted resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resourceName?: string;
+    /**
+     * Resource group name of the impacted resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resourceGroup?: string;
+    /**
+     * Status of the impacted resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly status?: string;
+    /**
+     * Start time of maintenance for the impacted resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly maintenanceStartTime?: string;
+    /**
+     * End time of maintenance for the impacted resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly maintenanceEndTime?: string;
     /** Additional information. */
     info?: KeyValueItem[];
 }
@@ -672,6 +705,15 @@ export declare type EventSourceValues = string;
  */
 export declare type EventStatusValues = string;
 
+/**
+ * Defines values for EventSubTypeValues. \
+ * {@link KnownEventSubTypeValues} can be used interchangeably with EventSubTypeValues,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Retirement**
+ */
+export declare type EventSubTypeValues = string;
+
 /**
  * Defines values for EventTypeValues. \
  * {@link KnownEventTypeValues} can be used interchangeably with EventTypeValues,
@@ -902,6 +944,12 @@ export declare enum KnownEventStatusValues {
     Resolved = "Resolved"
 }
 
+/** Known values of {@link EventSubTypeValues} that the service accepts. */
+export declare enum KnownEventSubTypeValues {
+    /** Retirement */
+    Retirement = "Retirement"
+}
+
 /** Known values of {@link EventTypeValues} that the service accepts. */
 export declare enum KnownEventTypeValues {
     /** ServiceIssue */
@@ -1095,7 +1143,7 @@ export declare interface MetadataSupportedValueDetail {
 export declare class MicrosoftResourceHealth extends coreClient.ServiceClient {
     $host: string;
     apiVersion: string;
-    subscriptionId: string;
+    subscriptionId?: string;
     /**
      * Initializes a new instance of the MicrosoftResourceHealth class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
@@ -1103,6 +1151,7 @@ export declare class MicrosoftResourceHealth extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftResourceHealthOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: MicrosoftResourceHealthOptionalParams);
     /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
     private addCustomApiVersionPolicy;
     availabilityStatuses: AvailabilityStatuses;