Azure Policy – Perform policy operations through Azure DevOps

Published Jan 09 2021 06:25 AM 3,916 Views
Microsoft

We can use Azure DevOps to perform all the policy operations – Create and Assign Policy and Initiatives, Remediate non-compliant resources,

and check compliance status.

 

Steps to setup the environment for policy operations  

  1. Login to your Azure DevOps Organization and select Releases as shown below and click on New. Select New Release Pipeline.

praskuma_60-1610201627019.png

 

 

  1. This will open a pop-up window and will ask to select a template.

praskuma_31-1610199622146.png

 

  1. Select Azure Policy Deployment and Click on Apply
 

praskuma_32-1610199633172.png

 

  1. Post template selection, we will get a small pop-up window to show us the stage details of this pipeline release. Close this window and proceed with next step.

praskuma_33-1610199641169.png

 

  1.  Before configuring the different Tasks of the stage, please make sure you have setup a Service connection to integrate your Azure DevOps organization with your Azure Subscription. We need to connect to our Microsoft Azure subscription, to a different build server or file server, to an online continuous integration environment, or to services you install on remote computers.

Please refer the below Microsoft article for step-by-step process to setup the service connection.

 

https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops&...

 

Once we setup the service connection, we can get to see/update them as below-

 

praskuma_34-1610199653931.png

 

  1.  We need to click on Stage1- Tasks option as highlighted below. Here, we do not need to add/update artifacts as we are not using any GitHub repository for policy operations in this article. Leave it as it is.

We can update the name of pipeline, stage, Agent and Tasks as per our convenience.

 

praskuma_35-1610199663203.png

 

  1. Once We click, we will get to see the Stage Details and the Tasks in the hierarchy. Like here in the below snippet-

 

Stage Name – Stage 1

Tasks – Create Azure Policy and Assign Azure Policy

 

praskuma_36-1610199674166.png

 

  1.   Select any Task. Here we have selected the first task – Create Azure Policy. Please note that since here we are using Azure PowerShell as the backend script, please select the appropriate Task Versions. Here Task version represents the PowerShell version, and the versions may vary depending upon the cmdlets we will be using. It is always recommended to use the latest version.

 

Choose Azure Resource Manager as Azure Connection Type. If you have access to multiple Azure subscriptions linked through Service connection, you may choose any one of them and that will be used as scope for this policy assignment and creation.

 

Choose Script Type as Inline Script as we are providing the PowerShell script as inline content. We can use Script File Path as well in case we are using any repository like GitHub as the source for files.

 

praskuma_37-1610199687739.png

 

  1. Copy below PowerShell code into the Inline Script block. We need to update the highlighted/bold values as per our requirement and add our policy in Json format like below

 

 

 

 

$definition = New-AzPolicyDefinition -Name 'DenyCoolTier' -DisplayName 'DenyCoolTier' -Description 
'Deny cool access tiering for storage' -Policy '{

    "if": {
 "allOf": [{
"field": "type",
"equals": "Microsoft.Storage/storageAccounts"
},
{
 "field": "kind",
"equals": "BlobStorage"

            },

            {
"field": "Microsoft.Storage/storageAccounts/accessTier",
"equals": "cool"
}
 ]
},

    "then": {
"effect": "deny"
}

}'

 

 

 

 

 

praskuma_38-1610199758688.png

 

  1. Similarly update the Inline Script of second Task- Assign Azure Policy. Please use the below code as reference and update the bold/highlighted values with your own policy details that is there defined in the target subscriptions.

 

 

$definition = Get-AzPolicyDefinition | Where-Object { $_.Properties.DisplayName -eq 'DenyCoolTier'}

New-AzPolicyAssignment -Name "DenyCoolTier" -DisplayName "DenyCoolTier" -PolicyDefinition $definition

 

 

 

praskuma_39-1610199768226.png

 

  1. Post updating both the Tasks, Click on Save and a new pop-up window will come up. Select the folder (if you have any hierarchy) with your comments (optional) and click OK.

praskuma_40-1610199776135.png

  1. Now click on “Create a New Release” and another window will pop-up, click on “Create” and proceed.

praskuma_41-1610199785064.png

 

praskuma_42-1610199808662.png

 

Once you click on create, you will get to see a message like in the below snippet that “Release has been created”.

 

praskuma_43-1610199820171.png

 

  1. Click on the message link – “Release has been created” and it will show the progress of all the Tasks in the stage

It will start from Queued and will go into in Progress and then Succeeded. If there is some syntax or runtime error, the task will fail with Failed message. We can click on the status and see the error/failure reason.

 

praskuma_44-1610199828807.png

 

praskuma_45-1610199837072.png

 

If we click on Succeeded link in the Stage, you will get to see the status of each step that was performed by the agent and further we can click on the succeeded status of each step to see the operation logs(Refer below snippet).

 

praskuma_46-1610199849313.png

 

praskuma_47-1610199857974.png

 

praskuma_48-1610199862723.png

  1. Likewise, we can create either other Stages in the same release or Tasks in the same stage or a new Release for other policy operations like Compliance Check and Remediate. Please refer the below snippets. The steps will remain the same and only Inline Script needs to be updated.
 

praskuma_49-1610199873513.png

 

praskuma_50-1610199887638.png

 

