@azure/arm-locks 1.2.0 → 2.0.0-alpha.20211015.3

package/review/arm-locks.api.md

@@ -0,0 +1,313 @@
+## API Report File for "@azure/arm-locks"
+
+> 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
+export interface AuthorizationOperations {
+    list(options?: AuthorizationOperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+    listNext(nextLink: string, options?: AuthorizationOperationsListNextOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface AuthorizationOperationsListNextNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AuthorizationOperationsListNextNextResponse = OperationListResult;
+
+// @public
+export interface AuthorizationOperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AuthorizationOperationsListNextResponse = OperationListResult;
+
+// @public
+export interface AuthorizationOperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AuthorizationOperationsListResponse = OperationListResult;
+
+// @public
+export enum KnownLockLevel {
+    // (undocumented)
+    CanNotDelete = "CanNotDelete",
+    // (undocumented)
+    NotSpecified = "NotSpecified",
+    // (undocumented)
+    ReadOnly = "ReadOnly"
+}
+
+// @public
+export type LockLevel = string;
+
+// @public (undocumented)
+export class ManagementLockClient extends ManagementLockClientContext {
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ManagementLockClientOptionalParams);
+    // (undocumented)
+    authorizationOperations: AuthorizationOperations;
+    // (undocumented)
+    managementLocks: ManagementLocks;
+}
+
+// @public (undocumented)
+export class ManagementLockClientContext extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ManagementLockClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface ManagementLockClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ManagementLockListResult {
+    nextLink?: string;
+    value?: ManagementLockObject[];
+}
+
+// @public
+export interface ManagementLockObject {
+    readonly id?: string;
+    level: LockLevel;
+    readonly name?: string;
+    notes?: string;
+    owners?: ManagementLockOwner[];
+    readonly type?: string;
+}
+
+// @public
+export interface ManagementLockOwner {
+    applicationId?: string;
+}
+
+// @public
+export interface ManagementLocks {
+    createOrUpdateAtResourceGroupLevel(resourceGroupName: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams): Promise<ManagementLocksCreateOrUpdateAtResourceGroupLevelResponse>;
+    createOrUpdateAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams): Promise<ManagementLocksCreateOrUpdateAtResourceLevelResponse>;
+    createOrUpdateAtSubscriptionLevel(lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams): Promise<ManagementLocksCreateOrUpdateAtSubscriptionLevelResponse>;
+    createOrUpdateByScope(scope: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateByScopeOptionalParams): Promise<ManagementLocksCreateOrUpdateByScopeResponse>;
+    deleteAtResourceGroupLevel(resourceGroupName: string, lockName: string, options?: ManagementLocksDeleteAtResourceGroupLevelOptionalParams): Promise<void>;
+    deleteAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, options?: ManagementLocksDeleteAtResourceLevelOptionalParams): Promise<void>;
+    deleteAtSubscriptionLevel(lockName: string, options?: ManagementLocksDeleteAtSubscriptionLevelOptionalParams): Promise<void>;
+    deleteByScope(scope: string, lockName: string, options?: ManagementLocksDeleteByScopeOptionalParams): Promise<void>;
+    getAtResourceGroupLevel(resourceGroupName: string, lockName: string, options?: ManagementLocksGetAtResourceGroupLevelOptionalParams): Promise<ManagementLocksGetAtResourceGroupLevelResponse>;
+    getAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, options?: ManagementLocksGetAtResourceLevelOptionalParams): Promise<ManagementLocksGetAtResourceLevelResponse>;
+    getAtSubscriptionLevel(lockName: string, options?: ManagementLocksGetAtSubscriptionLevelOptionalParams): Promise<ManagementLocksGetAtSubscriptionLevelResponse>;
+    getByScope(scope: string, lockName: string, options?: ManagementLocksGetByScopeOptionalParams): Promise<ManagementLocksGetByScopeResponse>;
+    listAtResourceGroupLevel(resourceGroupName: string, options?: ManagementLocksListAtResourceGroupLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listAtResourceGroupLevelNext(resourceGroupName: string, nextLink: string, options?: ManagementLocksListAtResourceGroupLevelNextOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: ManagementLocksListAtResourceLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listAtResourceLevelNext(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, nextLink: string, options?: ManagementLocksListAtResourceLevelNextOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listAtSubscriptionLevel(options?: ManagementLocksListAtSubscriptionLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listAtSubscriptionLevelNext(nextLink: string, options?: ManagementLocksListAtSubscriptionLevelNextOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listByScope(scope: string, options?: ManagementLocksListByScopeOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+    listByScopeNext(scope: string, nextLink: string, options?: ManagementLocksListByScopeNextOptionalParams): PagedAsyncIterableIterator<ManagementLockObject>;
+}
+
+// @public
+export interface ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksCreateOrUpdateAtResourceGroupLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksCreateOrUpdateAtResourceLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksCreateOrUpdateAtSubscriptionLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksCreateOrUpdateByScopeOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksCreateOrUpdateByScopeResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksDeleteAtResourceGroupLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ManagementLocksDeleteAtResourceLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ManagementLocksDeleteAtSubscriptionLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ManagementLocksDeleteByScopeOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ManagementLocksGetAtResourceGroupLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksGetAtResourceGroupLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksGetAtResourceLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksGetAtResourceLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksGetAtSubscriptionLevelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksGetAtSubscriptionLevelResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksGetByScopeOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ManagementLocksGetByScopeResponse = ManagementLockObject;
+
+// @public
+export interface ManagementLocksListAtResourceGroupLevelNextNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceGroupLevelNextNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtResourceGroupLevelNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceGroupLevelNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtResourceGroupLevelOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceGroupLevelResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtResourceLevelNextNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceLevelNextNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtResourceLevelNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceLevelNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtResourceLevelOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtResourceLevelResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtSubscriptionLevelNextNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtSubscriptionLevelNextNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtSubscriptionLevelNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtSubscriptionLevelNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListAtSubscriptionLevelOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListAtSubscriptionLevelResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListByScopeNextNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListByScopeNextNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListByScopeNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListByScopeNextResponse = ManagementLockListResult;
+
+// @public
+export interface ManagementLocksListByScopeOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ManagementLocksListByScopeResponse = ManagementLockListResult;
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    name?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    nextLink?: string;
+    value?: Operation[];
+}
+
+
+// (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/managementLockClient.js",
-  external: [
-    "@azure/ms-rest-js",
-    "@azure/ms-rest-azure-js"
-  ],
-  output: {
-    file: "./dist/arm-locks.js",
-    format: "umd",
-    name: "Azure.ArmLocks",
-    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,13 @@
+/*
+ * 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 { ManagementLockClient } from "./managementLockClient";
+export { ManagementLockClientContext } from "./managementLockClientContext";
+export * from "./operationsInterfaces";

package/src/managementLockClient.ts

@@ -1,50 +1,37 @@
 /*
- * 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 Mappers from "./models/mappers";
-import * as operations from "./operations";
+import * as coreAuth from "@azure/core-auth";
+import { AuthorizationOperationsImpl, ManagementLocksImpl } from "./operations";
+import {
+  AuthorizationOperations,
+  ManagementLocks
+} from "./operationsInterfaces";
 import { ManagementLockClientContext } from "./managementLockClientContext";
+import { ManagementLockClientOptionalParams } from "./models";
 
-
-class ManagementLockClient extends ManagementLockClientContext {
-  // Operation groups
-  authorizationOperations: operations.AuthorizationOperations;
-  managementLocks: operations.ManagementLocks;
-
+export class ManagementLockClient extends ManagementLockClientContext {
   /**
    * Initializes a new instance of the ManagementLockClient 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 credentials Subscription credentials which uniquely identify client subscription.
    * @param subscriptionId The ID of the target subscription.
-   * @param [options] The parameter options
+   * @param options The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ManagementLockClientOptions) {
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: ManagementLockClientOptionalParams
+  ) {
     super(credentials, subscriptionId, options);
-    this.authorizationOperations = new operations.AuthorizationOperations(this);
-    this.managementLocks = new operations.ManagementLocks(this);
+    this.authorizationOperations = new AuthorizationOperationsImpl(this);
+    this.managementLocks = new ManagementLocksImpl(this);
   }
-}
 
-// Operation Specifications
-
-export {
-  ManagementLockClient,
-  ManagementLockClientContext,
-  Models as ManagementLockModels,
-  Mappers as ManagementLockMappers
-};
-export * from "./operations";
+  authorizationOperations: AuthorizationOperations;
+  managementLocks: ManagementLocks;
+}