AzureDevOpsDscNative

1.1.0

en-US/about_AzDoDeploymentGroup.help.txt

.NAME
    AzDoDeploymentGroup
 
.SYNOPSIS
    DSC resource for managing Azure DevOps deployment groups.
 
.DESCRIPTION
    This resource manages Azure DevOps deployment groups, which are collections of physical or
    virtual machines used as deployment targets for classic release pipelines. Agents installed on
    these machines register with the deployment group to receive deployments.
 
.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 DeploymentGroupName
    Required - System.String
    The name of the deployment group. This is a key property.
 
.PARAMETER Description
    Write - System.String
    An optional description for the deployment group.
 
.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'
        }
    }
}