Skip to content

Latest commit

 

History

History
228 lines (178 loc) · 10.1 KB

readme.md

File metadata and controls

228 lines (178 loc) · 10.1 KB
Raw

Security Insight

see https://aka.ms/autorest

This is the AutoRest configuration file for SecurityInsights.

Getting Started

To build the SDK for SecurityInsights, simply Install AutoRest and in this folder, run:

autorest

To see additional help and options, run:

autorest --help

Configuration

Basic Information

These are the global settings for the SecurityInsights API.

openapi-type: arm
tag: package-2020-01

Tag: package-2021-04-01-only

These settings apply only when --tag=package-2021-04-01-only is specified on the command line.

input-file:
- Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json
- Microsoft.SecurityInsights/stable/2021-04-01/operations.json
- Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json
directive:
  - suppress: R4017
    from: Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json
    where: $.definitions.Incidents
    reason: The Incident does not support list by subscription. It's not a top-level resource. To get the Incident, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json
    where: $.definitions.Watchlist
    reason: The Watchlist does not support list by subscription. It's not a top-level resource. To get the Watchlist, we should have a subscription as well as a resource group and Log Analytics workspace.

Tag: package-2020-01

These settings apply only when --tag=package-2020-01 is specified on the command line.

input-file:
- Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json
- Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json
- Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json
- Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json

directive:
  - suppress: R2059
    from: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json
    reason: it's not actually a resource path; the validator is confused because the LogAnalytics namespace is in the URI path.
    approved-by: "@lirenhe"

Tag: package-2021-03-preview-only

These settings apply only when --tag=package-2021-03-preview-only is specified on the command line.

input-file:
- Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json
- Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json
directive:
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
    where: $.definitions.Settings
    reason: The Setting does not support list by subscription. It's not a top-level resource. To get the Setting, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json
    where: $.definitions.DataConnector
    reason: The DataConnector does not support list by subscription. It's not a top-level resource.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json
    where: $.definitions.Watchlist
    reason: The Watchlist does not support list by subscription. It's not a top-level resource. To get the Watchlist, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json
    where: $.definitions.SourceControl
    reason: The sourceControl does not support list by subscription. It's not a top-level resource. 
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json
    where: $.definitions.SentinelOnboardingState
    reason: The SentinelOnboardingState does not support list by subscription. It's not a top-level resource. To get the SentinelOnboardingState, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json
    where: $.definitions.Incidents
    reason: The Incidents does not support list by subscription. It's not a top-level resource. To get the Incidents, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json
    where: $.definitions.Incident
    reason: The Incident does not support list by subscription. It's not a top-level resource. To get the Incident, we should have a subscription as well as a resource group, Log Analytics workspace and incident ID.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json
    where: $.definitions.AlertRule
    reason: The AlertRule does not support list by subscription. It's not a top-level resource. To get the AlertRule, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json
    where: $.definitions.AlertRuleTemplate
    reason: The AlertRuleTemplate does not support list by subscription. It's not a top-level resource. To get the AlertRuleTemplate, we should have a subscription as well as a resource group and Log Analytics workspace.  
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json
    where: $.definitions.EntityQuery
    reason: The EntityQuery does not support list by subscription. It's not a top-level resource. To get the EntityQuery, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json
    where: $.definitions.MetadataModel
    reason: Metadata does not support list by subscription. It's not a top-level resource. To get a Metadata list, we should have a subscription as well as a resource group and Log Analytics workspace.

Tag: package-2019-01-preview

These settings apply only when --tag=package-2019-01-preview is specified on the command line.

input-file:
- Microsoft.SecurityInsights/preview/2019-01-01-preview/Aggregations.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
- Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json
directive:
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
    where: $.definitions.ThreatIntelligenceResource
    reason: Our API is designed based on per region per workspace concept. There is no use case of our customers to get all indicators in multiple workspaces.
    approved-by: "@cheggert"
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
    where: $.definitions.Watchlist
    reason: The Watchlist does not support list by subscription. It's not a top-level resource. To get the Watchlist, we should have a subscription as well as a resource group and Log Analytics workspace. 
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
    where: $.definitions.AutomationRule
    reason: The AutomationRule does not support list by subscription. It's not a top-level resource. To get the AutomationRule, we should have a subscription as well as a resource group and Log Analytics workspace.
  - suppress: R4017
    from: Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json
    where: $.definitions.AutomationRule
    reason: The AutomationRule does not support list by subscription. It's not a top-level resource. To get the AutomationRule, we should have a subscription as well as a resource group and Log Analytics workspace.

Code Generation

Swagger to SDK

This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself.

swagger-to-sdk:
  - repo: azure-sdk-for-net
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-python-track2
  - repo: azure-sdk-for-js
  - repo: azure-sdk-for-node
  - repo: azure-cli-extensions
  - repo: azure-resource-manager-schemas

C#

These settings apply only when --csharp is specified on the command line. Please also specify --csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>.

csharp:
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.SecurityInsights
  payload-flattening-threshold: 2
  output-folder: $(csharp-sdks-folder)/securityinsights/Microsoft.Azure.Management.SecurityInsights/src/Generated
  clear-output-folder: true

Go

See configuration in readme.go.md

Python

See configuration in readme.python.md

Node.js

See configuration in readme.nodejs.md

TypeScript

See configuration in readme.typescript.md