BcContainerHelper.psd1

#
# Module manifest for module 'BcContainerHelper'
#
# Generated by: Freddy Kristiansen
#
# Generated on: 3/6/2024
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'BcContainerHelper.psm1'

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

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

# ID used to uniquely identify this module
GUID = '8e034fbc-8c30-446d-bbc3-5b3be5392491'

# Author of this module
Author = 'Freddy Kristiansen'

# Company or vendor of this module
CompanyName = 'Microsoft'

# Copyright statement for this module
Copyright = '(c) 2022 Microsoft. All rights reserved.'

# Description of the functionality provided by this module
Description = 'PowerShell module, which makes it easier to work with Business Central Containers on Docker.'

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

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

# Minimum version of the Windows 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 = @()

# 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 = 'Add-FontsToBcContainer', 'Add-GitToAlProjectFolder', 
               'AddTelemetryProperty', 'Backup-BcContainerDatabases', 
               'Cancel-AppSourceSubmission', 'Check-BcContainerHelperPermissions', 
               'Clean-BcContainerDatabase', 'Compile-AppInBcContainer', 
               'Compile-AppWithBcCompilerFolder', 'Compile-ObjectsInNavContainer', 
               'Convert-AlcOutputToDevOps', 'Convert-BcAppsToRuntimePackages', 
               'Convert-ModifiedObjectsToAl', 'ConvertTo-HashTable', 
               'ConvertTo-OrderedDictionary', 'Convert-Txt2Al', 'Copy-AlSourceFiles', 
               'Copy-AppFilesToCompilerFolder', 'Copy-AppFilesToFolder', 
               'Copy-BcEnvironment', 'Copy-CompanyInBcContainer', 
               'Copy-FileFromBcContainer', 'Copy-FileFromCloudBcContainer', 
               'Copy-FileToBcContainer', 'Copy-FileToCloudBcContainer', 
               'Copy-ItemFromBcContainer', 'Copy-ItemToBcContainer', 
               'Create-AadAppsForNav', 'Create-AadUsersInBcContainer', 
               'Create-AlProjectFolderFromBcContainer', 
               'Create-CustomTraefikImage', 'Create-MyDeltaFolder', 
               'Create-MyOriginalFolder', 'Create-SymbolsFileFromAppFile', 
               'Download-Artifacts', 'Download-BcNuGetPackageToFolder', 
               'Download-File', 'Enter-BcContainer', 
               'Export-BcContainerDatabasesAsBacpac', 
               'Export-ModifiedObjectsAsDeltas', 'Export-NavContainerObjects', 
               'Extract-AppFileToFolder', 'Extract-FilesFromBcContainerImage', 
               'Extract-FilesFromStoppedBcContainer', 'Find-BcNuGetPackage', 
               'Flush-ContainerHelperCache', 'Generate-SymbolsInNavContainer', 
               'Get-AlLanguageExtensionFromArtifacts', 'Get-AlpacaBcContainer', 
               'Get-AlpacaBcContainerEventLog', 'Get-AppJsonFromAppFile', 
               'Get-AppSourceProduct', 'Get-AppSourceSubmission', 
               'Get-AzureFeedWildcardVersion', 'Get-BCArtifactUrl', 
               'Get-BcContainerApiCompanyId', 'Get-BcContainerApp', 
               'Get-BcContainerAppInfo', 'Get-BcContainerAppRuntimePackage', 
               'Get-BcContainerArtifactUrl', 'Get-BcContainerBcUser', 
               'Get-BcContainerCountry', 'Get-BcContainerDebugInfo', 
               'Get-BcContainerEula', 'Get-BcContainerEventLog', 
               'Get-BcContainerGenericTag', 'Get-BcContainerId', 
               'Get-BcContainerImageLabels', 'Get-BcContainerImageName', 
               'Get-BcContainerImageTags', 'Get-BcContainerIpAddress', 
               'Get-BcContainerLegal', 'Get-BcContainerLicenseInformation', 
               'Get-BcContainerName', 'Get-BcContainerNavVersion', 
               'Get-BcContainerOsVersion', 'Get-BcContainerPath', 
               'Get-BcContainerPlatformVersion', 'Get-BcContainers', 
               'Get-BcContainerServerConfiguration', 'Get-BcContainerSession', 
               'Get-BcContainerSharedFolders', 'Get-BcContainerTenants', 
               'Get-BcEnvironmentAvailableRestorePeriods', 
               'Get-BcEnvironmentDatabaseExportHistory', 
               'Get-BcEnvironmentInstalledExtensions', 
               'Get-BcEnvironmentOperations', 'Get-BcEnvironmentPublishedApps', 
               'Get-BcEnvironments', 'Get-BcEnvironmentScheduledUpgrade', 
               'Get-BcEnvironmentUpdateWindow', 'Get-BcEnvironmentUsedStorage', 
               'Get-BcNotificationRecipients', 'Get-BcNuGetPackage', 
               'Get-BcNuGetPackageId', 'Get-BestBcContainerImageName', 
               'Get-BestGenericImageName', 'Get-CloudBcContainerEventLog', 
               'Get-CloudBcContainerServerConfiguration', 
               'Get-CompanyInBcContainer', 'Get-LatestAlLanguageExtensionUrl', 
               'Get-LocaleFromCountry', 'Get-NavArtifactUrl', 
               'Get-NavVersionFromVersionInfo', 
               'Get-PackageInfoFromRapidStartFile', 'Get-PlainText', 
               'Get-TestsFromBcContainer', 'Import-BcContainerLicense', 
               'Import-CertificateToBcContainer', 
               'Import-ConfigPackageInBcContainer', 'Import-DeltasToNavContainer', 
               'Import-ObjectsToNavContainer', 
               'Import-PfxCertificateToBcContainer', 
               'Import-TestToolkitToBcContainer', 'InitTelemetryScope', 
               'Install-AzDevops', 'Install-BcAppFromAppSource', 
               'Install-BcContainerApp', 
               'Install-NAVSipCryptoProviderFromBcContainer', 
               'Invoke-BcContainerApi', 'invoke-gh', 'invoke-git', 
               'Invoke-IngestionApiDelete', 'Invoke-IngestionApiGet', 
               'Invoke-IngestionApiGetCollection', 'Invoke-IngestionApiPost', 
               'Invoke-IngestionApiPut', 'Invoke-NavContainerCodeunit', 
               'Invoke-ScriptInAlpacaBcContainer', 'Invoke-ScriptInBcContainer', 
               'New-AadAppsForBc', 'New-ALGoAppSourceContext', 'New-ALGoAuthContext', 
               'New-ALGoNugetContext', 'New-ALGoRepo', 'New-ALGoStorageContext', 
               'New-AlpacaBcContainer', 'New-AppSourceSubmission', 
               'New-BcAuthContext', 'New-BcCompilerFolder', 'New-BcContainer', 
               'New-BcContainerBcUser', 'New-BcContainerTenant', 
               'New-BcContainerWindowsUser', 'New-BcContainerWizard', 
               'New-BcEnvironment', 'New-BcEnvironmentDatabaseExport', 'New-BcImage', 
               'New-BcNotificationRecipient', 'New-BcNuGetPackage', 
               'New-CompanyInBcContainer', 'New-DesktopShortcut', 
               'New-LetsEncryptCertificate', 'Open-BcContainer', 
               'Promote-AppSourceSubmission', 'Publish-BcContainerApp', 
               'Publish-BcNuGetPackageToContainer', 
               'Publish-BuildOutputToAzureFeed', 'Publish-BuildOutputToStorage', 
               'Publish-NewApplicationToBcContainer', 
               'Publish-PerTenantExtensionApps', 'Push-BcNuGetPackage', 
               'RegisterTelemetryScope', 'Remove-AadAppsForBc', 
               'Remove-AlpacaBcContainer', 'Remove-BcCompilerFolder', 
               'Remove-BcContainer', 'Remove-BcContainerSession', 
               'Remove-BcContainerTenant', 'Remove-BcDatabase', 
               'Remove-BcEnvironment', 'Remove-CompanyInBcContainer', 
               'Remove-ConfigPackageInBcContainer', 'Remove-DesktopShortcut', 
               'Rename-BcEnvironment', 'Renew-BcAuthContext', 
               'Renew-LetsEncryptCertificate', 'Repair-BcContainerApp', 
               'Replace-BcServerContainer', 'Replace-DependenciesInAppFile', 
               'Reschedule-BcEnvironmentUpgrade', 
               'Resolve-DependenciesFromAzureFeed', 'Restart-BcContainer', 
               'Restart-BcContainerServiceTier', 'Restore-BcDatabaseFromArtifacts', 
               'Restore-BcEnvironment', 'Restore-DatabasesInBcContainer', 
               'Run-AlCops', 'Run-AlPipeline', 'Run-AlValidation', 
               'Run-BCPTTestsInBcContainer', 'Run-ConnectionTestToBcContainer', 
               'Run-TestsInBcContainer', 'Set-BcContainerFeatureKeys', 
               'Set-BcContainerKeyVaultAadAppAndCertificate', 
               'Set-BcContainerServerConfiguration', 
               'Set-BcEnvironmentApplicationInsightsKey', 
               'Set-BcEnvironmentUpdateWindow', 'Setup-BcContainerTestUsers', 
               'Setup-TraefikContainerForBcContainers', 'Sign-BcContainerApp', 
               'Sort-AppFilesByDependencies', 'Sort-AppFoldersByDependencies', 
               'Start-AlpacaBcContainer', 'Start-BcContainer', 
               'Start-BcContainerAppDataUpgrade', 'Stop-AlpacaBcContainer', 
               'Stop-BcContainer', 'Sync-BcContainerApp', 'Test-BcContainer', 
               'TrackException', 'TrackTrace', 'UnInstall-BcContainerApp', 
               'UnPublish-BcContainerApp', 
               'UploadImportAndApply-ConfigPackageInBcContainer', 
               'Wait-AlpacaBcContainerReady', 'Wait-BcContainerReady', 
               'Wait-BcEnvironmentsReady', 'Write-BcContainerHelperWelcomeText'

