PSRule.Rules.AzureDevOps.psd1

#
# Module manifest for module 'PSRule.Rules.AzureDevOps'
#
# Generated by: Roderick Bant
#
# Generated on: 01/20/2024
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'PSRule.Rules.AzureDevOps.psm1'

# Version number of this module.
ModuleVersion = '0.5.0'

# Supported PSEditions
CompatiblePSEditions = 'Core', 'Desktop'

# ID used to uniquely identify this module
GUID = 'bb42e16e-b0af-46be-9ac1-51e2f6bb6e8d'

# Author of this module
Author = 'Roderick Bant'

# Company or vendor of this module
CompanyName = 'Private Entity'

# Copyright statement for this module
Copyright = '(c) Roderick Bant. All rights reserved.'

# Description of the functionality provided by this module
Description = 'PSRule rules module for Azure DevOps project configuration best practices. This module helps to audit an Azure DevOps project for secure and best practice configuration. The module requires PSRule to be installed.'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '5.1'

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# ClrVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @('PSRule')

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = 'Export-AzDevOpsRuleData', 'Export-AzDevOpsOrganizationRuleData', 
               'Connect-AzDevOps', 'Disconnect-AzDevOps'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = 'PSRule-rules','PSRule','AzureDevOps','Security'

        # A URL to the license for this module.
        LicenseUri = 'https://github.com/cloudyspells/PSRule.Rules.AzureDevOps/blob/main/LICENSE'

        # A URL to the main website for this project.
        ProjectUri = 'https://github.com/cloudyspells/PSRule.Rules.AzureDevOps'

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = '## Whats new:

This release brings new internal export functionality to the module and expands the capabilities in exporting Access Control Lists (ACL). These capabilities enable 15 new rules for validating best-practices in setting permission inheritance and misconfigurations of the Project Valid Users group in Azure DevOps.

### Module Internal Functions

- Get-AzDevOpsProjectAcls
- Get-AzDevOpsEnvironmentAcls
- Get-AzDevOpsServiceConnectionAcls
- Get-AzDevOpsVariableGroupAcls

### Rules

- Azure.DevOps.Pipelines.Core.ProjectValidUsers
- Azure.DevOps.Pipelines.Environments.InheritedPermissions
- Azure.DevOps.Pipelines.Environments.ProjectValidUsers
- Azure.DevOps.Pipelines.Releases.ProjectValidUsers
- Azure.DevOps.Project.MainEnvironmentAcl.ProjectValidUsers
- Azure.DevOps.Project.MainPipelineAcl.ProjectValidUsers
- Azure.DevOps.Project.MainReleaseDefinitionAcl.ProjectValidUsers
- Azure.DevOps.Project.MainRepositoryAcl.ProjectValidUsers
- Azure.DevOps.Project.MainServiceConnectionAcl.ProjectValidUsers
- Azure.DevOps.Project.MainVariableGroupAcl.ProjectValidUsers
- Azure.DevOps.Repos.ProjectValidUsers
- Azure.DevOps.ServiceConnections.InheritedPermissions
- Azure.DevOps.ServiceConnections.ProjectValidUsers
- Azure.DevOps.Tasks.VariableGroup.InheritedPermissions
- Azure.DevOps.Tasks.VariableGroup.ProjectValidUsers

### Bug fixes

- Undocumented bug where no ACL was returned when Release or Build Definition is in a folder
'


        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

 } # End of PrivateData hashtable

# HelpInfo URI of this module
HelpInfoURI = 'https://github.com/cloudyspells/PSRule.Rules.AzureDevOps/wiki'

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}