Skip to content

INDEX

Jump to bottom
Michael Zanatta edited this page Aug 27, 2026 · 4 revisions

AzureDevOpsDscNative Wiki - Complete Index

Welcome to the comprehensive wiki for AzureDevOpsDscNative, a native DSC v3 module for managing Azure DevOps.

📚 Wiki Structure

The wiki is organized into several key sections to help you find what you need:

Main Pages

Page Purpose Best For
Home Overview and quick start Getting started, module features
Resources Resource reference organized by category Finding specific resources
Permissions & ACLs Permission/ACL concepts, full bit-name reference, pitfalls Configuring or troubleshooting any permission resource
Pipeline Runner Configuration How Dsc.PipelineRunner applies configurations at scale Deploying with Dsc.PipelineRunner
Authentication Authentication methods and setup Configuring authentication
Best Practices Guidelines and recommendations Improving implementations
Examples Practical scenarios and workflows Learning by example

Resource Documentation

Each of the 49 DSC resources has its own page, named after the resource itself (see the sidebar, or Resources for the full categorized list):

Core Resources:

🚀 Getting Started

I'm New to AzureDevOpsDscNative

  1. Start with Home
  2. Read the Quick Start section
  3. Review a Simple Example
  4. Check Authentication to set up credentials

I Need to Use a Specific Resource

  1. Find it in Resources
  2. Open the resource's documentation page
  3. Review examples and properties
  4. Refer to Best Practices for optimization

I'm Setting Up a Complex Environment

  1. Review Best Practices first
  2. Study relevant Examples
  3. Reference individual resources as needed
  4. Use configuration data files for organization

I'm Troubleshooting an Issue

  1. Check the specific resource's troubleshooting section
  2. Review Best Practices
  3. Verify Authentication setup
  4. Check related resources for dependencies

📖 Learning Paths

Path 1: Basic Project Setup (30 minutes)

  1. Home - Quick Start
  2. Authentication Guide - Choose your method
  3. Example: Basic Project Setup
  4. AzDoProject Resource

Path 2: Complete CI/CD Pipeline (1-2 hours)

  1. Best Practices - Understand patterns
  2. Example: Pipeline and CI/CD Setup
  3. AzDoPipeline Resource
  4. AzDoVariableGroup Resource
  5. AzDoServiceConnection Resource

Path 3: Enterprise Deployment (2-4 hours)

  1. Best Practices - Large-Scale Deployments
  2. Example: Multi-Project Organization
  3. Best Practices - Configuration Management
  4. Best Practices - Security
  5. Review multiple resource pages for your specific needs

🔑 Key Concepts

DSC Resources

DSC Resources are the building blocks of AzureDevOpsDscNative. Each resource manages a specific Azure DevOps entity.

Resource Types:

  • Ensure - Controls desired state ('Present' or 'Absent')
  • Key Properties - Uniquely identify a resource
  • Optional Properties - Configure the resource
  • Dependencies - Control execution order

Common Patterns

Project Setup:

Create Project → Create Repositories → Configure Permissions

Pipeline Setup:

Create Project → Create Service Connections → Create Variable Groups → Create Pipelines

Team Organization:

Create Project → Create Teams → Add Team Members → Assign Permissions

📋 Available Resources

AzureDevOpsDscNative includes 49 resources organized in these categories:

Category Count Resources
Organization & Groups 5 Groups, Members, Permissions, Settings, Entitlements
Project Management 4 Projects, Groups, Services, Permissions
Team Management 3 Teams, Members, Settings
Repository & Git 5 Repositories, Permissions, Settings, Areas, Iterations
Permissions & Security 4 Area, Iteration, Namespace, Branch Policies
Pipelines & CI/CD 7 Pipelines, Environments, Settings, Approvals, Checks
Service Connections 4 Connections, Permissions, Variables, Group Permissions
Agents & Infrastructure 4 Pools, Queues, Deployment Groups, Permissions
Artifacts 4 Feeds, Permissions, Settings, Views
Other 9 Wikis, Task Groups, Extensions, Webhooks, etc.

See Resources.md for complete list with descriptions.

🔐 Authentication

Supported Methods

  1. Personal Access Token (PAT) - Simple, widely used
  2. Managed Identity - Best for Azure resources
  3. Service Principal - CI/CD and automation
  4. Certificate-Based - Enhanced security
  5. Azure CLI Token - Local development
  6. Workload Identity - Keyless CI/CD

Choose based on your scenario. Learn more

🛠️ Common Tasks

Create a New Project

  1. Read AzDoProject Resource
  2. Follow the examples on that page
  3. Run the configuration

Set Up Teams

  1. Read AzDoTeam Resource
  2. Follow the examples on that page
  3. Use AzDoTeamMember for team members

Configure Permissions

  1. Start at Permissions & ACLs for the concepts and full bit-name reference
  2. Check Example: Permission Management
  3. Open the specific permission resource's page for detailed syntax

Set Up Pipelines

  1. Review Example: Pipeline Setup
  2. Check Best Practices - CI/CD
  3. Reference pipeline-related resources

📚 Documentation Sections

Home Page

  • Module overview
  • Key features
  • Quick start guide
  • Feature summary

Resources

  • Complete resource reference
  • Organized by category
  • Property descriptions
  • Quick links to detailed docs

Resource Documentation

  • Detailed resource pages (one per resource, see the sidebar or Resources)
  • Parameters, syntax, and examples
  • Related resources

Authentication Guide

  • Multiple auth methods
  • Setup instructions
  • Best practices
  • Troubleshooting auth issues

Best Practices

  • Configuration management patterns
  • Security guidelines
  • Performance optimization
  • Error handling
  • Large-scale deployment strategies
  • Testing and validation
  • Maintenance and updates

Examples

  • Basic project setup
  • Complete project with teams
  • Git repository configuration
  • Pipeline and CI/CD setup
  • Permission management
  • Artifact feed setup
  • Multi-project organization setup
  • Configuration data approaches
  • Common patterns and reusable templates

🤝 Contributing

Documentation Contributions

Individual resource pages are generated from each resource class's comment-based help (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE) in source/Classes/, and are pushed to this wiki automatically as part of the release pipeline's docs step. To improve a resource's documentation, update the comment-based help on the class itself in a pull request — do not edit the generated resource pages directly, they will be overwritten on the next release. See CONTRIBUTING.md in the main repository for details.

🔄 Navigation

Quick Navigation:

By Topic:

📊 Quick Stats

  • Total Resources: 49
  • Code Examples: 30+
  • Authentication Methods: 6
  • Resource Categories: 10

⚡ Quick Links

Most Used Resources

Most Viewed Pages

Common Searches

🆘 Need Help?

  1. For specific resources → Check that resource's page (see the sidebar or Resources)
  2. For common issues → Review Troubleshooting
  3. For authentication → See Authentication Guide
  4. For patterns → Check Best Practices
  5. For examples → Browse Examples

📝 Changelog

The complete changelog is available in the GitHub repository:

🔗 External Resources

📄 License

AzureDevOpsDscNative is licensed under the MIT License. See LICENSE file in the repository for details.

Last Updated: August 2025
Wiki Version: 1.0
Module: AzureDevOpsDscNative - Native DSC v3 Module

Ready to get started? Head to Home or choose a Learning Path above!

Commands

Resources

Clone this wiki locally