@azure-rest/defender-easm 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/browser/models.d.ts

@@ -0,0 +1,144 @@
+/** A request body used to update an asset. */
+export interface AssetUpdateData {
+    /**
+     * The state to update the asset to.
+     *
+     * Possible values: "candidate", "confirmed", "dismissed", "candidateInvestigate", "associatedPartner", "associatedThirdparty"
+     */
+    state?: AssetUpdateState;
+    /** A string which can be used to identify the asset in external systems. */
+    externalId?: string;
+    /** Any Labels to update the asset with. */
+    labels?: Record<string, boolean>;
+    /**
+     * A list of asset types to cascade the updates to.
+     *
+     * Possible values: "as", "contact", "domain", "host", "ipAddress", "ipBlock", "page", "sslCert"
+     */
+    transfers?: AssetUpdateTransfers;
+}
+export interface LogAnalyticsDataConnectionData extends DataConnectionDataParent {
+    /** The kind of DataConnectionData */
+    kind: "logAnalytics";
+    /** properties */
+    properties: LogAnalyticsDataConnectionProperties;
+}
+export interface AzureDataExplorerDataConnectionData extends DataConnectionDataParent {
+    /** The kind of DataConnectionData */
+    kind: "azureDataExplorer";
+    /** properties */
+    properties: AzureDataExplorerDataConnectionProperties;
+}
+/** LogAnalyticsDataConnectionProperties */
+export interface LogAnalyticsDataConnectionProperties extends DataConnectionProperties {
+    /** log analytics api key */
+    apiKey?: string;
+    /** log analytics workspace id */
+    workspaceId?: string;
+}
+/** DataConnectionProperties */
+export interface DataConnectionProperties {
+}
+/** AzureDataExplorerDataConnectionProperties */
+export interface AzureDataExplorerDataConnectionProperties extends DataConnectionProperties {
+    /** The azure data explorer cluster name */
+    clusterName?: string;
+    /** The azure data explorer region */
+    region?: string;
+    /** The azure data explorer database name */
+    databaseName?: string;
+}
+export interface DataConnectionDataParent {
+    /** The name of data connection */
+    name?: string;
+    /**
+     * The type of data the data connection will transfer.
+     *
+     * Possible values: "assets", "attackSurfaceInsights"
+     */
+    content?: DataConnectionContent;
+    /**
+     * The rate at which the data connection will receive updates.
+     *
+     * Possible values: "daily", "weekly", "monthly"
+     */
+    frequency?: DataConnectionFrequency;
+    /** The day to update the data connection on. (1-7 for weekly, 1-31 for monthly) */
+    frequencyOffset?: number;
+    kind: string;
+}
+/** Source entity used to drive discovery. */
+export interface DiscoSource {
+    /**
+     * The kind of disco source.
+     *
+     * Possible values: "as", "attribute", "contact", "domain", "host", "ipBlock"
+     */
+    kind?: DiscoSourceKind;
+    /** The name for the disco source. */
+    name?: string;
+}
+/** A request body used to create a discovery group. */
+export interface DiscoGroupData {
+    /** The name for a disco group. */
+    name?: string;
+    /** The description for a disco group. */
+    description?: string;
+    /** The tier for the disco group which will affect the algorithm used for the disco runs in this group. */
+    tier?: string;
+    /** The frequency at which the disco group is supposed to be rerun in milliseconds. */
+    frequencyMilliseconds?: number;
+    /** The list of seeds used for the disco group runs. */
+    seeds?: Array<DiscoSource>;
+    /** The list of names used for the disco group runs. */
+    names?: string[];
+    /** The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm. */
+    excludes?: Array<DiscoSource>;
+    /** The unique identifier for the disco template used for the disco group creation. */
+    templateId?: string;
+}
+/** A request body used to retrieve an asset report snapshot. */
+export interface ReportAssetSnapshotRequest {
+    /** The metric to retrieve a snapshot for. */
+    metric?: string;
+    /** The name of the label to retrieve a snapshot for. */
+    labelName?: string;
+    /** The number of assets per page. */
+    size?: number;
+    /** The page to retrieve. */
+    page?: number;
+}
+/** A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories. */
+export interface ReportAssetSummaryRequest {
+    /** Categories to retrieve risk reporting data for. */
+    metricCategories?: string[];
+    /** Metrics to retrieve risk reporting data for. */
+    metrics?: string[];
+    /** Query filters to apply to the asset summary. */
+    filters?: string[];
+    /** A parameter to group the assets by (first level facet field), only used when the chosen summary identifier is filters. */
+    groupBy?: string;
+    /** A parameter to segment the assets by (second level facet field), only used when the chosen summary identifier is filters. */
+    segmentBy?: string;
+    /** Currently unused. */
+    labelName?: string;
+}
+/** A request body used to create a saved filter. */
+export interface SavedFilterData {
+    /** An expression on the resource type that selects the resources to be returned. */
+    filter: string;
+    /** A human readable description of the saved filter. */
+    description: string;
+}
+export type DataConnectionData = DataConnectionDataParent | LogAnalyticsDataConnectionData | AzureDataExplorerDataConnectionData;
+/** Alias for AssetUpdateState */
+export type AssetUpdateState = string;
+/** Alias for AssetUpdateTransfers */
+export type AssetUpdateTransfers = string;
+/** Alias for DataConnectionContent */
+export type DataConnectionContent = string;
+/** Alias for DataConnectionFrequency */
+export type DataConnectionFrequency = string;
+/** Alias for DiscoSourceKind */
+export type DiscoSourceKind = string;
+//# sourceMappingURL=models.d.ts.map

