Workspace manager configurations (#23133)

* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * adding april configurations swagger * update pattern * prettier update * update readme
Azure · Mar 21, 2023 · d34d82b · d34d82b
1 parent 09513c8
commit d34d82b
Show file tree

Hide file tree

Showing 6 changed files with 422 additions and 0 deletions.
diff --git a/...Microsoft.SecurityInsights/preview/2023-04-01-preview/WorkspaceManagerConfigurations.json b/...Microsoft.SecurityInsights/preview/2023-04-01-preview/WorkspaceManagerConfigurations.json
@@ -0,0 +1,323 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Security Insights",
+    "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider",
+    "version": "2023-04-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/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations": {
+      "get": {
+        "x-ms-examples": {
+          "Get all workspace manager configurations for a Sentinel workspace.": {
+            "$ref": "./examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json"
+          }
+        },
+        "tags": [
+          "workspaceManagerConfigurations"
+        ],
+        "description": "Gets all workspace manager configurations for a Sentinel workspace.",
+        "operationId": "WorkspaceManagerConfigurations_List",
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/WorkspaceManagerConfigurationList"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/{workspaceManagerConfigurationName}": {
+      "get": {
+        "x-ms-examples": {
+          "Get a workspace manager configuration.": {
+            "$ref": "./examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json"
+          }
+        },
+        "tags": [
+          "workspaceManagerConfigurations"
+        ],
+        "description": "Gets a workspace manager configuration",
+        "operationId": "WorkspaceManagerConfigurations_Get",
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "$ref": "#/parameters/WorkspaceManagerConfigurationName"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/WorkspaceManagerConfiguration"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      },
+      "delete": {
+        "x-ms-examples": {
+          "Delete a workspace manager configuration.": {
+            "$ref": "./examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json"
+          }
+        },
+        "tags": [
+          "workspaceManagerConfigurations"
+        ],
+        "description": "Deletes a workspace manager configuration",
+        "operationId": "WorkspaceManagerConfigurations_Delete",
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "$ref": "#/parameters/WorkspaceManagerConfigurationName"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "204": {
+            "description": "No Content"
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      },
+      "put": {
+        "x-ms-examples": {
+          "Create or Update a workspace manager Configuration": {
+            "$ref": "./examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json"
+          }
+        },
+        "tags": [
+          "workspaceManagerConfigurations"
+        ],
+        "description": "Creates or updates a workspace manager configuration.",
+        "operationId": "WorkspaceManagerConfigurations_CreateOrUpdate",
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "$ref": "#/parameters/WorkspaceManagerConfigurationName"
+          },
+          {
+            "$ref": "#/parameters/WorkspaceManagerConfiguration"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/WorkspaceManagerConfiguration"
+            }
+          },
+          "201": {
+            "description": "Created",
+            "schema": {
+              "$ref": "#/definitions/WorkspaceManagerConfiguration"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "WorkspaceManagerConfiguration": {
+      "allOf": [
+        {
+          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource"
+        }
+      ],
+      "description": "The workspace manager configuration",
+      "properties": {
+        "properties": {
+          "$ref": "#/definitions/WorkspaceManagerConfigurationProperties",
+          "description": "The workspace manager configuration object",
+          "x-ms-client-flatten": true
+        }
+      },
+      "type": "object"
+    },
+    "WorkspaceManagerConfigurationProperties": {
+      "description": "The workspace manager configuration properties",
+      "properties": {
+        "mode": {
+          "description": "The current mode of the workspace manager configuration",
+          "enum": [
+            "Enabled",
+            "Disabled"
+          ],
+          "type": "string",
+          "x-ms-enum": {
+            "modelAsString": true,
+            "name": "mode",
+            "values": [
+              {
+                "description": "The workspace manager configuration is enabled",
+                "value": "Enabled"
+              },
+              {
+                "description": "The workspace manager configuration is disabled",
+                "value": "Disabled"
+              }
+            ]
+          }
+        }
+      },
+      "required": [
+        "mode"
+      ],
+      "type": "object"
+    },
+    "WorkspaceManagerConfigurationList": {
+      "description": "List all the workspace manager configurations for the workspace.",
+      "type": "object",
+      "properties": {
+        "nextLink": {
+          "description": "URL to fetch the next set of workspace manager configurations.",
+          "readOnly": true,
+          "type": "string"
+        },
+        "value": {
+          "description": "Array of workspace manager configurations.",
+          "items": {
+            "$ref": "#/definitions/WorkspaceManagerConfiguration"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "value"
+      ]
+    }
+  },
+  "parameters": {
+    "WorkspaceManagerConfigurationName": {
+      "description": "The name of the workspace manager configuration",
+      "in": "path",
+      "name": "workspaceManagerConfigurationName",
+      "required": true,
+      "type": "string",
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
+      "x-ms-parameter-location": "method"
+    },
+    "WorkspaceManagerConfiguration": {
+      "description": "The workspace manager configuration",
+      "in": "body",
+      "name": "workspaceManagerConfiguration",
+      "required": true,
+      "schema": {
+        "$ref": "#/definitions/WorkspaceManagerConfiguration"
+      },
+      "x-ms-parameter-location": "method"
+    }
+  }
+}
diff --git a/.../examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json b/.../examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json
@@ -0,0 +1,38 @@
+{
+  "parameters": {
+    "api-version": "2023-04-01-preview",
+    "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
+    "resourceGroupName": "myRg",
+    "workspaceName": "myWorkspace",
+    "workspaceManagerConfigurationName": "default",
+    "workspaceManagerConfiguration": {
+      "properties": {
+        "mode": "Enabled"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default",
+        "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"",
+        "name": "default",
+        "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations",
+        "properties": {
+          "mode": "Enabled"
+        }
+      }
+    },
+    "201": {
+      "body": {
+        "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default",
+        "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"",
+        "name": "default",
+        "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations",
+        "properties": {
+          "mode": "Enabled"
+        }
+      }
+    }
+  }
+}
diff --git a/...-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json b/...-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "api-version": "2023-04-01-preview",
+    "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
+    "resourceGroupName": "myRg",
+    "workspaceName": "myWorkspace",
+    "workspaceManagerConfigurationName": "default"
+  },
+  "responses": {
+    "200": {},
+    "204": {}
+  }
+}