AzureDevOpsDscNative

1.0.0-preview02

en-US/about_AzDoDeploymentGroup.help.txt

.NAME
    AzDoDeploymentGroup
 
.SYNOPSIS
    DSC resource for managing Azure DevOps deployment groups.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER DeploymentGroupName
    Required - System.String
 
.PARAMETER Description
    Write - System.String
 
.PARAMETER Tags
    Write - System.String[]
 
.EXAMPLE 1
 
This example shows how to create a deployment group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDeploymentGroup 'AddAzDoDeploymentGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            DeploymentGroupName = 'ProductionServers'
            Description = 'Deployment group for production web servers'
            Tags = @('Production', 'Windows', 'IIS')
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a deployment group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDeploymentGroup 'UpdateAzDoDeploymentGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            DeploymentGroupName = 'ProductionServers'
            Description = 'Deployment group for production web and API servers'
            Tags = @('Production', 'Windows', 'IIS', 'API')
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a deployment group from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDeploymentGroup 'RemoveAzDoDeploymentGroup'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            DeploymentGroupName = 'ProductionServers'
        }
    }
}