Notes:

 

  1. In case of assigning a DINE policy, please make sure that managed identity must complete replication through Azure Active Directory before it can be granted the needed roles as per the documentation here: Remediate non-compliant resources - Azure Policy | Microsoft Docs. Else, the remediation tasks will fail due to missing permissions.
  1. You may encounter below errors while executing the script in the pipeline.

 

  • The Service Principal (SPN) used by Azure DevOps to connect to your Azure subscription requires the Owner role and you may get this error while SPN has the less than the owner role.

praskuma_51-1610199906689.png

 

By default, the SPN created by Azure DevOps to connect to your Azure subscription is assigned the Contributor role. For updating the assignment of security roles on a resource group requires the Owner role. You need to ensure that the SPN used by Azure DevOps has the Owner role assigned at the subscription level. This is accomplished through the Access control (IAM) blade for the subscription –

 

praskuma_52-1610199915788.png

 

  • The same SPN also requires Read directory data permissions to your Azure AD.

praskuma_53-1610199924334.png

Steps to Grant Azure AD permissions:

By default, the SPN created by Azure DevOps is only granted sign in and read user profile permissions against Azure AD. We now need to grant the SPN the additional read directory data permission.

  1. Go to Azure AD -> App Registrations.
  2. Select the SPN that Azure DevOps uses

praskuma_54-1610199932147.png

 

a. Select API permission and then click on ‘Add a permission’ 

praskuma_55-1610199941373.png

 

b. Select Azure Active Directory Graph from the list

 

praskuma_56-1610199950905.png

 

c. Select Application permissions.

praskuma_57-1610199960278.png

 

d. Select Directory.Read.All permission from the list and click on Add permissions.

praskuma_58-1610199974008.png

 

e. Click on ‘Grant admin consent for Directory’.

praskuma_59-1610199981973.png

Once permission is granted and the status shows as Green, Try running the deploying the Policy through Azure DevOps then.

 

  1. Creating and Assigning Policy Initiatives:

In case of creating and assigning policy Initiatives, the above steps from 1-13 will remain the same except the sample code in steps 9 and 10. Please update the script as below:

 

Creating Policy Initiative: (Replace the code at Step 9)

 

 

 

$jsonPolicysetdefinition = @"

[ {
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/ea3f2387-9b95-492a-a190-fcdc54f7b070",

        "parameters": {
"tagName": {
"value": "[parameters('tags')]"
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a08ec900-254a-4555-9bf5-e42af04b5c5c",

        "parameters": {
"listOfResourceTypesAllowed": {
"value": "[parameters('resourceTypes')]"
}
}
}
]"@

$jsonPolicydefinitionparameter = @"

{
"tags": {
"type": "String"
},
"resourceTypes": {
"type": "Array"
}
}"@

$Initiative= New-AzPolicySetDefinition -Name 'PolicyInitiativeTest' -PolicyDefinition $jsonPolicysetdefinition -Parameter $jsonPolicydefinitionparameter -SubscriptionId ‘abcd-e44e-4a99-a89c-45be63c6a8ad'

Write-Host $Initiative.PolicySetDefinitionId
Write-Host "##vso[task.setvariable variable=Initiative;isSecret=false;isOutput=true;]$Initiative.PolicySetDefinitionId"

 

 

 

 

Assign Policy Initiative: (Replace the code at Step 10)

 

 

 

$jsonPolicyassignmentparameter = @"

{

    "tags": {

        "value": "AnotherTag"

    },

    "resourceTypes": {

        "value": [

            "microsoft.devtestlab/labs/costs",

            "microsoft.media/mediaservices/streamingpolicies",

            "microsoft.security/iotsecuritysolutions/iotalerts",

            "microsoft.security/iotsecuritysolutions/analyticsmodels/aggregatedrecommendations",

            "microsoft.sql/managedinstances/metricdefinitions",

            "microsoft.sql/managedinstances/databases/vulnerabilityassessments/rules/baselines",

            "microsoft.sql/managedinstances/databases/backupshorttermretentionpolicies"

        ]

    }

}"@

$Policy = Get-AzPolicySetDefinition -Name 'PolicyInitiativeTest'

$remediationID = New-AzPolicyAssignment -Name 'PolicyInitiativeAssignment' -Scope '/subscriptions/abcd-e44e-4a99-a89c-45be63c6a8ad' -PolicySetDefinition $Policy -PolicyParameter $jsonPolicyassignmentparameter -Location 'eastus' -AssignIdentity

$roleDefId = Get-AzRoleDefinition 'Contributor'

New-AzRoleAssignment -Scope '/subscriptions/abcd-e44e-4a99-a89c-45be63c6a8ad' -ObjectId $remediationID.Identity.PrincipalId -RoleDefinitionId $roleDefId.Id

for($i=0; $i -lt $initative.Properties.policyDefinitions.Length; $i++){

    Start-AzPolicyRemediation -Name '$i Initiative' -PolicyAssignmentId $remediationID.PolicyAssignmentId -PolicyDefinitionReferenceId $initative.Properties.policyDefinitions[$i].policyDefinitionReferenceId }



 

 

 

 

 

 

 

 

 

2 Comments
Version history
Last update:
‎Jan 09 2021 08:10 PM
Updated by: