last sync: 2021-Jul-23 16:37:57 UTC

Azure Policy definition

[Preview]: Azure IoT Hub should use customer-managed key to encrypt data at rest

Name [Preview]: Azure IoT Hub should use customer-managed key to encrypt data at rest
Azure Portal
Id 2d7e144b-159c-44fc-95c1-ac3dbf5e6e54
Version 1.0.0-preview
details on versioning
Category Internet of Things
Microsoft docs
Description Encryption of data at rest in IoT Hub with customer-managed key adds a second layer of encryption on top of the default service-managed keys, enables customer control of keys, custom rotation policies, and ability to manage access to data through key access control. Customer-managed keys must be configured during creation of IoT Hub. For more information on how to configure customer-managed keys, see https://aka.ms/iotcmk.
Mode Indexed
Type BuiltIn
Preview True
Deprecated FALSE
Effect Default: Audit
Allowed: (Audit, Deny, Disabled)
Used RBAC Role none
History
Date/Time (UTC ymd) (i) Change type Change detail
2021-03-09 14:37:41 add 2d7e144b-159c-44fc-95c1-ac3dbf5e6e54
Used in Initiatives none
JSON
{
  "properties": {
  "displayName": "[Preview]: Azure IoT Hub should use customer-managed key to encrypt data at rest",
    "policyType": "BuiltIn",
    "mode": "Indexed",
    "description": "Encryption of data at rest in IoT Hub with customer-managed key adds a second layer of encryption on top of the default service-managed keys, enables customer control of keys, custom rotation policies, and ability to manage access to data through key access control. Customer-managed keys must be configured during creation of IoT Hub. For more information on how to configure customer-managed keys, see https://aka.ms/iotcmk.",
    "metadata": {
      "version": "1.0.0-preview",
      "category": "Internet of Things",
      "preview": true
    },
    "parameters": {
      "effect": {
        "type": "String",
        "metadata": {
          "displayName": "Effect",
          "description": "The desired effect of the policy."
        },
        "allowedValues": [
          "Audit",
          "Deny",
          "Disabled"
        ],
        "defaultValue": "Audit"
      }
    },
    "policyRule": {
      "if": {
        "allOf": [
          {
            "field": "type",
            "equals": "Microsoft.Devices/IotHubs"
          },
          {
            "count": {
            "field": "Microsoft.Devices/IotHubs/encryption.keyVaultProperties[*]",
              "where": {
                "allOf": [
                  {
                  "field": "Microsoft.Devices/IotHubs/encryption.keyVaultProperties[*].keyIdentifier",
                    "exists": "true"
                  },
                  {
                  "field": "Microsoft.Devices/IotHubs/encryption.keyVaultProperties[*].keyIdentifier",
                    "notequals": ""
                  }
                ]
              }
            },
            "lessOrEquals": 0
          }
        ]
      },
      "then": {
      "effect": "[parameters('effect')]"
      }
    }
  },
  "id": "/providers/Microsoft.Authorization/policyDefinitions/2d7e144b-159c-44fc-95c1-ac3dbf5e6e54",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "2d7e144b-159c-44fc-95c1-ac3dbf5e6e54"
}