AzureDevOpsDscNative

1.0.0-preview02

en-US/about_AzDoWiki.help.txt

.NAME
    AzDoWiki
 
.SYNOPSIS
    DSC resource for managing Azure DevOps project and code wikis.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER WikiName
    Required - System.String
 
.PARAMETER WikiType
    Write - System.String
    Allowed values: projectWiki, codeWiki
 
.PARAMETER RepositoryName
    Write - System.String
 
.PARAMETER MappedPath
    Write - System.String
 
.PARAMETER Version
    Write - System.String
 
.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'
        }
    }
}