@azure/arm-portal 1.0.0-beta.1

package/review/arm-portal.api.md

@@ -0,0 +1,349 @@
+## API Report File for "@azure/arm-portal"
+
+> 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 type Configuration = ProxyResource & {
+    enforcePrivateMarkdownStorage?: boolean;
+};
+
+// @public
+export interface ConfigurationList {
+    nextLink?: string;
+    value?: Configuration[];
+}
+
+// @public
+export type ConfigurationName = string;
+
+// @public
+export interface Dashboard {
+    readonly id?: string;
+    lenses?: DashboardLens[];
+    location: string;
+    metadata?: {
+        [propertyName: string]: Record<string, unknown>;
+    };
+    readonly name?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface DashboardLens {
+    metadata?: {
+        [propertyName: string]: Record<string, unknown>;
+    };
+    order: number;
+    parts: DashboardParts[];
+}
+
+// @public
+export interface DashboardListResult {
+    nextLink?: string;
+    value?: Dashboard[];
+}
+
+// @public
+export interface DashboardPartMetadata {
+    [property: string]: any;
+    type: "Extension/HubsExtension/PartType/MarkdownPart";
+}
+
+// @public (undocumented)
+export type DashboardPartMetadataUnion = DashboardPartMetadata | MarkdownPartMetadata;
+
+// @public
+export interface DashboardParts {
+    metadata?: DashboardPartMetadataUnion;
+    position: DashboardPartsPosition;
+}
+
+// @public
+export interface DashboardPartsPosition {
+    colSpan: number;
+    metadata?: {
+        [propertyName: string]: Record<string, unknown>;
+    };
+    rowSpan: number;
+    x: number;
+    y: number;
+}
+
+// @public
+export interface Dashboards {
+    createOrUpdate(resourceGroupName: string, dashboardName: string, dashboard: Dashboard, options?: DashboardsCreateOrUpdateOptionalParams): Promise<DashboardsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, dashboardName: string, options?: DashboardsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, dashboardName: string, options?: DashboardsGetOptionalParams): Promise<DashboardsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: DashboardsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Dashboard>;
+    listBySubscription(options?: DashboardsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Dashboard>;
+    update(resourceGroupName: string, dashboardName: string, dashboard: PatchableDashboard, options?: DashboardsUpdateOptionalParams): Promise<DashboardsUpdateResponse>;
+}
+
+// @public
+export interface DashboardsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsCreateOrUpdateResponse = Dashboard;
+
+// @public
+export interface DashboardsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface DashboardsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsGetResponse = Dashboard;
+
+// @public
+export interface DashboardsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsListByResourceGroupNextResponse = DashboardListResult;
+
+// @public
+export interface DashboardsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsListByResourceGroupResponse = DashboardListResult;
+
+// @public
+export interface DashboardsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsListBySubscriptionNextResponse = DashboardListResult;
+
+// @public
+export interface DashboardsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsListBySubscriptionResponse = DashboardListResult;
+
+// @public
+export interface DashboardsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DashboardsUpdateResponse = Dashboard;
+
+// @public
+export interface ErrorDefinition {
+    readonly code?: number;
+    readonly details?: ErrorDefinition[];
+    readonly message?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDefinition;
+}
+
+// @public
+export enum KnownConfigurationName {
+    // (undocumented)
+    Default = "default"
+}
+
+// @public
+export interface ListTenantConfigurationViolations {
+    list(options?: ListTenantConfigurationViolationsListOptionalParams): PagedAsyncIterableIterator<Violation>;
+}
+
+// @public
+export interface ListTenantConfigurationViolationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ListTenantConfigurationViolationsListNextResponse = ViolationsList;
+
+// @public
+export interface ListTenantConfigurationViolationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ListTenantConfigurationViolationsListResponse = ViolationsList;
+
+// @public
+export type MarkdownPartMetadata = DashboardPartMetadata & {
+    type: "Extension/HubsExtension/PartType/MarkdownPart";
+    inputs?: Record<string, unknown>[];
+    settings?: MarkdownPartMetadataSettings;
+};
+
+// @public
+export interface MarkdownPartMetadataSettings {
+    content?: MarkdownPartMetadataSettingsContent;
+}
+
+// @public
+export interface MarkdownPartMetadataSettingsContent {
+    settings?: MarkdownPartMetadataSettingsContentSettings;
+}
+
+// @public
+export interface MarkdownPartMetadataSettingsContentSettings {
+    content?: string;
+    markdownSource?: number;
+    markdownUri?: string;
+    subtitle?: string;
+    title?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<ResourceProviderOperation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = ResourceProviderOperationList;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = ResourceProviderOperationList;
+
+// @public
+export interface PatchableDashboard {
+    lenses?: DashboardLens[];
+    metadata?: {
+        [propertyName: string]: Record<string, unknown>;
+    };
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public (undocumented)
+export class Portal extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PortalOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    dashboards: Dashboards;
+    // (undocumented)
+    listTenantConfigurationViolations: ListTenantConfigurationViolations;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    tenantConfigurations: TenantConfigurations;
+}
+
+// @public
+export interface PortalOptionalParams 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 ResourceProviderOperation {
+    display?: ResourceProviderOperationDisplay;
+    isDataAction?: string;
+    name?: string;
+}
+
+// @public
+export interface ResourceProviderOperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface ResourceProviderOperationList {
+    nextLink?: string;
+    value?: ResourceProviderOperation[];
+}
+
+// @public
+export interface TenantConfigurations {
+    create(configurationName: ConfigurationName, tenantConfiguration: Configuration, options?: TenantConfigurationsCreateOptionalParams): Promise<TenantConfigurationsCreateResponse>;
+    delete(configurationName: ConfigurationName, options?: TenantConfigurationsDeleteOptionalParams): Promise<void>;
+    get(configurationName: ConfigurationName, options?: TenantConfigurationsGetOptionalParams): Promise<TenantConfigurationsGetResponse>;
+    list(options?: TenantConfigurationsListOptionalParams): PagedAsyncIterableIterator<Configuration>;
+}
+
+// @public
+export interface TenantConfigurationsCreateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TenantConfigurationsCreateResponse = Configuration;
+
+// @public
+export interface TenantConfigurationsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface TenantConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TenantConfigurationsGetResponse = Configuration;
+
+// @public
+export interface TenantConfigurationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TenantConfigurationsListNextResponse = ConfigurationList;
+
+// @public
+export interface TenantConfigurationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TenantConfigurationsListResponse = ConfigurationList;
+
+// @public
+export interface Violation {
+    readonly errorMessage?: string;
+    readonly id?: string;
+    readonly userId?: string;
+}
+
+// @public
+export interface ViolationsList {
+    nextLink?: string;
+    value?: Violation[];
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -0,0 +1,188 @@
+/*
+ * 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
+];
+
+/**
+ * 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({
+        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 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,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 { Portal } from "./portal";
+export * from "./operationsInterfaces";