AzureDevOpsDscNative

1.1.0

en-US/about_AzDoArtifactFeed.help.txt

.NAME
    AzDoArtifactFeed
 
.SYNOPSIS
    DSC resource for managing Azure Artifacts feeds.
 
.DESCRIPTION
    This resource manages Azure Artifacts feeds. A feed can be project-scoped (set ProjectName) or
    organization-scoped (omit ProjectName). Artifact feeds allow teams to share packages (NuGet,
    npm, Maven, Python, Universal Packages).
 
.PARAMETER FeedName
    Key - System.String
    The name of the artifact feed. This property is mandatory and is the key property for the resource.
 
.PARAMETER ProjectName
    Write - System.String
    The name of the Azure DevOps project. Optional ? when supplied, the feed is project-scoped; when omitted, the feed is organization-scoped.
 
.PARAMETER Description
    Write - System.String
    An optional description for the feed.
 
.PARAMETER BadgesEnabled
    Write - System.Boolean
    Whether to enable badges for the feed. Defaults to $false.
 
.PARAMETER HideDeletedPackageVersions
    Write - System.Boolean
    Whether package versions that have been deleted are hidden from feed listings.
    Defaults to $true.
 
.PARAMETER UpstreamEnabled
    Write - System.Boolean
    Whether to enable upstream sources. Defaults to $true.
 
.EXAMPLE 1
 
This example shows how to create an Azure Artifacts feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeed 'AddArtifactFeed'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
            Description = 'My package feed'
            BadgesEnabled = $false
            UpstreamEnabled = $true
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update an Azure Artifacts feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeed 'UpdateArtifactFeed'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
            Description = 'Updated package feed'
            BadgesEnabled = $true
            UpstreamEnabled = $false
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove an Azure Artifacts feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeed 'RemoveArtifactFeed'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
        }
    }
}