# 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 = 'Add-FontsToNavContainer', 'Backup-NavContainerDatabases', 
               'Check-NavContainerHelperPermissions', 'Compile-AppInNavContainer', 
               'Convert-AlcOutputToAzureDevOps', 'Copy-BcNuGetPackageToFolder', 
               'Copy-CompanyInNavContainer', 'Copy-FileFromAlpacaBcContainer', 
               'Copy-FileFromNavContainer', 'Copy-FileToAlpacaBcContainer', 
               'Copy-FileToNavContainer', 'Create-AadAppsForBC', 
               'Create-AadUsersInNavContainer', 
               'Create-AlProjectFolderFromNavContainer', 'Enter-NavContainer', 
               'Export-NavContainerDatabasesAsBacpac', 
               'Extract-FilesFromNavContainerImage', 
               'Extract-FilesFromStoppedNavContainer', 'Get-ALGoAuthContext', 
               'Get-AlpacaBcContainerServerConfiguration', 
               'Get-BcAvailableRestorePeriods', 'Get-BcDatabaseExportHistory', 
               'Get-BcEnvironmentsAvailableRestorePeriods', 
               'Get-BcEnvironmentsOperations', 'Get-BcEnvironmentsUsedStorage', 
               'Get-BcInstalledExtensions', 'Get-BcOperations', 
               'Get-BcPublishedApps', 'Get-BcScheduledUpgrade', 'Get-BcUpdateWindow', 
               'Get-BcUsedStorage', 'Get-BestNavContainerImageName', 
               'Get-CompanyInNavContainer', 'Get-NavContainerApiCompanyId', 
               'Get-NavContainerApp', 'Get-NavContainerAppInfo', 
               'Get-NavContainerAppRuntimePackage', 'Get-NavContainerArtifactUrl', 
               'Get-NavContainerCountry', 'Get-NavContainerDebugInfo', 
               'Get-NavContainerEula', 'Get-NavContainerEventLog', 
               'Get-NavContainerGenericTag', 'Get-NavContainerId', 
               'Get-NavContainerImageLabels', 'Get-NavContainerImageName', 
               'Get-NavContainerImageTags', 'Get-NavContainerIpAddress', 
               'Get-NavContainerLegal', 'Get-NavContainerLicenseInformation', 
               'Get-NavContainerName', 'Get-NavContainerNavUser', 
               'Get-NavContainerNavVersion', 'Get-NavContainerOsVersion', 
               'Get-NavContainerPath', 'Get-NavContainerPlatformVersion', 
               'Get-NavContainers', 'Get-NavContainerServerConfiguration', 
               'Get-NavContainerSession', 'Get-NavContainerSharedFolders', 
               'Get-NavContainerTenants', 'Get-TestsFromNavContainer', 
               'Import-ConfigPackageInNavContainer', 'Import-NavContainerLicense', 
               'Import-PfxCertificateToNavContainer', 
               'Import-TestToolkitToNavContainer', 'Install-NavContainerApp', 
               'Install-NAVSipCryptoProviderFromNavContainer', 
               'Invoke-NavContainerApi', 'Invoke-ScriptInNavContainer', 
               'New-BcDatabaseExport', 'New-CompanyInNavContainer', 
               'New-NavContainer', 'New-NavContainerNavUser', 
               'New-NavContainerTenant', 'New-NavContainerWindowsUser', 
               'New-NavContainerWizard', 'New-NavImage', 'Open-NavContainer', 
               'Publish-NavContainerApp', 'Publish-NewApplicationToNavContainer', 
               'Remove-CompanyInNavContainer', 
               'Remove-ConfigPackageInNavContainer', 'Remove-NavContainer', 
               'Remove-NavContainerSession', 'Remove-NavContainerTenant', 
               'Repair-NavContainerApp', 'Replace-NavServerContainer', 
               'Reschedule-BcUpgrade', 'Restart-NavContainer', 
               'Restore-DatabasesInNavContainer', 
               'Run-ConnectionTestToNavContainer', 'Run-TestsInNavContainer', 
               'Setup-NavContainerTestUsers', 
               'Setup-TraefikContainerForNavContainers', 'Sign-NavContainerApp', 
               'Start-NavContainer', 'Start-NavContainerAppDataUpgrade', 
               'Stop-NavContainer', 'Sync-NavContainerApp', 'Test-NavContainer', 
               'UnInstall-NavContainerApp', 'UnPublish-NavContainerApp', 
               'Wait-NavContainerReady'

