en-US/about_AzDoEnvironmentApproval.help.txt
|
.NAME
AzDoEnvironmentApproval .SYNOPSIS DSC resource for managing Azure DevOps environment approval checks. .DESCRIPTION .PARAMETER ProjectName Key - System.String .PARAMETER EnvironmentName Required - System.String .PARAMETER Approvers Required - System.String[] .PARAMETER RequiredApproverCount Write - System.UInt32 .PARAMETER AllowApproverToSelf Write - System.Boolean .PARAMETER TimeoutInMinutes Write - System.UInt32 .PARAMETER Instructions Write - System.String .EXAMPLE 1 This example shows how to configure approval gates on a pipeline environment in an Azure DevOps project. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoEnvironmentApproval 'AddAzDoEnvironmentApproval' { Ensure = 'Present' ProjectName = 'MyProject' EnvironmentName = 'Production' Approvers = @('approver@example.com') RequiredApproverCount = 1 AllowApproverToSelf = $false TimeoutInMinutes = 1440 Instructions = 'Please review and approve the production deployment.' } } } .EXAMPLE 2 This example shows how to update approval gates on a pipeline environment in an Azure DevOps project. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoEnvironmentApproval 'UpdateAzDoEnvironmentApproval' { Ensure = 'Present' ProjectName = 'MyProject' EnvironmentName = 'Production' Approvers = @('approver1@example.com', 'approver2@example.com') RequiredApproverCount = 2 AllowApproverToSelf = $false TimeoutInMinutes = 2880 Instructions = 'At least 2 approvals required for production deployments.' } } } .EXAMPLE 3 This example shows how to remove approval gates from a pipeline environment in an Azure DevOps project. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoEnvironmentApproval 'RemoveAzDoEnvironmentApproval' { Ensure = 'Absent' ProjectName = 'MyProject' EnvironmentName = 'Production' Approvers = @() } } } |