Skip to content

Add playbook configurations resource REST specification #5548

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.

Sign up for GitHub

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

Closed
mikreite wants to merge 13 commits into from
Closed

Add playbook configurations resource REST specification #5548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
daa2f3b
add playbook configurations resource REST specification
mikreite Apr 4, 2019
9e0ae57
fix according to PR comments + some spec changes
mikreite Apr 14, 2019
29ac581
add propertyType and operator enums
mikreite Apr 14, 2019
395f014
merge from upstream/master
mikreite Apr 21, 2019
bfde5d1
add 201 response to x-ms-example
mikreite Apr 21, 2019
e7c79f8
remove the unnecessary "value" from the Put example response
mikreite Apr 21, 2019
c3bbe3e
Merge remote-tracking branch 'upstream/master'
DFMSUser Apr 30, 2019
ca68b11
Updating with latest PR
DFMSUser May 7, 2019
837b66d
Fixing Example files
DFMSUser May 12, 2019
a08ee83
Adding descriminator and updating examples
DFMSUser May 13, 2019
7c02e45
Adding event hub action to playbook RP
nirwinter Aug 25, 2019
1ef02d3
merge from upstream/master
mikreite Aug 25, 2019
6728524
adding securityEmail action type
OmAbraAzure Sep 26, 2019
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
12 changes: 12 additions & 0 deletions ...19-01-01-preview/examples/PlaybookConfigurations/DeletePlaybookConfiguration_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "myRg",
"playbookConfigurationName": "myPlaybookConfigName"
},
"responses": {
"204": {
}
}
}
68 changes: 68 additions & 0 deletions ...review/examples/PlaybookConfigurations/GetPlaybookConfigurationResourceGroup_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "e4272367-5645-4c4e-9c67-3b74b59a6982",
"resourceGroupName": "exampleResourceGroup",
"playbookConfigurationName": "examplePlaybookConfiguration"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/playbookConfigurations/examplePlaybookConfiguration",
"name": "examplePlaybookConfiguration",
"type": "Microsoft.Security/playbookConfigurations",
"location": "Central US",
"tags": {},
"properties": {
"description": "An example of a playbook configuration that triggers two LogicApp resources (myTest1 and myTest2) on any security assessment of type customAssessment",
"isEnabled": true,
"metadata": {
"createdDateTimeUtc": "2019-03-27T08:43:54.5755094Z",
"createdBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72",
"lastUpdatedDateTimeUtc": "2019-03-28T08:43:54.5755094Z",
"lastUpdatedBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72"
},
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26"
},
{
"description": "A description that help to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "AscAssessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "string",
"expectedValue": "customAssessment",
"operator": "EqualsIgnoreCase"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "(This value contains a secret and will not be retrieved)"
},
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest2",
"actionType": "LogicApp",
"uri": "(This value contains a secret and will not be retrieved)"
}
]
}
}
}
}
}
71 changes: 71 additions & 0 deletions ...eview/examples/PlaybookConfigurations/GetPlaybookConfigurationsResourceGroup_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "e4272367-5645-4c4e-9c67-3b74b59a6982",
"resourceGroupName": "exampleResourceGroup"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/playbookConfigurations/examplePlaybookConfiguration",
"name": "examplePlaybookConfiguration",
"type": "Microsoft.Security/playbookConfigurations",
"location": "Central US",
"tags": {},
"properties": {
"description": "An example of a playbook configuration that triggers two LogicApp resources (myTest1 and myTest2) on any security assessment of type customAssessment",
"isEnabled": true,
"metadata": {
"createdDateTimeUtc": "2019-03-27T08:43:54.5755094Z",
"createdBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72",
"lastUpdatedDateTimeUtc": "2019-03-28T08:43:54.5755094Z",
"lastUpdatedBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72"
},
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26"
},
{
"description": "A description that help to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "AscAssessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "string",
"expectedValue": "customAssessment",
"operator": "EqualsIgnoreCase"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri1.com"
},
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest2",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri2.com"
}
]
}
}
]
}
}
}
}
70 changes: 70 additions & 0 deletions ...review/examples/PlaybookConfigurations/GetPlaybookConfigurationsSubscription_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "e4272367-5645-4c4e-9c67-3b74b59a6982"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/playbookConfigurations/examplePlaybookConfiguration",
"name": "examplePlaybookConfiguration",
"type": "Microsoft.Security/playbookConfigurations",
"location": "Central US",
"tags": {},
"properties": {
"description": "An example of a playbook configuration that triggers two LogicApp resources (myTest1 and myTest2) on any security assessment of type customAssessment",
"isEnabled": true,
"metadata": {
"createdDateTimeUtc": "2019-03-27T08:43:54.5755094Z",
"createdBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72",
"lastUpdatedDateTimeUtc": "2019-03-28T08:43:54.5755094Z",
"lastUpdatedBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72"
},
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26"
},
{
"description": "A description that help to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "AscAssessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "string",
"expectedValue": "customAssessment",
"operator": "EqualsIgnoreCase"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri1.com"
},
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest2",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri2.com"
}
]
}
}
]
}
}
}
}
122 changes: 122 additions & 0 deletions ...019-01-01-preview/examples/PlaybookConfigurations/PatchPlaybookConfiguration_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "e4272367-5645-4c4e-9c67-3b74b59a6982",
"playbookConfigurationName": "examplePlaybookConfiguration",
"resourceGroupName": "exampleResourceGroup",
"PlaybookConfiguration": {
"id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/playbookConfigurations/examplePlaybookConfiguration",
"name": "examplePlaybookConfiguration",
"type": "Microsoft.Security/playbookConfigurations",
"location": "Central US",
"tags": {
"ScenarioName" : "ExampleScenario"
},
"properties": {
"description": "An example of a playbook configuration that triggers two LogicApp resources (myTest1 and myTest2) on any security assessment of type customAssessment",
"isEnabled": true,
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26"
},
{
"description": "A description that help to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "AscAssessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "string",
"expectedValue": "customAssessment",
"operator": "EqualsIgnoreCase"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri1.com"
},
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest2",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri2.com"
}
]
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/playbookConfigurations/examplePlaybookConfiguration",
"name": "examplePlaybookConfiguration",
"type": "Microsoft.Security/playbookConfigurations",
"location": "Central US",
"tags": {
"ScenarioName" : "ExampleScenario"
},
"properties": {
"description": "An example of a playbook configuration that triggers two LogicApp resources (myTest1 and myTest2) on any security assessment of type customAssessment",
"isEnabled": true,
"metadata": {
"createdDateTimeUtc": "2019-03-27T08:43:54.5755094Z",
"createdBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72",
"lastUpdatedDateTimeUtc": "2019-03-28T08:43:54.5755094Z",
"lastUpdatedBy": "2c429ed8-089f-42aa-9bb9-92312b8c9f72"
},
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26"
},
{
"description": "A description that help to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription 212f9889-769e-45ae-ab43-6da33674bd26",
"scopePath": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "AscAssessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "string",
"expectedValue": "customAssessment",
"operator": "EqualsIgnoreCase"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "(This value contains a secret and will not be retrieved)"
},
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest2",
"actionType": "LogicApp",
"uri": "(This value contains a secret and will not be retrieved)"
}
]
}
}
}
}
}
Loading