# 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 = @()

        # A URL to the license for this module.
        LicenseUri = 'https://github.com/microsoft/navcontainerhelper/blob/master/LICENSE'

        # A URL to the main website for this project.
        ProjectUri = 'https://github.com/microsoft/navcontainerhelper'

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

        # ReleaseNotes of this module
        ReleaseNotes = '6.0.7
Issue 3347 Download-BcNuGetPackageToFolder to support package description for app name if title is not specified
Support dependency version templates on NuGet packages
Issue 3349 NuGet package files section name is wrong when using azure blob storage direct download url
Issue 3358 Run-TestsInBcContainer using Windows Authentication doesn''t work if exactly one user exists in the tenant
Fix error in Get-BcContainerAppInfo in NextMajor
Check-BcContainerHelperPermissions didn''t work on PS7
Issue #3379 Adding -installCertificateOnHost to New-BcContainer didn''t work when running PS7 (silently failed)
Issue #3376 Regression - Download-Artifacts stopped downloading pre-requisites
Issue 3371 Unable to get companyname from Windows Users when running tests
Disallow invoking Run-ALPipeline with `keepContainer` without specifying credentials to use
Issue 3369 Patch images version 1.0.2.15 with an updated installer
Add awareness of Windows 11 23H2
Patch images version 1.0.2.15 with an updated prompt.ps1, which loads PowerShell 7 modules when running pwsh
Add new setting usePwshForBC24, which is default true to instruct Invoke-ScriptInBcContainer to use pwsh (PS7) instead of powershell (PS5) when invoking scripts in BC 24+ containers
Add parameter usePwsh to Open-BcContainer and Invoke-ScriptInBcContainer, defaulted to the value of the usePwshForBC24 setting'


        # Prerelease string of this module
        Prerelease = 'preview1156'

        # 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 = ''

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

}