Release appcomplianceautomation microsoft.app compliance automation 2…

…022 11 16 preview resolve comments 2 (#21152) * fix comments * remove duplicate in body * resolve comments * edit examples to match schema * fix failure * fix model validation * change passed to passedCount * add x-ms-enum to isPass * change delete 200 description Co-authored-by: Yanwen Liu <[email protected]>
Azure · Oct 18, 2022 · e79f699 · e79f699
1 parent 137bc8b
commit e79f699
Show file tree

Hide file tree

Showing 12 changed files with 122 additions and 161 deletions.
diff --git a/...Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/appcomplianceautomation.json b/...Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/appcomplianceautomation.json
@@ -34,52 +34,6 @@
     }
   },
   "paths": {
-    "/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}": {
-      "get": {
-        "tags": [
-          "AppComplianceAutomation"
-        ],
-        "description": "Query the ongoing operation status.",
-        "operationId": "OperationResults_Get",
-        "produces": [
-          "application/json"
-        ],
-        "parameters": [
-          {
-            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
-          },
-          {
-            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK. The request has succeeded."
-          },
-          "202": {
-            "description": "Accepted. The request is still running."
-          },
-          "204": {
-            "description": "No Content. For Delete operation results."
-          },
-          "default": {
-            "description": "Error response.",
-            "schema": {
-              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
-            }
-          }
-        },
-        "x-ms-long-running-operation": true,
-        "x-ms-long-running-operation-options": {
-          "final-state-via": "azure-async-operation"
-        },
-        "x-ms-examples": {
-          "OperationResults_Get": {
-            "$ref": "./examples/OperationResults_Get.json"
-          }
-        }
-      }
-    },
     "/providers/Microsoft.AppComplianceAutomation/operations": {
       "get": {
         "tags": [
@@ -124,7 +78,7 @@
         "tags": [
           "AppComplianceAutomation"
         ],
-        "description": "Get the AppComplianceAutomation report list.",
+        "description": "Get the AppComplianceAutomation report list for the tenant.",
         "operationId": "Reports_List",
         "parameters": [
           {
@@ -288,11 +242,8 @@
               "$ref": "#/definitions/ReportResource"
             }
           },
-          "201": {
-            "description": "Long running operation support.",
-            "schema": {
-              "$ref": "#/definitions/ReportResource"
-            }
+          "202": {
+            "description": "Long running operation support."
           },
           "default": {
             "description": "Error response.",
@@ -327,7 +278,7 @@
         ],
         "responses": {
           "200": {
-            "description": "Success. The response indicates the resource is already deleted."
+            "description": "Success. The response indicates the resource has been deleted."
           },
           "202": {
             "description": "Accepted. The response indicates the delete operation is performed in the background."
@@ -464,13 +415,13 @@
             "$ref": "#/parameters/SnapshotNameParameter"
           },
           {
-            "$ref": "#/parameters/ReportCreatorTenantIdParameter"
-          },
-          {
-            "$ref": "#/parameters/DownloadTypeParameter"
-          },
-          {
-            "$ref": "#/parameters/OfferGuidParameter"
+            "name": "parameters",
+            "in": "body",
+            "description": "Parameters for the query operation",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/SnapshotDownloadRequest"
+            }
           }
         ],
         "responses": {
@@ -516,17 +467,17 @@
       "description": "The overview of the compliance result for one report.",
       "type": "object",
       "properties": {
-        "passed": {
+        "passedCount": {
           "format": "int32",
           "type": "integer",
           "description": "The count of all passed full automation control."
         },
-        "failed": {
+        "failedCount": {
           "format": "int32",
           "type": "integer",
           "description": "The count of all failed full automation control."
         },
-        "manual": {
+        "manualCount": {
           "format": "int32",
           "type": "integer",
           "description": "The count of all manual control."
@@ -835,9 +786,17 @@
           "readOnly": true
         },
         "isPass": {
-          "type": "boolean",
+          "type": "string",
+          "enum": [
+            "True",
+            "False"
+          ],
           "readOnly": true,
-          "description": "Indicates whether all the resource(s) are compliant."
+          "description": "Indicates whether all the resource(s) are compliant.",
+          "x-ms-enum": {
+            "name": "IsPass",
+            "modelAsString": true
+          }
         },
         "policyId": {
           "description": "The policy id mapping to this assessment.",
@@ -1026,6 +985,50 @@
         }
       }
     },
+    "SnapshotDownloadRequest": {
+      "type": "object",
+      "description": "Snapshot's download request.",
+      "properties": {
+        "properties": {
+          "description": "Snapshot's download properties",
+          "$ref": "#/definitions/SnapshotDownloadProperties"
+        }
+      }
+    },
+    "SnapshotDownloadProperties": {
+      "type": "object",
+      "description": "Snapshot's download query properties.",
+      "required": [
+        "downloadType"
+      ],
+      "properties": {
+        "reportCreatorTenantId": {
+          "description": "Tenant id.",
+          "type": "string"
+        },
+        "downloadType": {
+          "description": "Indicates the download type.",
+          "x-ms-parameter-location": "method",
+          "enum": [
+            "ComplianceReport",
+            "CompliancePdfReport",
+            "ComplianceDetailedPdfReport",
+            "ResourceList"
+          ],
+          "type": "string",
+          "x-ms-enum": {
+            "name": "DownloadType",
+            "modelAsString": true
+          }
+        },
+        "offerGuid": {
+          "type": "string",
+          "description": "The offerGuid which mapping to the reports.",
+          "x-ms-parameter-location": "method",
+          "minLength": 1
+        }
+      }
+    },
     "SnapshotProperties": {
       "type": "object",
       "description": "Snapshot's properties.",
@@ -1180,7 +1183,8 @@
             "sasUri": {
               "description": "uri of compliance pdf report",
               "type": "string",
-              "readOnly": true
+              "readOnly": true,
+              "x-ms-secret": false
             }
           }
         },

diff --git a/...oft.AppComplianceAutomation/preview/2022-11-16-preview/examples/OperationResults_Get.json b/...oft.AppComplianceAutomation/preview/2022-11-16-preview/examples/OperationResults_Get.json
diff --git a/...ft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_CreateOrUpdate.json b/...ft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_CreateOrUpdate.json
@@ -48,9 +48,9 @@
           "provisioningState": "Succeeded",
           "complianceStatus": {
             "m365": {
-              "passed": 0,
-              "failed": 0,
-              "manual": 0
+              "passedCount": 0,
+              "failedCount": 0,
+              "manualCount": 0
             }
           }
         },
@@ -92,9 +92,9 @@
           ],
           "complianceStatus": {
             "m365": {
-              "passed": 0,
-              "failed": 0,
-              "manual": 0
+              "passedCount": 0,
+              "failedCount": 0,
+              "manualCount": 0
             }
           },
           "provisioningState": "Succeeded"

diff --git a/...ger/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Get.json b/...ger/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Get.json
@@ -32,9 +32,9 @@
           ],
           "complianceStatus": {
             "m365": {
-              "passed": 0,
-              "failed": 0,
-              "manual": 0
+              "passedCount": 0,
+              "failedCount": 0,
+              "manualCount": 0
             }
           },
           "provisioningState": "Succeeded"

diff --git a/.../Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Update.json b/.../Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Update.json
@@ -47,9 +47,9 @@
           ],
           "complianceStatus": {
             "m365": {
-              "passed": 0,
-              "failed": 0,
-              "manual": 0
+              "passedCount": 0,
+              "failedCount": 0,
+              "manualCount": 0
             }
           },
           "provisioningState": "Succeeded"
@@ -64,50 +64,7 @@
         }
       }
     },
