@azure/arm-serialconsole 1.1.1 → 2.0.0

package/review/arm-serialconsole.api.md

@@ -0,0 +1,202 @@
+## API Report File for "@azure/arm-serialconsole"
+
+> 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';
+
+// @public
+export interface CloudError {
+    error?: CloudErrorBody;
+}
+
+// @public
+export interface CloudErrorBody {
+    code?: string;
+    details?: CloudErrorBody[];
+    message?: string;
+    target?: string;
+}
+
+// @public
+export interface DisableConsoleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DisableConsoleResponse = DisableSerialConsoleResult;
+
+// @public
+export interface DisableSerialConsoleResult {
+    disabled?: boolean;
+}
+
+// @public
+export interface EnableConsoleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EnableConsoleResponse = EnableSerialConsoleResult;
+
+// @public
+export interface EnableSerialConsoleResult {
+    disabled?: boolean;
+}
+
+// @public
+export interface GetConsoleStatusOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GetConsoleStatusResponse = SerialConsoleStatus;
+
+// @public
+export interface GetSerialConsoleSubscriptionNotFound {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export interface ListOperationsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ListOperationsResponse = SerialConsoleOperations;
+
+// @public (undocumented)
+export class MicrosoftSerialConsoleClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftSerialConsoleClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    disableConsole(defaultParam: string, options?: DisableConsoleOptionalParams): Promise<DisableConsoleResponse>;
+    enableConsole(defaultParam: string, options?: EnableConsoleOptionalParams): Promise<EnableConsoleResponse>;
+    getConsoleStatus(defaultParam: string, options?: GetConsoleStatusOptionalParams): Promise<GetConsoleStatusResponse>;
+    listOperations(options?: ListOperationsOptionalParams): Promise<ListOperationsResponse>;
+    // (undocumented)
+    serialPorts: SerialPorts;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface MicrosoftSerialConsoleClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type ProxyResource = Resource & {};
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface SerialConsoleOperations {
+    value?: SerialConsoleOperationsValueItem[];
+}
+
+// @public (undocumented)
+export interface SerialConsoleOperationsValueItem {
+    // (undocumented)
+    display?: SerialConsoleOperationsValueItemDisplay;
+    // (undocumented)
+    isDataAction?: string;
+    // (undocumented)
+    name?: string;
+}
+
+// @public (undocumented)
+export interface SerialConsoleOperationsValueItemDisplay {
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    operation?: string;
+    // (undocumented)
+    provider?: string;
+    // (undocumented)
+    resource?: string;
+}
+
+// @public
+export interface SerialConsoleStatus {
+    disabled?: boolean;
+}
+
+// @public
+export type SerialPort = ProxyResource & {
+    state?: SerialPortState;
+};
+
+// @public
+export interface SerialPortConnectResult {
+    connectionString?: string;
+}
+
+// @public
+export interface SerialPortListResult {
+    value?: SerialPort[];
+}
+
+// @public
+export interface SerialPorts {
+    connect(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsConnectOptionalParams): Promise<SerialPortsConnectResponse>;
+    create(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, parameters: SerialPort, options?: SerialPortsCreateOptionalParams): Promise<SerialPortsCreateResponse>;
+    delete(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsGetOptionalParams): Promise<SerialPortsGetResponse>;
+    list(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, options?: SerialPortsListOptionalParams): Promise<SerialPortsListResponse>;
+    listBySubscriptions(options?: SerialPortsListBySubscriptionsOptionalParams): Promise<SerialPortsListBySubscriptionsResponse>;
+}
+
+// @public
+export interface SerialPortsConnectOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SerialPortsConnectResponse = SerialPortConnectResult;
+
+// @public
+export interface SerialPortsCreateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SerialPortsCreateResponse = SerialPort;
+
+// @public
+export interface SerialPortsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface SerialPortsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SerialPortsGetResponse = SerialPort;
+
+// @public
+export interface SerialPortsListBySubscriptionsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SerialPortsListBySubscriptionsResponse = SerialPortListResult;
+
+// @public
+export interface SerialPortsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SerialPortsListResponse = SerialPortListResult;
+
+// @public
+export type SerialPortState = "enabled" | "disabled";
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,37 +1,188 @@
-import rollup from "rollup";
-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
 
 /**
- * @type {rollup.RollupFileOptions}
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
  */
-const config = {
-  input: "./esm/microsoftSerialConsoleClient.js",
-  external: [
-    "@azure/ms-rest-js",
-    "@azure/ms-rest-azure-js"
-  ],
-  output: {
-    file: "./dist/arm-serialconsole.js",
-    format: "umd",
-    name: "Azure.ArmSerialconsole",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
+
+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
+];
+
+/**
+ * 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/**"]
     },
-    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 }),
-    sourcemaps()
-  ]
+    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"));

package/src/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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.
+ */
+
+export * from "./models";
+export { MicrosoftSerialConsoleClient } from "./microsoftSerialConsoleClient";
+export * from "./operationsInterfaces";

package/src/microsoftSerialConsoleClient.ts

@@ -1,52 +1,222 @@
 /*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * 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.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import * as msRest from "@azure/ms-rest-js";
-import { TokenCredential } from "@azure/core-auth";
-import * as Models from "./models";
+import * as coreClient from "@azure/core-client";
+import * as coreAuth from "@azure/core-auth";
+import { SerialPortsImpl } from "./operations";
+import { SerialPorts } from "./operationsInterfaces";
+import * as Parameters from "./models/parameters";
 import * as Mappers from "./models/mappers";
-import * as operations from "./operations";
-import { MicrosoftSerialConsoleClientContext } from "./microsoftSerialConsoleClientContext";
+import {
+  MicrosoftSerialConsoleClientOptionalParams,
+  ListOperationsOptionalParams,
+  ListOperationsResponse,
+  GetConsoleStatusOptionalParams,
+  GetConsoleStatusResponse,
+  DisableConsoleOptionalParams,
+  DisableConsoleResponse,
+  EnableConsoleOptionalParams,
+  EnableConsoleResponse
+} from "./models";
 
-
-class MicrosoftSerialConsoleClient extends MicrosoftSerialConsoleClientContext {
-  // Operation groups
-  list: operations.List;
-  listConsole: operations.ListConsole;
-  console: operations.Console;
+export class MicrosoftSerialConsoleClient extends coreClient.ServiceClient {
+  $host: string;
+  apiVersion: string;
+  subscriptionId: string;
 
   /**
    * Initializes a new instance of the MicrosoftSerialConsoleClient class.
-   * @param credentials Credentials needed for the client to connect to Azure. Credentials
-   * implementing the TokenCredential interface from the @azure/identity package are recommended. For
-   * more information about these credentials, see
-   * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
-   * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
-   * @azure/ms-rest-browserauth are also supported.
-   * @param subscriptionId The ID of the target subscription.
-   * @param [options] The parameter options
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId Subscription ID which uniquely identifies the Microsoft Azure subscription.
+   *                       The subscription ID forms part of the URI for every service call requiring it.
+   * @param options The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.MicrosoftSerialConsoleClientOptions) {
-    super(credentials, subscriptionId, options);
-    this.list = new operations.List(this);
-    this.listConsole = new operations.ListConsole(this);
-    this.console = new operations.Console(this);
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: MicrosoftSerialConsoleClientOptionalParams
+  ) {
+    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: MicrosoftSerialConsoleClientOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
+
+    const packageDetails = `azsdk-js-arm-serialconsole/2.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 || "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2018-05-01";
+    this.serialPorts = new SerialPortsImpl(this);
+  }
+
+  /**
+   * Gets a list of Serial Console API operations.
+   * @param options The options parameters.
+   */
+  listOperations(
+    options?: ListOperationsOptionalParams
+  ): Promise<ListOperationsResponse> {
+    return this.sendOperationRequest({ options }, listOperationsOperationSpec);
+  }
+
+  /**
+   * Gets whether or not Serial Console is disabled for a given subscription
+   * @param defaultParam Default parameter. Leave the value as "default".
+   * @param options The options parameters.
+   */
+  getConsoleStatus(
+    defaultParam: string,
+    options?: GetConsoleStatusOptionalParams
+  ): Promise<GetConsoleStatusResponse> {
+    return this.sendOperationRequest(
+      { defaultParam, options },
+      getConsoleStatusOperationSpec
+    );
   }
-}
 
+  /**
+   * Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
+   * @param defaultParam Default parameter. Leave the value as "default".
+   * @param options The options parameters.
+   */
+  disableConsole(
+    defaultParam: string,
+    options?: DisableConsoleOptionalParams
+  ): Promise<DisableConsoleResponse> {
+    return this.sendOperationRequest(
+      { defaultParam, options },
+      disableConsoleOperationSpec
+    );
+  }
+
+  /**
+   * Enables the Serial Console service for all VMs and VM scale sets in the provided subscription
+   * @param defaultParam Default parameter. Leave the value as "default".
+   * @param options The options parameters.
+   */
+  enableConsole(
+    defaultParam: string,
+    options?: EnableConsoleOptionalParams
+  ): Promise<EnableConsoleResponse> {
+    return this.sendOperationRequest(
+      { defaultParam, options },
+      enableConsoleOperationSpec
+    );
+  }
+
+  serialPorts: SerialPorts;
+}
 // Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
 
-export {
-  MicrosoftSerialConsoleClient,
-  MicrosoftSerialConsoleClientContext,
-  Models as MicrosoftSerialConsoleModels,
-  Mappers as MicrosoftSerialConsoleMappers
+const listOperationsOperationSpec: coreClient.OperationSpec = {
+  path: "/providers/Microsoft.SerialConsole/operations",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SerialConsoleOperations
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getConsoleStatusOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SerialConsoleStatus
+    },
+    404: {
+      bodyMapper: Mappers.GetSerialConsoleSubscriptionNotFound
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.defaultParam
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const disableConsoleOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.DisableSerialConsoleResult
+    },
+    404: {
+      bodyMapper: Mappers.GetSerialConsoleSubscriptionNotFound
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.defaultParam
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const enableConsoleOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.EnableSerialConsoleResult
+    },
+    404: {
+      bodyMapper: Mappers.GetSerialConsoleSubscriptionNotFound
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.defaultParam
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
 };
-export * from "./operations";