AzureDevOpsDscNative

1.0.0-preview4

en-US/about_AzDoPipelineEnvironment.help.txt

.NAME
    AzDoPipelineEnvironment
 
.SYNOPSIS
    DSC resource for managing Azure DevOps deployment environments.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER EnvironmentName
    Required - System.String
 
.PARAMETER Description
    Write - System.String
 
.EXAMPLE 1
 
This example shows how to create a pipeline environment in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipelineEnvironment 'AddAzDoPipelineEnvironment'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
            Description = 'Production deployment environment'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a pipeline environment in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipelineEnvironment 'UpdateAzDoPipelineEnvironment'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
            Description = 'Production deployment environment - requires approval'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a pipeline environment from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoPipelineEnvironment 'RemoveAzDoPipelineEnvironment'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
        }
    }
}