{ "swagger": "2.0", "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", "version": "2025-06-01" }, "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/contentPackages": { "get": { "x-ms-examples": { "Get all available packages.": { "$ref": "./examples/contentPackages/GetPackages.json" } }, "tags": [ "ContentPackages" ], "description": "Gets all installed packages.", "operationId": "ContentPackages_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "./common/2.0/types.json#/parameters/ODataFilter" }, { "$ref": "./common/2.0/types.json#/parameters/ODataOrderBy" }, { "$ref": "./common/2.0/types.json#/parameters/ODataSearch" }, { "$ref": "./common/2.0/types.json#/parameters/ODataCount" }, { "$ref": "./common/2.0/types.json#/parameters/ODataTop" }, { "$ref": "./common/2.0/types.json#/parameters/ODataSkip" }, { "$ref": "./common/2.0/types.json#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/packageList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}": { "get": { "x-ms-examples": { "Get installed packages by id.": { "$ref": "./examples/contentPackages/GetPackageById.json" } }, "tags": [ "ContentPackages" ], "description": "Gets an installed packages by its id.", "operationId": "ContentPackages_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/PackageIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/packageModel" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "put": { "x-ms-examples": { "Install a package to the workspace.": { "$ref": "./examples/contentPackages/InstallPackage.json" } }, "tags": [ "ContentPackages" ], "description": "Install a package to the workspace.", "operationId": "ContentPackage_Install", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/PackageIdParameter" }, { "$ref": "#/parameters/PackageInstallationProperties" } ], "responses": { "200": { "description": "OK, a package is updated.", "schema": { "$ref": "#/definitions/packageModel" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/packageModel" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "delete": { "x-ms-examples": { "Uninstall a package from the workspace.": { "$ref": "./examples/contentPackages/UninstallPackage.json" } }, "tags": [ "ContentPackages" ], "description": "Uninstall a package from the workspace.", "operationId": "ContentPackage_Uninstall", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/PackageIdParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } } } }, "definitions": { "packageList": { "description": "List available packages.", "properties": { "nextLink": { "description": "URL to fetch the next set of packages.", "readOnly": true, "type": "string" }, "value": { "description": "Array of packages.", "items": { "$ref": "#/definitions/packageModel" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "packageModel": { "allOf": [ { "$ref": "./common/2.0/types.json#/definitions/ResourceWithEtag" } ], "description": "Represents a Package in Azure Security Insights.", "properties": { "properties": { "description": "package properties", "$ref": "#/definitions/packageProperties", "x-ms-client-flatten": true } }, "type": "object" }, "packageProperties": { "description": "Describes package properties", "allOf": [ { "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties" } ], "required": [ "contentId", "contentProductId", "contentKind", "version", "displayName" ], "type": "object" } }, "parameters": { "PackageIdParameter": { "description": "package Id", "in": "path", "name": "packageId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "PackageInstallationProperties": { "description": "Package installation properties", "in": "body", "name": "packageInstallationProperties", "required": true, "schema": { "$ref": "#/definitions/packageModel" }, "x-ms-parameter-location": "method" } } }