en-US/about_AzDoPipelineSettings.help.txt
|
.NAME
AzDoPipelineSettings .SYNOPSIS DSC resource for managing Azure DevOps project pipeline general settings. .DESCRIPTION The AzDoPipelineSettings resource manages a project's pipeline general settings (the Project Settings -> Pipelines -> Settings page) via the Build REST API. Only the settings explicitly specified in the configuration are reconciled; unspecified settings are left untouched. The settings are intrinsic to a project and cannot be removed, so Ensure = 'Absent' is a no-op. Test()/Set() are inherited from the AzDevOpsDscResourceBase class. .PARAMETER ProjectName Key - System.String The name of the Azure DevOps project. .PARAMETER EnforceJobAuthScope Write - System.String Allowed values: , true, false Limit job authorization scope to the current project for non-release pipelines. .PARAMETER EnforceJobAuthScopeForReleases Write - System.String Allowed values: , true, false Limit job authorization scope to the current project for release pipelines. .PARAMETER EnforceReferencedRepoScopedToken Write - System.String Allowed values: , true, false Protect access to repositories in YAML pipelines. .PARAMETER EnforceSettableVar Write - System.String Allowed values: , true, false Limit variables that can be set at queue time. .PARAMETER PublishPipelineMetadata Write - System.String Allowed values: , true, false Publish metadata from pipelines. .PARAMETER StatusBadgesArePrivate Write - System.String Allowed values: , true, false Disable anonymous access to status badges. .PARAMETER DisableClassicPipelineCreation Write - System.String Allowed values: , true, false Disable creation of classic build and release pipelines. .PARAMETER DisableImpliedYAMLCiTrigger Write - System.String Allowed values: , true, false Disable implied YAML CI triggers. .EXAMPLE 1 This example hardens a project's pipeline settings. These are project-scoped. The organization-level equivalents are not yet managed by this module - see docs/ResourceRoadmap.md. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPipelineSettings 'HardenPipelines' { Ensure = 'Present' ProjectName = 'MyProject' EnforceJobAuthScope = 'true' EnforceReferencedRepoScopedToken = 'true' StatusBadgesArePrivate = 'true' } } } |