DOS2325

Pipelines - Environment should have a description

DOS2325

AzureDevOps project low builtIn

Description

Make sure to add a description to your pipeline environment. Include a description in your pipeline environment for clarity and purpose. Learn more: https://learn.microsoft.com/en-us/azure/devops/pipelines/process/environments

Recommendation

1. Navigate to Project -> Pipelines -> Environments 
2. Select an environment. 
3. Click on the three dots button (top right). 
4. Click Edit. 
5. Enter a Description. 
6. Click on 'Save'.

Policy Rule

{
  "target": "ADOProjectEnvironmentInstance",
  "if": {
    "allOf": [
      {
        "resource": "ADOProjectEnvironmentInstance",
        "property": "Description",
        "operator": "notEquals",
        "value": ""
      }
    ]
  },
  "then": {
    "effect": "Audit"
  }
}
« DOS2320 DOS2326 »
Rule Details
  • Rule ID: DOS2325
  • Code: ADO_Project_Pipelines_Library_Environment_Should_Have_Description
  • Platform: AzureDevOps
  • Category: project
  • Severity: low
  • Type: builtIn
Related Rules

Copyright © DevOps Shield. All Rights Reserved. Privacy Policy | Cookie Policy | Terms and Conditions