[Hub Generated] Review request for Microsoft.Security to add version …

…preview/2021-07-01-preview (Azure#16455) * . * .
AzureSDKAutomation · Oct 20, 2021 · d5efa33 · d5efa33
1 parent ed12f54
commit d5efa33
Show file tree

Hide file tree

Showing 10 changed files with 233 additions and 18 deletions.
diff --git a/...rce-manager/Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json b/...rce-manager/Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json
@@ -275,6 +275,12 @@
       "type": "object",
       "description": "Custom Assessment Automation",
       "properties": {
+        "systemData": {
+          "readOnly": true,
+          "type": "object",
+          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
+          "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+        },
         "properties": {
           "x-ms-client-flatten": true,
           "description": "describes Custom Assessment Automation properties.",
@@ -287,6 +293,22 @@
         }
       ]
     },
+    "customAssessmentAutomationRequest": {
+      "type": "object",
+      "description": "Custom Assessment Automation request",
+      "properties": {
+        "properties": {
+          "x-ms-client-flatten": true,
+          "description": "describes Custom Assessment Automation request properties.",
+          "$ref": "#/definitions/customAssessmentAutomationRequestProperties"
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../common/v1/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "customAssessmentAutomationProperties": {
       "type": "object",
       "description": "describes the Custom Assessment Automation properties",
@@ -353,6 +375,82 @@
           "description": "The description to relate to the assessments generated by this assessment automation.",
           "type": "string"
         },
+        "remediationDescription": {
+          "description": "The remediation description to relate to the assessments generated by this assessment automation.",
+          "type": "string"
+        },
+        "assessmentKey": {
+          "description": "The assessment metadata key used when an assessment is generated for this assessment automation.",
+          "type": "string"
+        }
+      }
+    },
+    "customAssessmentAutomationRequestProperties": {
+      "type": "object",
+      "description": "describes the Custom Assessment Automation properties",
+      "properties": {
+        "compressedQuery": {
+          "description": "Base 64 encoded KQL query representing the assessment automation results required.",
+          "type": "string"
+        },
+        "supportedCloud": {
+          "description": "Relevant cloud for the custom assessment automation.",
+          "type": "string",
+          "enum": [
+            "AWS"
+          ],
+          "x-ms-enum": {
+            "name": "supportedCloudEnum",
+            "modelAsString": true
+          },
+          "x-ms-client-default": "AWS"
+        },
+        "severity": {
+          "description": "The severity to relate to the assessments generated by this assessment automation.",
+          "type": "string",
+          "enum": [
+            "High",
+            "Medium",
+            "Low"
+          ],
+          "x-ms-enum": {
+            "name": "severityEnum",
+            "modelAsString": true
+          },
+          "x-ms-client-default": "Low"
+        },
+        "userImpact": {
+          "description": "The user impact to relate to the assessments generated by this assessment automation.",
+          "type": "string",
+          "enum": [
+            "High",
+            "Moderate",
+            "Low"
+          ],
+          "x-ms-enum": {
+            "name": "userImpactEnum",
+            "modelAsString": true
+          },
+          "x-ms-client-default": "Low"
+        },
+        "implementationEffort": {
+          "description": "The implementation effort to relate to the assessments generated by this assessment automation.",
+          "type": "string",
+          "enum": [
+            "High",
+            "Moderate",
+            "Low"
+          ],
+          "x-ms-enum": {
+            "name": "implementationEffortEnum",
+            "modelAsString": true
+          },
+          "x-ms-client-default": "Low"
+        },
+        "description": {
+          "description": "The description to relate to the assessments generated by this assessment automation.",
+          "type": "string"
+        },
         "remediationDescription": {
           "description": "The remediation description to relate to the assessments generated by this assessment automation.",
           "type": "string"
@@ -375,7 +473,7 @@
       "description": "Custom Assessment Automation body",
       "required": true,
       "schema": {
-        "$ref": "#/definitions/customAssessmentAutomation"
+        "$ref": "#/definitions/customAssessmentAutomationRequest"
       },
       "x-ms-parameter-location": "method"
     }

diff --git a/...ce-manager/Microsoft.Security/preview/2021-07-01-preview/customEntityStoreAssignment.json b/...ce-manager/Microsoft.Security/preview/2021-07-01-preview/customEntityStoreAssignment.json
@@ -275,6 +275,12 @@
       "type": "object",
       "description": "Custom entity store assignment",
       "properties": {
+        "systemData": {
+          "readOnly": true,
+          "type": "object",
+          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
+          "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+        },
         "properties": {
           "x-ms-client-flatten": true,
           "description": "describes custom entity store assignment properties.",

diff --git a/...review/examples/CustomAssessmentAutomations/customAssessmentAutomationCreate_example.json b/...review/examples/CustomAssessmentAutomations/customAssessmentAutomationCreate_example.json
@@ -22,14 +22,23 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/33e7cc6e-a139-4723-a0e5-76993aee0771",
         "name": "33e7cc6e-a139-4723-a0e5-76993aee0771",
         "type": "Microsoft.Security/customAssessmentAutomations",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:47:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+        },
         "properties": {
-          "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=",
+          "compressedQuery": "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
           "supportedCloud": "AWS",
           "severity": "Medium",
           "userImpact": "Moderate",
           "implementationEffort": "High",
-          "description": "Data should be encrypted",
-          "remediationDescription": "Encrypt store by..."
+          "description": "organization passwords policy",
+          "remediationDescription": "Change password policy to...",
+          "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb"
         }
       }
     },
@@ -38,14 +47,23 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/33e7cc6e-a139-4723-a0e5-76993aee0771",
         "name": "33e7cc6e-a139-4723-a0e5-76993aee0771",
         "type": "Microsoft.Security/customAssessmentAutomations",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:01:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:01:50.328Z"
+        },
         "properties": {
-          "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=",
+          "compressedQuery": "DQAKAEkAYQBtAF8AUABhAHMAcwB3AG8AcgBkAFAAbwBsAGkAYwB5ACAADQAKAHwAIABlAHgAdABlAG4AZAAgAEgAZQBhAGwAdABoAFMAdABhAHQAdQBzACAAPQAgAGkAZgBmACgAdABvAGkAbgB0ACgAUgBlAGMAbwByAGQALgBNAGkAbgBpAG0AdQBtAFAAYQBzAHMAdwBvAHIAZABMAGUAbgBnAHQAaAApACAAPAAgADgALAAgACcAVQBOAEgARQBBAEwAVABIAFkAJwAsACAAJwBIAEUAQQBMAFQASABZACcAKQANAAoA",
           "supportedCloud": "AWS",
           "severity": "Medium",
           "userImpact": "Moderate",
           "implementationEffort": "High",
           "description": "Data should be encrypted",
-          "remediationDescription": "Encrypt store by..."
+          "remediationDescription": "Encrypt store by...",
+          "assessmentKey": "fc1dbcd0-502c-4eab-9312-4014cfc8ea56"
         }
       }
     }

diff --git a/...1-preview/examples/CustomAssessmentAutomations/customAssessmentAutomationGet_example.json b/...1-preview/examples/CustomAssessmentAutomations/customAssessmentAutomationGet_example.json
@@ -11,14 +11,23 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/MyCustomAssessmentAutomation",
         "name": "MyCustomAssessmentAutomation",
         "type": "Microsoft.Security/customAssessmentAutomations",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:47:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+        },
         "properties": {
-          "compressedQuery": "H4sIAAAAAAAAAwvIz8lMrgzKz0nlqlFIrShJzUtR8Cz2SE3MKcmoVLBVUE9LzClOVQcA1IFnficAAAA=",
+          "compressedQuery": "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
           "supportedCloud": "AWS",
           "severity": "Low",
           "userImpact": "Low",
           "implementationEffort": "Low",
           "description": "organization passwords policy",
-          "remediationDescription": "Change password policy to..."
+          "remediationDescription": "Change password policy to...",
+          "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb"
         }
       }
     }