-    "201": {
-      "body": {
-        "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName",
-        "name": "testReportName",
-        "type": "Microsfot.AppComplianceAutomation/reports",
-        "properties": {
-          "id": "00000000-0000-0000-0000-000000000000",
-          "status": "Active",
-          "tenantId": "00000000-0000-0000-0000-000000000000",
-          "reportName": "testReportName",
-          "offerGuid": "00000000-0000-0000-0000-000000000000",
-          "timeZone": "GMT Standard Time",
-          "triggerTime": "2022-03-02T05:17:23.922Z",
-          "nextTriggerTime": "2022-03-02T05:17:23.922Z",
-          "lastTriggerTime": "2022-03-02T05:17:23.922Z",
-          "subscriptions": [
-            "00000000-0000-0000-0000-000000000000"
-          ],
-          "resources": [
-            {
-              "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
-              "tags": {
-                "key1": "value1"
-              }
-            }
-          ],
-          "complianceStatus": {
-            "m365": {
-              "passed": 0,
-              "failed": 0,
-              "manual": 0
-            }
-          },
-          "provisioningState": "Succeeded"
-        },
-        "systemData": {
-          "createdBy": "00000000-0000-0000-0000-000000000000",
-          "createdByType": "User",
-          "createdAt": "2021-05-14T22:34:55.4499903Z",
-          "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
-          "lastModifiedByType": "User",
-          "lastModifiedAt": "2021-05-14T22:34:55.4499903Z"
-        }
-      },
+    "202": {
       "headers": {
         "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}",
         "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}"

diff --git a/...r/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Reports_List.json b/...r/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Reports_List.json
@@ -37,9 +37,9 @@
               ],
               "complianceStatus": {
                 "m365": {
-                  "passed": 0,
-                  "failed": 0,
-                  "manual": 0
+                  "passedCount": 0,
+                  "failedCount": 0,
+                  "manualCount": 0
                 }
               },
               "provisioningState": "Succeeded"

diff --git a/...on/preview/2022-11-16-preview/examples/Snapshot_ComplianceDetailedPdfReport_Download.json b/...on/preview/2022-11-16-preview/examples/Snapshot_ComplianceDetailedPdfReport_Download.json
@@ -3,9 +3,13 @@
     "api-version": "2022-11-16-preview",
     "reportName": "testReportName",
     "snapshotName": "testSnapshotName",
-    "downloadType": "ComplianceDetailedPdfReport",
-    "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
-    "offerGuid": "00000000-0000-0000-0000-000000000000"
+    "parameters": {
+      "properties": {
+        "downloadType": "ComplianceDetailedPdfReport",
+        "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
+        "offerGuid": "00000000-0000-0000-0000-000000000000"
+      }
+    }
   },
   "responses": {
     "200": {

diff --git a/...Automation/preview/2022-11-16-preview/examples/Snapshot_CompliancePdfReport_Download.json b/...Automation/preview/2022-11-16-preview/examples/Snapshot_CompliancePdfReport_Download.json
@@ -3,9 +3,13 @@
     "api-version": "2022-11-16-preview",
     "reportName": "testReportName",
     "snapshotName": "testSnapshotName",
-    "downloadType": "CompliancePdfReport",
-    "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
-    "offerGuid": "00000000-0000-0000-0000-000000000000"
+    "parameters": {
+      "properties": {
+        "downloadType": "CompliancePdfReport",
+        "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
+        "offerGuid": "00000000-0000-0000-0000-000000000000"
+      }
+    }
   },
   "responses": {
     "200": {

diff --git a/...nceAutomation/preview/2022-11-16-preview/examples/Snapshot_ComplianceReport_Download.json b/...nceAutomation/preview/2022-11-16-preview/examples/Snapshot_ComplianceReport_Download.json
@@ -3,9 +3,13 @@
     "api-version": "2022-11-16-preview",
     "reportName": "testReportName",
     "snapshotName": "testSnapshotName",
-    "downloadType": "ComplianceReport",
-    "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
-    "offerGuid": "00000000-0000-0000-0000-000000000000"
+    "parameters": {
+      "properties": {
+        "downloadType": "ComplianceReport",
+        "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000",
+        "offerGuid": "00000000-0000-0000-0000-000000000000"
+      }
+    }
   },
   "responses": {
     "200": {