last sync: 2021-Sep-24 16:09:49 UTC

Azure Policy definition

[Deprecated]: Audit Web Sockets state for an API App

Name [Deprecated]: Audit Web Sockets state for an API App
Azure Portal
Id b48334a4-911b-4084-b1ab-3e6a4e50b951
Version 1.0.0-deprecated
details on versioning
Category Security Center
Microsoft docs
Description The Web Sockets protocol is vulnerable to different types of security threats. Use of Web Sockets within an API app must be carefully reviewed.
Mode All
Type BuiltIn
Preview FALSE
Deprecated True
Effect Default: AuditIfNotExists
Allowed: (AuditIfNotExists, Disabled)
Used RBAC Role none
History none
Used in Initiatives none
JSON
{
  "displayName": "[Deprecated]: Audit Web Sockets state for an API App",
  "policyType": "BuiltIn",
  "mode": "All",
  "description": "The Web Sockets protocol is vulnerable to different types of security threats. Use of Web Sockets within an API app must be carefully reviewed.",
  "metadata": {
    "version": "1.0.0-deprecated",
    "category": "Security Center",
    "deprecated": true
  },
  "parameters": {
    "effect": {
      "type": "String",
      "metadata": {
        "displayName": "Effect",
        "description": "Enable or disable the execution of the policy"
      },
      "allowedValues": [
        "AuditIfNotExists",
        "Disabled"
      ],
      "defaultValue": "AuditIfNotExists"
    }
  },
  "policyRule": {
    "if": {
      "allof": [
        {
          "field": "type",
          "equals": "microsoft.Web/sites"
        },
        {
          "anyof": [
            {
              "field": "kind",
              "equals": "api"
            },
            {
              "field": "kind",
              "equals": "apiApp"
            }
          ]
        }
      ]
    },
    "then": {
      "effect": "[parameters('effect')]",
      "details": {
        "type": "Microsoft.Security/complianceResults",
        "name": "DisableWebSockets",
        "existenceCondition": {
          "field": "Microsoft.Security/complianceResults/resourceStatus",
          "in": [
            "OffByPolicy",
            "Healthy"
          ]
        }
      }
    }
  }
}