diff --git a/...es/CustomAssessmentAutomations/customAssessmentAutomationListByResourceGroup_example.json b/...es/CustomAssessmentAutomations/customAssessmentAutomationListByResourceGroup_example.json
@@ -12,28 +12,46 @@
             "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/MyCustomAssessmentAutomation1",
             "name": "MyCustomAssessmentAutomation1",
             "type": "Microsoft.Security/customAssessmentAutomations",
+            "systemData": {
+              "createdBy": "[email protected]",
+              "createdByType": "User",
+              "createdAt": "2021-08-31T13:47:50.328Z",
+              "lastModifiedBy": "[email protected]",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+            },
             "properties": {
-              "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=",
+              "compressedQuery": "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
               "supportedCloud": "AWS",
               "severity": "Medium",
               "userImpact": "Moderate",
               "implementationEffort": "High",
-              "description": "Data should be encrypted",
-              "remediationDescription": "Encrypt store by..."
+              "description": "organization passwords policy",
+              "remediationDescription": "Change password policy to...",
+              "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb"
             }
           },
           {
             "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/MyCustomAssessmentAutomation2",
             "name": "MyCustomAssessmentAutomation2",
             "type": "Microsoft.Security/customAssessmentAutomations",
+            "systemData": {
+              "createdBy": "[email protected]",
+              "createdByType": "User",
+              "createdAt": "2021-08-31T13:01:50.328Z",
+              "lastModifiedBy": "[email protected]",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2021-08-31T13:01:50.328Z"
+            },
             "properties": {
-              "compressedQuery": "H4sIAAAAAAAAAwvIz8lMrgzKz0nlqlFIrShJzUtR8Cz2SE3MKcmoVLBVUE9LzClOVQcA1IFnficAAAA=",
+              "compressedQuery": "DQAKAEkAYQBtAF8AUABhAHMAcwB3AG8AcgBkAFAAbwBsAGkAYwB5ACAADQAKAHwAIABlAHgAdABlAG4AZAAgAEgAZQBhAGwAdABoAFMAdABhAHQAdQBzACAAPQAgAGkAZgBmACgAdABvAGkAbgB0ACgAUgBlAGMAbwByAGQALgBNAGkAbgBpAG0AdQBtAFAAYQBzAHMAdwBvAHIAZABMAGUAbgBnAHQAaAApACAAPAAgADgALAAgACcAVQBOAEgARQBBAEwAVABIAFkAJwAsACAAJwBIAEUAQQBMAFQASABZACcAKQANAAoA",
               "supportedCloud": "AWS",
               "severity": "Low",
               "userImpact": "Low",
               "implementationEffort": "Low",
               "description": "organization passwords policy",
-              "remediationDescription": "Change password policy to..."
+              "remediationDescription": "Change password policy to...",
+              "assessmentKey": "fc1dbcd0-502c-4eab-9312-4014cfc8ea56"
             }
           }
         ],

