Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
{
"swagger": "2.0",
"info": {
"title": "Security Insights",
"description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider",
"version": "2021-10-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}": {
"get": {
"x-ms-examples": {
"Get Sentinel onboarding state": {
"$ref": "./examples/onboardingStates/GetSentinelOnboardingState.json"
}
},
"tags": [
"SentinelOnboardingStates"
],
"description": "Get Sentinel onboarding state",
"operationId": "SentinelOnboardingStates_Get",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/SentinelOnboardingStateName"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SentinelOnboardingState"
}
},
"default": {
"description": "Error in getting the Sentinel onboarding state",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"x-ms-examples": {
"Create Sentinel onboarding state": {
"$ref": "./examples/onboardingStates/CreateSentinelOnboardingState.json"
}
},
"tags": [
"SentinelOnboardingStates"
],
"description": "Create Sentinel onboarding state",
"operationId": "SentinelOnboardingStates_Create",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/SentinelOnboardingStateName"
},
{
"$ref": "#/parameters/SentinelOnboardingStateParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SentinelOnboardingState"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/SentinelOnboardingState"
}
},
"default": {
"description": "Error in creating the Sentinel onboarding state",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"x-ms-examples": {
"Delete Sentinel onboarding state": {
"$ref": "./examples/onboardingStates/DeleteSentinelOnboardingState.json"
}
},
"tags": [
"SentinelOnboardingStates"
],
"description": "Delete Sentinel onboarding state",
"operationId": "SentinelOnboardingStates_Delete",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/SentinelOnboardingStateName"
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error in deleting the Sentinel onboarding state",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates": {
"get": {
"x-ms-examples": {
"Get all Sentinel onboarding states": {
"$ref": "./examples/onboardingStates/GetAllSentinelOnboardingStates.json"
}
},
"tags": [
"SentinelOnboardingStates"
],
"description": "Gets all Sentinel onboarding states",
"operationId": "SentinelOnboardingStates_List",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SentinelOnboardingStatesList"
}
},
"default": {
"description": "Error in listing the Sentinel onboarding states",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"SentinelOnboardingStateProperties": {
"description": "The Sentinel onboarding state properties",
"type": "object",
"properties": {
"customerManagedKey": {
"description": "Flag that indicates the status of the CMK setting",
"type": "boolean"
}
}
},
"SentinelOnboardingState": {
"allOf": [
{
"$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag"
}
],
"description": "Sentinel onboarding state",
"properties": {
"properties": {
"$ref": "#/definitions/SentinelOnboardingStateProperties",
"description": "The Sentinel onboarding state object",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SentinelOnboardingStatesList": {
"description": "List of the Sentinel onboarding states",
"properties": {
"value": {
"description": "Array of Sentinel onboarding states",
"items": {
"$ref": "#/definitions/SentinelOnboardingState"
},
"type": "array"
}
},
"type": "object",
"required": [
"value"
]
}
},
"parameters": {
Comment thread
laithhisham marked this conversation as resolved.
"SentinelOnboardingStateName": {
"description": "The Sentinel onboarding state name. Supports - default",
"in": "path",
"name": "sentinelOnboardingStateName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SentinelOnboardingStateParameter": {
"description": "The Sentinel onboarding state parameter",
"in": "body",
"name": "sentinelOnboardingStateParameter",
"required": false,
"schema": {
"$ref": "#/definitions/SentinelOnboardingState"
},
"x-ms-parameter-location": "method"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"sentinelOnboardingStateName": "default",
"sentinelOnboardingStateParameter": {
"properties": {
"customerManagedKey": false
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
"name": "default",
"type": "Microsoft.SecurityInsights/onboardingStates",
"properties": {
"customerManagedKey": false
}
}
},
"201": {
"body": {
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
"name": "default",
"type": "Microsoft.SecurityInsights/onboardingStates",
"properties": {
"customerManagedKey": false
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"sentinelOnboardingStateName": "default"
},
"responses": {
"200": {},
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
"name": "default",
"type": "Microsoft.SecurityInsights/onboardingStates",
"properties": {
"customerManagedKey": false
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"sentinelOnboardingStateName": "default"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
"name": "default",
"type": "Microsoft.SecurityInsights/onboardingStates",
"properties": {
"customerManagedKey": false
}
}
}
}
}
1 change: 1 addition & 0 deletions specification/securityinsights/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ input-file:
- Microsoft.SecurityInsights/stable/2021-10-01/ThreatIntelligence.json
- Microsoft.SecurityInsights/stable/2021-10-01/Watchlists.json
- Microsoft.SecurityInsights/stable/2021-10-01/operations.json
- Microsoft.SecurityInsights/stable/2021-10-01/OnboardingStates.json
- Microsoft.SecurityInsights/stable/2021-10-01/AlertRules.json
```

Expand Down