-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.SecurityInsights to add onboarding states resource type to preview/2021-03-01-preview #13779
Merged
ruowan
merged 20 commits into
Azure:master
from
laithhisham:dev-securityinsights-Microsoft.SecurityInsights-2021-03-01-preview
May 5, 2021
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
1e5c20f
Add Sentinel onboarding states resource type
laithhisham 4bd78ac
Fix param name
laithhisham c1aed98
Fix Avocado
laithhisham ee76cda
Fix spell check
laithhisham 744997d
Fix prettier
laithhisham f8a0b94
Fix LintDiff
laithhisham 07d08bf
Fix lintDiff 2
laithhisham b5c6388
Fix lintDiff 3
laithhisham 5860ff3
Fix lintDiff 4
laithhisham 7bde37d
Fix lintDiff 5
laithhisham c19053d
Fix lintDiff 6
laithhisham b0805d1
Fix lintDiff 7
laithhisham 0c306fe
Fix lintDiff 8
laithhisham 47b2fac
Fix prettier
laithhisham 0f9e129
Rename onboarding state properties
laithhisham 3fe0ff6
Add GetAll
laithhisham e6db17d
Fix example file name
laithhisham 06e0124
Fix incorrect cloud error ref
laithhisham 58f5030
Fix GetAll example
laithhisham dfb1098
merged master
laithhisham File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
332 changes: 332 additions & 0 deletions
332
...ource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,332 @@ | ||
{ | ||
"swagger": "2.0", | ||
"info": { | ||
"title": "Security Insights", | ||
"description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", | ||
"version": "2021-03-01-preview" | ||
}, | ||
"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/{operationalInsightsResourceProvider}/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/v2/types.json#/parameters/ApiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.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/1.0/types.json#/definitions/CloudError" | ||
} | ||
} | ||
} | ||
}, | ||
"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/v2/types.json#/parameters/ApiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.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/1.0/types.json#/definitions/CloudError" | ||
} | ||
} | ||
} | ||
}, | ||
"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/v2/types.json#/parameters/ApiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.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/1.0/types.json#/definitions/CloudError" | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/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/v2/types.json#/parameters/ApiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" | ||
}, | ||
{ | ||
"$ref": "../../../common/1.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/1.0/types.json#/definitions/CloudError" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"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/1.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" | ||
} | ||
}, | ||
"required": [ | ||
"value" | ||
] | ||
} | ||
}, | ||
"parameters": { | ||
"SubscriptionId": { | ||
"description": "Azure subscription ID", | ||
"in": "path", | ||
"name": "subscriptionId", | ||
"pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", | ||
"required": true, | ||
"type": "string" | ||
}, | ||
"ResourceGroupName": { | ||
"description": "The name of the resource group within the user's subscription. The name is case insensitive.", | ||
"in": "path", | ||
"maxLength": 90, | ||
"minLength": 1, | ||
"name": "resourceGroupName", | ||
"pattern": "^[-\\w\\._\\(\\)]+$", | ||
"required": true, | ||
"type": "string", | ||
"x-ms-parameter-location": "method" | ||
}, | ||
"WorkspaceName": { | ||
"description": "The name of the workspace.", | ||
"in": "path", | ||
"name": "workspaceName", | ||
"maxLength": 90, | ||
"minLength": 1, | ||
"required": true, | ||
"type": "string", | ||
"x-ms-parameter-location": "method" | ||
}, | ||
"OperationalInsightsResourceProvider": { | ||
"description": "The namespace of workspaces resource provider- Microsoft.OperationalInsights.", | ||
"in": "path", | ||
"name": "operationalInsightsResourceProvider", | ||
"required": true, | ||
"type": "string", | ||
"x-ms-parameter-location": "method" | ||
}, | ||
"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" | ||
} | ||
} | ||
} |
37 changes: 37 additions & 0 deletions
37
...s/preview/2021-03-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"parameters": { | ||
"api-version": "2021-03-01-preview", | ||
"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.OperationalIinsights/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.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", | ||
"name": "default", | ||
"type": "Microsoft.SecurityInsights/onboardingStates", | ||
"properties": { | ||
"customerManagedKey": false | ||
} | ||
} | ||
} | ||
} | ||
} |
14 changes: 14 additions & 0 deletions
14
...s/preview/2021-03-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"parameters": { | ||
"api-version": "2021-03-01-preview", | ||
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", | ||
"resourceGroupName": "myRg", | ||
"workspaceName": "myWorkspace", | ||
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights", | ||
"sentinelOnboardingStateName": "default" | ||
}, | ||
"responses": { | ||
"200": {}, | ||
"204": {} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks fine to me, but requires signoff from breaking change team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @zcxcasd
Do we need to tag anyone to have a look?