diff --git a/...les/CustomAssessmentAutomations/customAssessmentAutomationListBySubscription_example.json b/...les/CustomAssessmentAutomations/customAssessmentAutomationListBySubscription_example.json
@@ -11,28 +11,46 @@
             "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/MyCustomAssessmentAutomation1",
             "name": "MyCustomAssessmentAutomation1",
             "type": "Microsoft.Security/customAssessmentAutomations",
+            "systemData": {
+              "createdBy": "[email protected]",
+              "createdByType": "User",
+              "createdAt": "2021-08-31T13:47:50.328Z",
+              "lastModifiedBy": "[email protected]",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+            },
             "properties": {
-              "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=",
+              "compressedQuery": "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
               "supportedCloud": "AWS",
               "severity": "Medium",
               "userImpact": "Moderate",
               "implementationEffort": "High",
-              "description": "Data should be encrypted",
-              "remediationDescription": "Encrypt store by..."
+              "description": "organization passwords policy",
+              "remediationDescription": "Change password policy to...",
+              "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb"
             }
           },
           {
             "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/MyCustomAssessmentAutomation2",
             "name": "MyCustomAssessmentAutomation2",
             "type": "Microsoft.Security/customAssessmentAutomations",
+            "systemData": {
+              "createdBy": "[email protected]",
+              "createdByType": "User",
+              "createdAt": "2021-08-31T13:01:50.328Z",
+              "lastModifiedBy": "[email protected]",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2021-08-31T13:01:50.328Z"
+            },
             "properties": {
-              "compressedQuery": "H4sIAAAAAAAAAwvIz8lMrgzKz0nlqlFIrShJzUtR8Cz2SE3MKcmoVLBVUE9LzClOVQcA1IFnficAAAA=",
+              "compressedQuery": "DQAKAEkAYQBtAF8AUABhAHMAcwB3AG8AcgBkAFAAbwBsAGkAYwB5ACAADQAKAHwAIABlAHgAdABlAG4AZAAgAEgAZQBhAGwAdABoAFMAdABhAHQAdQBzACAAPQAgAGkAZgBmACgAdABvAGkAbgB0ACgAUgBlAGMAbwByAGQALgBNAGkAbgBpAG0AdQBtAFAAYQBzAHMAdwBvAHIAZABMAGUAbgBnAHQAaAApACAAPAAgADgALAAgACcAVQBOAEgARQBBAEwAVABIAFkAJwAsACAAJwBIAEUAQQBMAFQASABZACcAKQANAAoA",
               "supportedCloud": "AWS",
               "severity": "Low",
               "userImpact": "Low",
               "implementationEffort": "Low",
               "description": "organization passwords policy",
-              "remediationDescription": "Change password policy to..."
+              "remediationDescription": "Change password policy to...",
+              "assessmentKey": "fc1dbcd0-502c-4eab-9312-4014cfc8ea56"
             }
           }
         ],

