AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoVariableGroup.help.txt

.NAME
    AzDoVariableGroup
 
.SYNOPSIS
    DSC resource for managing Azure DevOps pipeline variable groups.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER VariableGroupName
    Required - System.String
 
.PARAMETER Description
    Write - System.String
 
.PARAMETER VariableGroupType
    Write - System.String
    Allowed values: Vsts, AzureKeyVault
 
.PARAMETER Variables
    Write - HashTable
 
.PARAMETER AllowAccess
    Write - System.Boolean
 
.EXAMPLE 1
 
This example shows how to create a variable group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoVariableGroup 'AddAzDoVariableGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            VariableGroupName = 'MyVariableGroup'
            Description = 'Shared pipeline variables'
            VariableGroupType = 'Vsts'
            AllowAccess = $true
            Variables = @{
                APP_ENV = 'production'
                APP_LOG_LEVEL = 'warn'
            }
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a variable group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoVariableGroup 'UpdateAzDoVariableGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            VariableGroupName = 'MyVariableGroup'
            Description = 'Shared pipeline variables - updated'
            VariableGroupType = 'Vsts'
            AllowAccess = $true
            Variables = @{
                APP_ENV = 'production'
                APP_LOG_LEVEL = 'info'
                APP_VERSION = '2.0.0'
            }
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a variable group from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoVariableGroup 'RemoveAzDoVariableGroup'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            VariableGroupName = 'MyVariableGroup'
        }
    }
}