package/dist/browser/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,8CAA8C;AAC9C,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAClC;AAED,MAAM,WAAW,8BAA+B,SAAQ,wBAAwB;IAC9E,qCAAqC;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,iBAAiB;IACjB,UAAU,EAAE,oCAAoC,CAAC;CAClD;AAED,MAAM,WAAW,mCAAoC,SAAQ,wBAAwB;IACnF,qCAAqC;IACrC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,iBAAiB;IACjB,UAAU,EAAE,yCAAyC,CAAC;CACvD;AAED,2CAA2C;AAC3C,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB;IACpF,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,wBAAwB;CAAG;AAE5C,gDAAgD;AAChD,MAAM,WAAW,yCAA0C,SAAQ,wBAAwB;IACzF,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACvC,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC;;;;OAIG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,mFAAmF;IACnF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,6CAA6C;AAC7C,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0GAA0G;IAC1G,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sFAAsF;IACtF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,uDAAuD;IACvD,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,8GAA8G;IAC9G,QAAQ,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC9B,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,gEAAgE;AAChE,MAAM,WAAW,0BAA0B;IACzC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6KAA6K;AAC7K,MAAM,WAAW,yBAAyB;IACxC,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,6HAA6H;IAC7H,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gIAAgI;IAChI,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC9B,oFAAoF;IACpF,MAAM,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,kBAAkB,GAC1B,wBAAwB,GACxB,8BAA8B,GAC9B,mCAAmC,CAAC;AACxC,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,sCAAsC;AACtC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C,wCAAwC;AACxC,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC7C,gCAAgC;AAChC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}

package/dist/browser/models.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=models.js.map

