AzureDevOpsDscNative

1.2.0

en-US/about_AzDoAnalyticsPermission.help.txt

.NAME
    AzDoAnalyticsPermission
 
.SYNOPSIS
    DSC resource for managing project-level Analytics ACL permissions.
 
.DESCRIPTION
    This resource manages permissions in the 'Analytics' security namespace, controlling
    Power BI / OData access to a project's work-tracking analytics data. The namespace's ACL
    token shape is '$/{projectId}'.
 
.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 GroupName
    Required - System.String
    The name of the group to grant permissions to. This is a key property. Use the format [ProjectName]\GroupName or [TEAM FOUNDATION]\GroupName for organization-level groups.
 
.PARAMETER isInherited
    Write - System.Boolean
    Whether permissions are inherited from parent objects. Defaults to $true.
 
.PARAMETER Permissions
    Write - HashTable[]
    An array of hashtables mapping an action name (e.g. 'View analytics') to 'Allow' or 'Deny'.
 
.EXAMPLE 1
 
This example shows how to deny analytics read access for a group in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAnalyticsPermission 'AddAzDoAnalyticsPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'Read'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update analytics permissions for a group in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAnalyticsPermission 'UpdateAzDoAnalyticsPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'Read'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove explicit analytics permissions from a group, reverting
it to inherited permissions.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAnalyticsPermission 'RemoveAzDoAnalyticsPermission'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
        }
    }
}