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

Azure Policy definition

Configure Storage account to use a private link connection

Name Configure Storage account to use a private link connection
Azure Portal
Id 9f766f00-8d11-464e-80e1-4091d7874074
Version 1.0.0
details on versioning
Category Storage
Microsoft docs
Description Private endpoints connect your virtual network to Azure services without a public IP address at the source or destination. By mapping private endpoints to your storage account, you can reduce data leakage risks. Learn more about private links at - https://aka.ms/azureprivatelinkoverview
Mode Indexed
Type BuiltIn
Preview FALSE
Deprecated FALSE
Effect Default: DeployIfNotExists
Allowed: (DeployIfNotExists, Disabled)
Used RBAC Role
Role Name Role Id
Network Contributor 4d97b98b-1d4f-4787-a291-c67834d212e7
Storage Account Contributor 17d1049b-9a84-46fb-8f53-869881c3d3ab
History
Date/Time (UTC ymd) (i) Change type Change detail
2021-03-09 14:37:41 add 9f766f00-8d11-464e-80e1-4091d7874074
Used in Initiatives none
JSON
{
  "properties": {
    "displayName": "Configure Storage account to use a private link connection",
    "policyType": "BuiltIn",
    "mode": "Indexed",
    "description": "Private endpoints connect your virtual network to Azure services without a public IP address at the source or destination. By mapping private endpoints to your storage account, you can reduce data leakage risks. Learn more about private links at - https://aka.ms/azureprivatelinkoverview",
    "metadata": {
      "version": "1.0.0",
      "category": "Storage"
    },
    "parameters": {
      "privateEndpointSubnetId": {
        "type": "String",
        "metadata": {
          "displayName": "Private endpoint subnet id",
          "description": "The subnetId that private endpoint connections should link to",
          "strongType": "Microsoft.Network/virtualNetworks/subnets"
        }
      },
      "targetSubResource": {
        "type": "String",
        "metadata": {
          "displayName": "Target sub-resource",
          "description": "Type of sub-resource for the resource selected above, that your private endpoint will be able to access"
        },
        "allowedValues": [
          "blob",
          "blob_secondary",
          "table",
          "table_secondary",
          "queue",
          "queue_secondary",
          "file",
          "web",
          "web_secondary",
          "dfs",
          "dfs_secondary"
        ],
        "defaultValue": "blob"
      },
      "effect": {
        "type": "String",
        "metadata": {
          "displayName": "Effect",
          "description": "Enable or disable the execution of the policy"
        },
        "allowedValues": [
          "DeployIfNotExists",
          "Disabled"
        ],
        "defaultValue": "DeployIfNotExists"
      }
    },
    "policyRule": {
      "if": {
        "allOf": [
          {
            "field": "type",
            "equals": "Microsoft.Storage/storageAccounts"
          },
          {
            "field": "kind",
            "in": [
              "StorageV2",
              "BlobStorage",
              "BlockBlobStorage",
              "FileStorage"
            ]
          }
        ]
      },
      "then": {
      "effect": "[parameters('effect')]",
        "details": {
          "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections",
          "existenceCondition": {
            "field": "Microsoft.Storage/storageAccounts/privateEndpointConnections/privateLinkServiceConnectionState.status",
            "equals": "Approved"
          },
          "roleDefinitionIds": [
            "/providers/Microsoft.Authorization/roleDefinitions/4d97b98b-1d4f-4787-a291-c67834d212e7",
            "/providers/Microsoft.Authorization/roleDefinitions/17d1049b-9a84-46fb-8f53-869881c3d3ab"
          ],
          "deployment": {
            "properties": {
              "mode": "incremental",
              "parameters": {
                "name": {
                "value": "[field('name')]"
                },
                "serviceId": {
                "value": "[field('id')]"
                },
                "privateEndpointSubnetId": {
                "value": "[parameters('privateEndpointSubnetId')]"
                },
                "targetSubResource": {
                "value": "[parameters('targetSubResource')]"
                }
              },
              "template": {
                "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
                "contentVersion": "1.0.0.0",
                "parameters": {
                  "name": {
                    "type": "string"
                  },
                  "serviceId": {
                    "type": "string"
                  },
                  "privateEndpointSubnetId": {
                    "type": "string"
                  },
                  "targetSubResource": {
                    "type": "string"
                  }
                },
                "variables": {
                "privateEndpointName": "[concat('pe-',substring(parameters('name'),0,min(length(parameters('name')),50)),'-',uniquestring(deployment().name))]"
                },
                "resources": [
                  {
                    "type": "Microsoft.Resources/deployments",
                  "name": "[variables('privateEndpointName')]",
                    "apiVersion": "2020-06-01",
                    "properties": {
                      "mode": "Incremental",
                      "expressionEvaluationOptions": {
                        "scope": "inner"
                      },
                      "template": {
                        "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
                        "contentVersion": "1.0.0.0",
                        "parameters": {
                          "serviceId": {
                            "type": "string"
                          },
                          "privateEndpointSubnetId": {
                            "type": "string"
                          },
                          "targetSubResource": {
                            "type": "string"
                          },
                          "subnetLocation": {
                            "type": "string"
                          }
                        },
                        "variables": {
                        "privateEndpointName": "[deployment().name]"
                        },
                        "resources": [
                          {
                          "name": "[variables('privateEndpointName')]",
                            "type": "Microsoft.Network/privateEndpoints",
                            "apiVersion": "2020-07-01",
                          "location": "[parameters('subnetLocation')]",
                            "tags": {
                              
                            },
                            "properties": {
                              "subnet": {
                              "id": "[parameters('privateEndpointSubnetId')]"
                              },
                              "privateLinkServiceConnections": [
                                {
                                "name": "[variables('privateEndpointName')]",
                                  "properties": {
                                  "privateLinkServiceId": "[parameters('serviceId')]",
                                  "groupIds": "[array(parameters('targetSubResource'))]",
                                    "requestMessage": "autoapprove"
                                  }
                                }
                              ],
                              "manualPrivateLinkServiceConnections": [
                                
                              ]
                            }
                          }
                        ]
                      },
                      "parameters": {
                        "serviceId": {
                        "value": "[parameters('serviceId')]"
                        },
                        "privateEndpointSubnetId": {
                        "value": "[parameters('privateEndpointSubnetId')]"
                        },
                        "targetSubResource": {
                        "value": "[parameters('targetSubResource')]"
                        },
                        "subnetLocation": {
                        "value": "[reference(first(take(split(parameters('privateEndpointSubnetId'),'/subnets'),1)),'2020-07-01','Full').location]"
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  },
  "id": "/providers/Microsoft.Authorization/policyDefinitions/9f766f00-8d11-464e-80e1-4091d7874074",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "9f766f00-8d11-464e-80e1-4091d7874074"
}