Skip to content

AzDoWiki

github-actions[bot] edited this page Aug 19, 2026 · 4 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
ProjectName Key System.String
WikiName Required System.String
Ensure Write Ensure Present, Absent
MappedPath Write System.String
RepositoryName Write System.String
Version Write System.String
WikiType Write System.String projectWiki, codeWiki
LookupResult Read System.Collections.Hashtable

Description

Examples

Example 1

This example shows how to create a project wiki in an Azure DevOps project.

Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoWiki 'AddAzDoWiki'
        {
            Ensure      = 'Present'
            ProjectName = 'MyProject'
            WikiName    = 'MyProjectWiki'
            WikiType    = 'projectWiki'
        }
    }
}

Example 2

This example shows how to create a code wiki linked to a repository in an Azure DevOps project.

Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoWiki 'UpdateAzDoWiki'
        {
            Ensure         = 'Present'
            ProjectName    = 'MyProject'
            WikiName       = 'MyCodeWiki'
            WikiType       = 'codeWiki'
            RepositoryName = 'MyRepository'
            MappedPath     = '/docs'
            Version        = 'main'
        }
    }
}

Example 3

This example shows how to remove a wiki from an Azure DevOps project.

Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoWiki 'RemoveAzDoWiki'
        {
            Ensure      = 'Absent'
            ProjectName = 'MyProject'
            WikiName    = 'MyProjectWiki'
        }
    }
}

Commands

Resources

Clone this wiki locally