AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoCheckConfiguration.help.txt

.NAME
    AzDoCheckConfiguration
 
.SYNOPSIS
    DSC resource for managing pipeline check configurations.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER TargetResourceName
    Required - System.String
 
.PARAMETER ResourceType
    Required - System.String
    Allowed values: environment, repository, endpoint
 
.PARAMETER CheckType
    Required - System.String
 
.PARAMETER Settings
    Write - HashTable
 
.PARAMETER TimeoutInMinutes
    Write - System.UInt32
 
.PARAMETER Enabled
    Write - System.Boolean
 
.EXAMPLE 1
 
This example shows how to add an approval check configuration on a pipeline environment in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoCheckConfiguration 'AddAzDoCheckConfiguration'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            ResourceName = 'Production'
            ResourceType = 'environment'
            CheckType = 'Task Check'
            TimeoutInMinutes = 1440
            Enabled = $true
            Settings = @{
                displayName = 'Validate deployment'
                definitionRef = @{
                    id = '9a2b4d5e-1234-5678-abcd-9876543210ef'
                    name = 'PowerShell'
                    version = '2.*'
                }
                inputs = @{
                    script = 'Write-Host "Validation passed"'
                }
            }
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a check configuration on a pipeline resource in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoCheckConfiguration 'UpdateAzDoCheckConfiguration'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            ResourceName = 'Production'
            ResourceType = 'environment'
            CheckType = 'Task Check'
            TimeoutInMinutes = 2880
            Enabled = $true
            Settings = @{
                displayName = 'Validate deployment - extended'
                definitionRef = @{
                    id = '9a2b4d5e-1234-5678-abcd-9876543210ef'
                    name = 'PowerShell'
                    version = '2.*'
                }
                inputs = @{
                    script = 'Write-Host "Extended validation passed"'
                }
            }
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a check configuration from a pipeline resource in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoCheckConfiguration 'RemoveAzDoCheckConfiguration'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            ResourceName = 'Production'
            ResourceType = 'environment'
            CheckType = 'Task Check'
        }
    }
}