diff --git a/...view/examples/CustomEntityStoreAssignments/customEntityStoreAssignmentCreate_example.json b/...view/examples/CustomEntityStoreAssignments/customEntityStoreAssignmentCreate_example.json
@@ -16,6 +16,14 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customEntityStoreAssignments/33e7cc6e-a139-4723-a0e5-76993aee0771",
         "name": "33e7cc6e-a139-4723-a0e5-76993aee0771",
         "type": "Microsoft.Security/customEntityStoreAssignments",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:47:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+        },
         "properties": {
           "principal": "aaduser=f3923a3e-ad57-4752-b1a9-fbf3c8e5e082;72f988bf-86f1-41af-91ab-2d7cd011db47",
           "entityStoreDatabaseLink": "https://dataexplorer.azure.com/clusters/securitydatastore.centralus/databases/DiscoveryAwsKedamari?query=H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA="
@@ -27,6 +35,14 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customEntityStoreAssignments/33e7cc6e-a139-4723-a0e5-76993aee0771",
         "name": "33e7cc6e-a139-4723-a0e5-76993aee0771",
         "type": "Microsoft.Security/customEntityStoreAssignments",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:01:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:01:50.328Z"
+        },
         "properties": {
           "principal": "aaduser=f3923a3e-ad57-4752-b1a9-fbf3c8e5e082;72f988bf-86f1-41af-91ab-2d7cd011db47",
           "entityStoreDatabaseLink": "https://dataexplorer.azure.com/clusters/securitydatastore.centralus/databases/DiscoveryAwsKedamari?query=H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA="

diff --git a/...preview/examples/CustomEntityStoreAssignments/customEntityStoreAssignmentGet_example.json b/...preview/examples/CustomEntityStoreAssignments/customEntityStoreAssignmentGet_example.json
@@ -11,6 +11,14 @@
         "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customEntityStoreAssignments/33e7cc6e-a139-4723-a0e5-76993aee0771",
         "name": "33e7cc6e-a139-4723-a0e5-76993aee0771",
         "type": "Microsoft.Security/customEntityStoreAssignments",
+        "systemData": {
+          "createdBy": "[email protected]",
+          "createdByType": "User",
+          "createdAt": "2021-08-31T13:47:50.328Z",
+          "lastModifiedBy": "[email protected]",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-08-31T13:47:50.328Z"
+        },
         "properties": {
           "principal": "aaduser=f3923a3e-ad57-4752-b1a9-fbf3c8e5e082;72f988bf-86f1-41af-91ab-2d7cd011db47",
           "entityStoreDatabaseLink": "https://dataexplorer.azure.com/clusters/securitydatastore.centralus/databases/DiscoveryAwsKedamari?query=H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA="