@azure/arm-defendereasm 1.0.0-beta.1

package/review/arm-defendereasm.api.md

@@ -0,0 +1,400 @@
+## API Report File for "@azure/arm-defendereasm"
+
+> 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 { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public (undocumented)
+export class EasmMgmtClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: EasmMgmtClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    labels: Labels;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    tasks: Tasks;
+    // (undocumented)
+    workspaces: Workspaces;
+}
+
+// @public
+export interface EasmMgmtClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: 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 function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    ConfiguringApplication = "ConfiguringApplication",
+    Creating = "Creating",
+    CreatingArtifacts = "CreatingArtifacts",
+    DeletingArtifacts = "DeletingArtifacts",
+    Failed = "Failed",
+    InstallingApplication = "InstallingApplication",
+    MigratingApplicationData = "MigratingApplicationData",
+    NotSpecified = "NotSpecified",
+    ProvisioningResources = "ProvisioningResources",
+    RunningValidations = "RunningValidations",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export interface LabelPatchResource extends LabelResource {
+}
+
+// @public
+export interface LabelResource extends ProxyResource {
+    color?: string;
+    displayName?: string;
+    readonly provisioningState?: ResourceState;
+}
+
+// @public
+export interface LabelResourceList {
+    nextLink?: string;
+    value?: LabelResource[];
+}
+
+// @public
+export interface LabelResourceProperties extends ResourceBaseProperties {
+    color?: string;
+    displayName?: string;
+}
+
+// @public
+export interface Labels {
+    beginCreateAndUpdate(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsCreateAndUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LabelsCreateAndUpdateResponse>, LabelsCreateAndUpdateResponse>>;
+    beginCreateAndUpdateAndWait(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsCreateAndUpdateOptionalParams): Promise<LabelsCreateAndUpdateResponse>;
+    beginDelete(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsDeleteOptionalParams): Promise<void>;
+    getByWorkspace(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsGetByWorkspaceOptionalParams): Promise<LabelsGetByWorkspaceResponse>;
+    listByWorkspace(resourceGroupName: string, workspaceName: string, options?: LabelsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<LabelResource>;
+    update(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsUpdateOptionalParams): Promise<LabelsUpdateResponse>;
+}
+
+// @public
+export interface LabelsCreateAndUpdateOptionalParams extends coreClient.OperationOptions {
+    labelResource?: LabelResource;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type LabelsCreateAndUpdateResponse = LabelResource;
+
+// @public
+export interface LabelsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface LabelsGetByWorkspaceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LabelsGetByWorkspaceResponse = LabelResource;
+
+// @public
+export interface LabelsListByWorkspaceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LabelsListByWorkspaceNextResponse = LabelResourceList;
+
+// @public
+export interface LabelsListByWorkspaceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LabelsListByWorkspaceResponse = LabelResourceList;
+
+// @public
+export interface LabelsUpdateOptionalParams extends coreClient.OperationOptions {
+    labelPatchResource?: LabelPatchResource;
+}
+
+// @public
+export type LabelsUpdateResponse = LabelResource;
+
+// @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 ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceBaseProperties {
+    readonly provisioningState?: ResourceState;
+}
+
+// @public
+export type ResourceState = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TaskResource extends ProxyResource {
+    completedAt?: string;
+    lastPolledAt?: string;
+    metadata?: Record<string, unknown>;
+    phase?: string;
+    readonly provisioningState?: ResourceState;
+    reason?: string;
+    startedAt?: string;
+    state?: string;
+}
+
+// @public
+export interface TaskResourceProperties extends ResourceBaseProperties {
+    completedAt?: string;
+    lastPolledAt?: string;
+    metadata?: Record<string, unknown>;
+    phase?: string;
+    reason?: string;
+    startedAt?: string;
+    state?: string;
+}
+
+// @public
+export interface Tasks {
+    getByWorkspace(resourceGroupName: string, workspaceName: string, taskId: string, options?: TasksGetByWorkspaceOptionalParams): Promise<TasksGetByWorkspaceResponse>;
+}
+
+// @public
+export interface TasksGetByWorkspaceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TasksGetByWorkspaceResponse = TaskResource;
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface WorkspacePatchResource {
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface WorkspaceResource extends TrackedResource {
+    readonly dataPlaneEndpoint?: string;
+    readonly provisioningState?: ResourceState;
+}
+
+// @public
+export interface WorkspaceResourceList {
+    nextLink?: string;
+    value?: WorkspaceResource[];
+}
+
+// @public
+export interface WorkspaceResourceProperties extends ResourceBaseProperties {
+    readonly dataPlaneEndpoint?: string;
+}
+
+// @public
+export interface Workspaces {
+    beginCreateAndUpdate(resourceGroupName: string, workspaceName: string, options?: WorkspacesCreateAndUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesCreateAndUpdateResponse>, WorkspacesCreateAndUpdateResponse>>;
+    beginCreateAndUpdateAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesCreateAndUpdateOptionalParams): Promise<WorkspacesCreateAndUpdateResponse>;
+    beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<WorkspacesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WorkspaceResource>;
+    listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WorkspaceResource>;
+    update(resourceGroupName: string, workspaceName: string, options?: WorkspacesUpdateOptionalParams): Promise<WorkspacesUpdateResponse>;
+}
+
+// @public
+export interface WorkspacesCreateAndUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+    workspaceResource?: WorkspaceResource;
+}
+
+// @public
+export type WorkspacesCreateAndUpdateResponse = WorkspaceResource;
+
+// @public
+export interface WorkspacesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WorkspacesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspacesGetResponse = WorkspaceResource;
+
+// @public
+export interface WorkspacesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspacesListByResourceGroupNextResponse = WorkspaceResourceList;
+
+// @public
+export interface WorkspacesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspacesListByResourceGroupResponse = WorkspaceResourceList;
+
+// @public
+export interface WorkspacesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspacesListBySubscriptionNextResponse = WorkspaceResourceList;
+
+// @public
+export interface WorkspacesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WorkspacesListBySubscriptionResponse = WorkspaceResourceList;
+
+// @public
+export interface WorkspacesUpdateOptionalParams extends coreClient.OperationOptions {
+    workspacePatchResource?: WorkspacePatchResource;
+}
+
+// @public
+export type WorkspacesUpdateResponse = WorkspaceResource;
+
+// (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"));

package/src/easmMgmtClient.ts

@@ -0,0 +1,151 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
+import * as coreAuth from "@azure/core-auth";
+import {
+  WorkspacesImpl,
+  LabelsImpl,
+  TasksImpl,
+  OperationsImpl
+} from "./operations";
+import { Workspaces, Labels, Tasks, Operations } from "./operationsInterfaces";
+import { EasmMgmtClientOptionalParams } from "./models";
+
+export class EasmMgmtClient extends coreClient.ServiceClient {
+  $host: string;
+  apiVersion: string;
+  subscriptionId: string;
+
+  /**
+   * Initializes a new instance of the EasmMgmtClient class.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId The ID of the target subscription.
+   * @param options The parameter options
+   */
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: EasmMgmtClientOptionalParams
+  ) {
+    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: EasmMgmtClientOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
+
+    const packageDetails = `azsdk-js-arm-defendereasm/1.0.0-beta.1`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
+
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix
+      },
+      endpoint:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
+    }
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2023-04-01-preview";
+    this.workspaces = new WorkspacesImpl(this);
+    this.labels = new LabelsImpl(this);
+    this.tasks = new TasksImpl(this);
+    this.operations = new OperationsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
+  }
+
+  workspaces: Workspaces;
+  labels: Labels;
+  tasks: Tasks;
+  operations: Operations;
+}

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 { getContinuationToken } from "./pagingHelper";
+export * from "./models";
+export { EasmMgmtClient } from "./easmMgmtClient";
+export * from "./operationsInterfaces";