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

…onboarding states resource type to preview/2021-03-01-preview (#13779) * Add Sentinel onboarding states resource type * Fix param name * Fix Avocado * Fix spell check * Fix prettier * Fix LintDiff * Fix lintDiff 2 * Fix lintDiff 3 * Fix lintDiff 4 * Fix lintDiff 5 * Fix lintDiff 6 * Fix lintDiff 7 * Fix lintDiff 8 * Fix prettier * Rename onboarding state properties * Add GetAll * Fix example file name * Fix incorrect cloud error ref * Fix GetAll example
Azure · May 5, 2021 · 4d3f29a · 4d3f29a
1 parent 8c76ee1
commit 4d3f29a
Show file tree

Hide file tree

Showing 6 changed files with 436 additions and 1 deletion.
diff --git a/...ource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json b/...ource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json
@@ -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"
+    }
+  }
+}
diff --git a/...s/preview/2021-03-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json b/...s/preview/2021-03-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json
@@ -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
+        }
+      }
+    }
+  }
+}
diff --git a/...s/preview/2021-03-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json b/...s/preview/2021-03-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json
@@ -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": {}
+  }
+}