en-US/about_AzDoArtifactFeedSettings.help.txt
|
.NAME
AzDoArtifactFeedSettings .SYNOPSIS DSC resource for managing the settings of an Azure Artifacts feed. .DESCRIPTION Manages the configurable settings of an existing feed: its upstream sources, whether deleted package versions are hidden, and the artifact lifecycle (retention policy). Retention is only managed when 'RetentionCountLimit' is greater than zero. .PARAMETER ProjectName Key - System.String The name of the Azure DevOps project. This property is mandatory and serves as the key property for the resource. .PARAMETER FeedName Required - System.String The name of the artifact feed whose settings are managed. This property is mandatory. The feed itself is managed by the AzDoArtifactFeed resource. .PARAMETER UpstreamSources Write - HashTable[] .PARAMETER HideDeletedPackageVersions Write - System.Boolean Whether deleted package versions are hidden. Defaults to $true. .PARAMETER RetentionCountLimit Write - System.Int32 The maximum number of versions to retain per package. A value of 0 (the default) means the retention policy is not managed by this resource. .PARAMETER DaysToKeepRecentlyDownloadedPackages Write - System.Int32 The number of days to keep recently downloaded packages, used with the retention policy. .EXAMPLE 1 This example shows how to configure the settings of an Azure Artifacts feed, including upstream sources, hiding deleted package versions, and the artifact lifecycle (retention policy). Use AzDoArtifactFeedPermission to manage who can read or contribute to the feed. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoArtifactFeedSettings 'ConfigureMyFeed' { Ensure = 'Present' ProjectName = 'MyProject' FeedName = 'MyFeed' UpstreamSources = @('npmjs', 'NuGet Gallery') HideDeletedPackageVersions = $true # Artifact lifecycle (retention policy) RetentionCountLimit = 100 DaysToKeepRecentlyDownloadedPackages = 30 } } } |