AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoArtifactFeedPermission.help.txt

.NAME
    AzDoArtifactFeedPermission
 
.SYNOPSIS
    DSC resource for managing role-based permissions on Azure Artifacts feeds.
 
.DESCRIPTION
    This resource manages role-based permissions on Azure Artifacts feeds, controlling which users
    or groups can read, publish, or administer packages. Unlike other permission resources,
    Artifact Feed permissions use a role model (Reader, Contributor, Collaborator, Administrator)
    rather than individual permission bits.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER FeedName
    Required - System.String
    The name of the artifact feed. This is a key property.
 
.PARAMETER Permissions
    Write - HashTable[]
 
.EXAMPLE 1
 
This example shows how to set role-based permissions on an Artifact feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeedPermission 'AddArtifactFeedPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
            Permissions = @(
                @{ identity = 'vsid-of-group'; role = 'Reader' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update role-based permissions on an Artifact feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeedPermission 'UpdateArtifactFeedPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
            Permissions = @(
                @{ identity = 'vsid-of-group'; role = 'Contributor' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions from an Artifact feed.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoArtifactFeedPermission 'RemoveArtifactFeedPermission'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            FeedName = 'MyFeed'
        }
    }
}