AzureDevOpsDscNative

1.1.0

en-US/about_AzDoWiki.help.txt

.NAME
    AzDoWiki
 
.SYNOPSIS
    DSC resource for managing Azure DevOps project and code wikis.
 
.DESCRIPTION
    This resource manages wikis in Azure DevOps projects. Project wikis are automatically created
    within the project, while code wikis are sourced from content stored in a Git repository.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER WikiName
    Required - System.String
    The name of the wiki. This is a key property.
 
.PARAMETER WikiType
    Write - System.String
    Allowed values: projectWiki, codeWiki
    The type of wiki. Valid values are projectWiki (a built-in project wiki) and codeWiki (a wiki sourced from a Git repository). Defaults to projectWiki.
 
.PARAMETER RepositoryName
    Write - System.String
    For codeWiki type, the name of the repository that contains the wiki content. Optional.
 
.PARAMETER MappedPath
    Write - System.String
    For codeWiki type, the folder path within the repository that contains the wiki content. Defaults to /.
 
.PARAMETER Version
    Write - System.String
    For codeWiki type, the branch or commit to use. Optional.
 
.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'
        }
    }
}