en-US/about_AzDoPipelineEnvironment.help.txt
|
.NAME
AzDoPipelineEnvironment .SYNOPSIS DSC resource for managing Azure DevOps deployment environments. .DESCRIPTION This resource manages pipeline environments in Azure DevOps. Environments represent deployment targets (e.g., Development, Staging, Production) and can be configured with approval gates and checks using the AzDoEnvironmentApproval and AzDoCheckConfiguration resources. .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 EnvironmentName Required - System.String The name of the pipeline environment. This is a key property. .PARAMETER Description Write - System.String An optional description for the environment. .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' } } } |