package/dist/browser/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** A request body used to update an asset. */\nexport interface AssetUpdateData {\n  /**\n   * The state to update the asset to.\n   *\n   * Possible values: \"candidate\", \"confirmed\", \"dismissed\", \"candidateInvestigate\", \"associatedPartner\", \"associatedThirdparty\"\n   */\n  state?: AssetUpdateState;\n  /** A string which can be used to identify the asset in external systems. */\n  externalId?: string;\n  /** Any Labels to update the asset with. */\n  labels?: Record<string, boolean>;\n  /**\n   * A list of asset types to cascade the updates to.\n   *\n   * Possible values: \"as\", \"contact\", \"domain\", \"host\", \"ipAddress\", \"ipBlock\", \"page\", \"sslCert\"\n   */\n  transfers?: AssetUpdateTransfers;\n}\n\nexport interface LogAnalyticsDataConnectionData extends DataConnectionDataParent {\n  /** The kind of DataConnectionData */\n  kind: \"logAnalytics\";\n  /** properties */\n  properties: LogAnalyticsDataConnectionProperties;\n}\n\nexport interface AzureDataExplorerDataConnectionData extends DataConnectionDataParent {\n  /** The kind of DataConnectionData */\n  kind: \"azureDataExplorer\";\n  /** properties */\n  properties: AzureDataExplorerDataConnectionProperties;\n}\n\n/** LogAnalyticsDataConnectionProperties */\nexport interface LogAnalyticsDataConnectionProperties extends DataConnectionProperties {\n  /** log analytics api key */\n  apiKey?: string;\n  /** log analytics workspace id */\n  workspaceId?: string;\n}\n\n/** DataConnectionProperties */\nexport interface DataConnectionProperties {}\n\n/** AzureDataExplorerDataConnectionProperties */\nexport interface AzureDataExplorerDataConnectionProperties extends DataConnectionProperties {\n  /** The azure data explorer cluster name */\n  clusterName?: string;\n  /** The azure data explorer region */\n  region?: string;\n  /** The azure data explorer database name */\n  databaseName?: string;\n}\n\nexport interface DataConnectionDataParent {\n  /** The name of data connection */\n  name?: string;\n  /**\n   * The type of data the data connection will transfer.\n   *\n   * Possible values: \"assets\", \"attackSurfaceInsights\"\n   */\n  content?: DataConnectionContent;\n  /**\n   * The rate at which the data connection will receive updates.\n   *\n   * Possible values: \"daily\", \"weekly\", \"monthly\"\n   */\n  frequency?: DataConnectionFrequency;\n  /** The day to update the data connection on. (1-7 for weekly, 1-31 for monthly) */\n  frequencyOffset?: number;\n  kind: string;\n}\n\n/** Source entity used to drive discovery. */\nexport interface DiscoSource {\n  /**\n   * The kind of disco source.\n   *\n   * Possible values: \"as\", \"attribute\", \"contact\", \"domain\", \"host\", \"ipBlock\"\n   */\n  kind?: DiscoSourceKind;\n  /** The name for the disco source. */\n  name?: string;\n}\n\n/** A request body used to create a discovery group. */\nexport interface DiscoGroupData {\n  /** The name for a disco group. */\n  name?: string;\n  /** The description for a disco group. */\n  description?: string;\n  /** The tier for the disco group which will affect the algorithm used for the disco runs in this group. */\n  tier?: string;\n  /** The frequency at which the disco group is supposed to be rerun in milliseconds. */\n  frequencyMilliseconds?: number;\n  /** The list of seeds used for the disco group runs. */\n  seeds?: Array<DiscoSource>;\n  /** The list of names used for the disco group runs. */\n  names?: string[];\n  /** The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm. */\n  excludes?: Array<DiscoSource>;\n  /** The unique identifier for the disco template used for the disco group creation. */\n  templateId?: string;\n}\n\n/** A request body used to retrieve an asset report snapshot. */\nexport interface ReportAssetSnapshotRequest {\n  /** The metric to retrieve a snapshot for. */\n  metric?: string;\n  /** The name of the label to retrieve a snapshot for. */\n  labelName?: string;\n  /** The number of assets per page. */\n  size?: number;\n  /** The page to retrieve. */\n  page?: number;\n}\n\n/** A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories. */\nexport interface ReportAssetSummaryRequest {\n  /** Categories to retrieve risk reporting data for. */\n  metricCategories?: string[];\n  /** Metrics to retrieve risk reporting data for. */\n  metrics?: string[];\n  /** Query filters to apply to the asset summary. */\n  filters?: string[];\n  /** A parameter to group the assets by (first level facet field), only used when the chosen summary identifier is filters. */\n  groupBy?: string;\n  /** A parameter to segment the assets by (second level facet field), only used when the chosen summary identifier is filters. */\n  segmentBy?: string;\n  /** Currently unused. */\n  labelName?: string;\n}\n\n/** A request body used to create a saved filter. */\nexport interface SavedFilterData {\n  /** An expression on the resource type that selects the resources to be returned. */\n  filter: string;\n  /** A human readable description of the saved filter. */\n  description: string;\n}\n\nexport type DataConnectionData =\n  | DataConnectionDataParent\n  | LogAnalyticsDataConnectionData\n  | AzureDataExplorerDataConnectionData;\n/** Alias for AssetUpdateState */\nexport type AssetUpdateState = string;\n/** Alias for AssetUpdateTransfers */\nexport type AssetUpdateTransfers = string;\n/** Alias for DataConnectionContent */\nexport type DataConnectionContent = string;\n/** Alias for DataConnectionFrequency */\nexport type DataConnectionFrequency = string;\n/** Alias for DiscoSourceKind */\nexport type DiscoSourceKind = string;\n"]}