@azure/arm-appcomplianceautomation 1.0.0-alpha.20221102.1

package/review/arm-appcomplianceautomation.api.md

@@ -0,0 +1,588 @@
+## API Report File for "@azure/arm-appcomplianceautomation"
+
+> 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';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public (undocumented)
+export class AppComplianceAutomationToolForMicrosoft365 extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, options?: AppComplianceAutomationToolForMicrosoft365OptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    report: Report;
+    // (undocumented)
+    reports: Reports;
+    // (undocumented)
+    snapshot: Snapshot;
+    // (undocumented)
+    snapshots: Snapshots;
+}
+
+// @public
+export interface AppComplianceAutomationToolForMicrosoft365OptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface Assessment {
+    readonly description?: string;
+    readonly isPass?: IsPass;
+    readonly name?: string;
+    readonly policyId?: string;
+    readonly remediation?: string;
+    readonly resourceList?: AssessmentResource[];
+    readonly severity?: AssessmentSeverity;
+}
+
+// @public
+export interface AssessmentResource {
+    readonly reason?: string;
+    readonly resourceId?: string;
+    readonly resourceStatus?: ResourceStatus;
+    readonly statusChangeDate?: string;
+}
+
+// @public
+export type AssessmentSeverity = string;
+
+// @public
+export interface Category {
+    readonly categoryName?: string;
+    readonly categoryStatus?: CategoryStatus;
+    readonly categoryType?: CategoryType;
+    readonly controlFamilies?: ControlFamily[];
+}
+
+// @public
+export type CategoryStatus = string;
+
+// @public
+export type CategoryType = string;
+
+// @public
+export interface ComplianceReportItem {
+    readonly categoryName?: string;
+    readonly complianceState?: ComplianceState;
+    readonly controlId?: string;
+    readonly controlName?: string;
+    readonly controlType?: ControlType;
+    readonly policyDescription?: string;
+    readonly policyDisplayName?: string;
+    readonly policyId?: string;
+    readonly resourceGroup?: string;
+    readonly resourceId?: string;
+    readonly resourceType?: string;
+    readonly statusChangeDate?: string;
+    readonly subscriptionId?: string;
+}
+
+// @public
+export interface ComplianceResult {
+    readonly categories?: Category[];
+    readonly complianceName?: string;
+}
+
+// @public
+export type ComplianceState = string;
+
+// @public
+export interface Control {
+    readonly assessments?: Assessment[];
+    readonly controlDescription?: string;
+    readonly controlDescriptionHyperLink?: string;
+    readonly controlFullName?: string;
+    readonly controlId?: string;
+    readonly controlShortName?: string;
+    readonly controlStatus?: ControlStatus;
+    readonly controlType?: ControlType;
+}
+
+// @public
+export interface ControlFamily {
+    readonly controls?: Control[];
+    readonly familyName?: string;
+    readonly familyStatus?: ControlFamilyStatus;
+    readonly familyType?: ControlFamilyType;
+}
+
+// @public
+export type ControlFamilyStatus = string;
+
+// @public
+export type ControlFamilyType = string;
+
+// @public
+export type ControlStatus = string;
+
+// @public
+export type ControlType = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DownloadResponse {
+    readonly complianceDetailedPdfReport?: DownloadResponseComplianceDetailedPdfReport;
+    readonly compliancePdfReport?: DownloadResponseCompliancePdfReport;
+    readonly complianceReport?: ComplianceReportItem[];
+    readonly resourceList?: ResourceItem[];
+}
+
+// @public
+export interface DownloadResponseComplianceDetailedPdfReport {
+    readonly sasUri?: string;
+}
+
+// @public
+export interface DownloadResponseCompliancePdfReport {
+    readonly sasUri?: string;
+}
+
+// @public
+export type DownloadType = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export type IsPass = string;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAssessmentSeverity {
+    High = "High",
+    Low = "Low",
+    Medium = "Medium"
+}
+
+// @public
+export enum KnownCategoryStatus {
+    Healthy = "Healthy",
+    Unhealthy = "Unhealthy"
+}
+
+// @public
+export enum KnownCategoryType {
+    FullyAutomated = "FullyAutomated",
+    Manual = "Manual",
+    PartiallyAutomated = "PartiallyAutomated"
+}
+
+// @public
+export enum KnownComplianceState {
+    Healthy = "Healthy",
+    Unhealthy = "Unhealthy"
+}
+
+// @public
+export enum KnownControlFamilyStatus {
+    Healthy = "Healthy",
+    Unhealthy = "Unhealthy"
+}
+
+// @public
+export enum KnownControlFamilyType {
+    FullyAutomated = "FullyAutomated",
+    Manual = "Manual",
+    PartiallyAutomated = "PartiallyAutomated"
+}
+
+// @public
+export enum KnownControlStatus {
+    Failed = "Failed",
+    NotApplicable = "NotApplicable",
+    Passed = "Passed"
+}
+
+// @public
+export enum KnownControlType {
+    FullyAutomated = "FullyAutomated",
+    Manual = "Manual",
+    PartiallyAutomated = "PartiallyAutomated"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownDownloadType {
+    ComplianceDetailedPdfReport = "ComplianceDetailedPdfReport",
+    CompliancePdfReport = "CompliancePdfReport",
+    ComplianceReport = "ComplianceReport",
+    ResourceList = "ResourceList"
+}
+
+// @public
+export enum KnownIsPass {
+    False = "False",
+    True = "True"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownReportStatus {
+    Active = "Active",
+    Disabled = "Disabled",
+    Failed = "Failed"
+}
+
+// @public
+export enum KnownResourceStatus {
+    Healthy = "Healthy",
+    NotApplicable = "NotApplicable",
+    Unhealthy = "Unhealthy"
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type Origin = string;
+
+// @public
+export interface OverviewStatus {
+    failedCount?: number;
+    manualCount?: number;
+    passedCount?: number;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Report {
+    beginCreateOrUpdate(reportName: string, parameters: ReportResource, options?: ReportCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ReportCreateOrUpdateResponse>, ReportCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(reportName: string, parameters: ReportResource, options?: ReportCreateOrUpdateOptionalParams): Promise<ReportCreateOrUpdateResponse>;
+    beginDelete(reportName: string, options?: ReportDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(reportName: string, options?: ReportDeleteOptionalParams): Promise<void>;
+    beginUpdate(reportName: string, parameters: ReportResourcePatch, options?: ReportUpdateOptionalParams): Promise<PollerLike<PollOperationState<ReportUpdateResponse>, ReportUpdateResponse>>;
+    beginUpdateAndWait(reportName: string, parameters: ReportResourcePatch, options?: ReportUpdateOptionalParams): Promise<ReportUpdateResponse>;
+    get(reportName: string, options?: ReportGetOptionalParams): Promise<ReportGetResponse>;
+}
+
+// @public
+export interface ReportComplianceStatus {
+    m365?: OverviewStatus;
+}
+
+// @public
+export interface ReportCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ReportCreateOrUpdateResponse = ReportResource;
+
+// @public
+export interface ReportDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ReportGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ReportGetResponse = ReportResource;
+
+// @public
+export interface ReportProperties {
+    readonly complianceStatus?: ReportComplianceStatus;
+    readonly id?: string;
+    readonly lastTriggerTime?: Date;
+    readonly nextTriggerTime?: Date;
+    offerGuid?: string;
+    readonly provisioningState?: ProvisioningState;
+    readonly reportName?: string;
+    resources: ResourceMetadata[];
+    readonly status?: ReportStatus;
+    readonly subscriptions?: string[];
+    readonly tenantId?: string;
+    timeZone: string;
+    triggerTime: Date;
+}
+
+// @public
+export interface ReportResource extends ProxyResource {
+    properties: ReportProperties;
+}
+
+// @public
+export interface ReportResourceList {
+    nextLink?: string;
+    readonly value?: ReportResource[];
+}
+
+// @public
+export interface ReportResourcePatch {
+    properties?: ReportProperties;
+}
+
+// @public
+export interface Reports {
+    list(options?: ReportsListOptionalParams): PagedAsyncIterableIterator<ReportResource>;
+}
+
+// @public
+export interface ReportsListNextOptionalParams extends coreClient.OperationOptions {
+    offerGuid?: string;
+    reportCreatorTenantId?: string;
+    select?: string;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export type ReportsListNextResponse = ReportResourceList;
+
+// @public
+export interface ReportsListOptionalParams extends coreClient.OperationOptions {
+    offerGuid?: string;
+    reportCreatorTenantId?: string;
+    select?: string;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export type ReportsListResponse = ReportResourceList;
+
+// @public
+export type ReportStatus = string;
+
+// @public
+export interface ReportUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ReportUpdateResponse = ReportResource;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceItem {
+    readonly resourceGroup?: string;
+    readonly resourceId?: string;
+    readonly resourceType?: string;
+    readonly subscriptionId?: string;
+}
+
+// @public
+export interface ResourceMetadata {
+    resourceId: string;
+    resourceKind?: string;
+    resourceName?: string;
+    resourceType?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type ResourceStatus = string;
+
+// @public
+export interface Snapshot {
+    beginDownload(reportName: string, snapshotName: string, parameters: SnapshotDownloadRequest, options?: SnapshotDownloadOptionalParams): Promise<PollerLike<PollOperationState<SnapshotDownloadResponse>, SnapshotDownloadResponse>>;
+    beginDownloadAndWait(reportName: string, snapshotName: string, parameters: SnapshotDownloadRequest, options?: SnapshotDownloadOptionalParams): Promise<SnapshotDownloadResponse>;
+    get(reportName: string, snapshotName: string, options?: SnapshotGetOptionalParams): Promise<SnapshotGetResponse>;
+}
+
+// @public
+export interface SnapshotDownloadOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SnapshotDownloadRequest {
+    downloadType: DownloadType;
+    offerGuid?: string;
+    reportCreatorTenantId?: string;
+}
+
+// @public
+export type SnapshotDownloadResponse = DownloadResponse;
+
+// @public
+export interface SnapshotGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SnapshotGetResponse = SnapshotResource;
+
+// @public
+export interface SnapshotProperties {
+    readonly complianceResults?: ComplianceResult[];
+    readonly createdAt?: Date;
+    readonly id?: string;
+    readonly provisioningState?: ProvisioningState;
+    readonly reportProperties?: ReportProperties;
+    readonly reportSystemData?: SystemData;
+    readonly snapshotName?: string;
+}
+
+// @public
+export interface SnapshotResource extends ProxyResource {
+    readonly properties?: SnapshotProperties;
+}
+
+// @public
+export interface SnapshotResourceList {
+    nextLink?: string;
+    readonly value?: SnapshotResource[];
+}
+
+// @public
+export interface Snapshots {
+    list(reportName: string, options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<SnapshotResource>;
+}
+
+// @public
+export interface SnapshotsListNextOptionalParams extends coreClient.OperationOptions {
+    offerGuid?: string;
+    reportCreatorTenantId?: string;
+    select?: string;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export type SnapshotsListNextResponse = SnapshotResourceList;
+
+// @public
+export interface SnapshotsListOptionalParams extends coreClient.OperationOptions {
+    offerGuid?: string;
+    reportCreatorTenantId?: string;
+    select?: string;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export type SnapshotsListResponse = SnapshotResourceList;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

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"));