Save-ManagedModule.md

external help file	PSPublishModule-help.xml
Module Name	PSPublishModule
online version	https://github.com/EvotecIT/PSPublishModule
schema	2.0.0

Save-ManagedModule

SYNOPSIS

Saves modules from a managed repository to an explicit module root.

SYNTAX

NameParameterSet (Default)

Save-ManagedModule [-Name] <string[]> [[-Path] <string>] [-Repository <string>] [-RepositoryName <string>] [-ProfileName <string>] [-Version <string>] [-MinimumVersion <string>] [-MaximumVersion <string>] [-VersionPolicy <string>] [-Prerelease] [-PackageCacheDirectory <string>] [-AsNupkg] [-IncludeXml] [-DependencyConcurrency <int>] [-ExpectedPackageSha256 <string>] [-TrustPolicy <ManagedModuleTrustPolicy>] [-RequireTrustedRepository] [-AllowedAuthor <string[]>] [-Credential <pscredential>] [-CredentialUserName <string>] [-CredentialSecret <string>] [-CredentialSecretFilePath <string>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-Force] [-AllowClobber] [-AcceptLicense] [-AuthenticodeCheck] [-SkipDependencyCheck] [-Plan] [-BundleMetadataPath <string>] [-ShowSummary] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObjectParameterSet

Save-ManagedModule [-InputObject] <ManagedModuleVersionInfo[]> [[-Path] <string>] [-Repository <string>] [-RepositoryName <string>] [-ProfileName <string>] [-PackageCacheDirectory <string>] [-AsNupkg] [-IncludeXml] [-DependencyConcurrency <int>] [-ExpectedPackageSha256 <string>] [-TrustPolicy <ManagedModuleTrustPolicy>] [-RequireTrustedRepository] [-AllowedAuthor <string[]>] [-Credential <pscredential>] [-CredentialUserName <string>] [-CredentialSecret <string>] [-CredentialSecretFilePath <string>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-Force] [-AllowClobber] [-AcceptLicense] [-AuthenticodeCheck] [-SkipDependencyCheck] [-Plan] [-BundleMetadataPath <string>] [-ShowSummary] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This command provides the module-save functionality of Save-PSResource through the same managed C# repository and archive engine as Install-ManagedModule. It accepts names or typed Find-ManagedModule output, saves unpacked modules or .nupkg files, and defaults to the current filesystem location when Path is omitted.

EXAMPLES

EXAMPLE 1

Save-ManagedModule -Name Company.Tools -Path C:\Modules

EXAMPLE 2

Save-ManagedModule -Name Company.Tools -RequiredVersion 1.2.0 -Repository C:\Packages -Path C:\Modules

EXAMPLE 3

Find-ManagedModule -Name Company.Tools -Version 1.2.0 -ProfileName CompanyModules | Save-ManagedModule -Path C:\OfflineModules -IncludeXml

EXAMPLE 4

Save-ManagedModule -Name Company.Tools -Version 1.2.0 -AsNupkg

PARAMETERS

-AcceptLicense

Accept package licenses when packages declare license acceptance is required.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-AllowClobber

Allow command exports to overlap with other modules in the destination root.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-AllowedAuthor

Allowed package author values from package metadata.

Type: String[]
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: RequiredAuthor, TrustedAuthor
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-AsNupkg

Save the selected packages as .nupkg files instead of unpacked module folders.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-AuthenticodeCheck

Validate Authenticode signatures for signable package files before saving.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-BundleMetadataPath

Optional path for offline bundle metadata written after successful saves.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: MetadataPath, OfflineBundleMetadataPath
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Credential

Optional repository credential.

Type: PSCredential
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-CredentialSecret

Optional repository credential secret.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: Password, Token
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-CredentialSecretFilePath

Optional path to a file containing the repository credential secret.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: CredentialPath, TokenPath
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-CredentialUserName

Optional repository credential username.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: UserName
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-DependencyConcurrency

Maximum number of dependency branches to save concurrently. Omit to use the managed engine default.

Type: Int32
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ExpectedPackageSha256

Expected SHA256 hash of the root package before it is extracted and saved.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: PackageSha256, Sha256
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Force

Overwrite an existing saved version.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-IncludeXml

Write PowerShellGet-compatible PSGetModuleInfo.xml metadata beside each saved unpacked module.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-InputObject

Module versions returned by Find-ManagedModule to save.

Type: ManagedModuleVersionInfo[]
Parameter Sets: InputObjectParameterSet
Aliases: ParentResource
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue, ByPropertyName)
Accept wildcard characters: True

-MaximumVersion

Maximum package version to save when Version is omitted.

Type: String
Parameter Sets: NameParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-MinimumVersion

Minimum package version to save when Version is omitted.

Type: String
Parameter Sets: NameParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Name

Module names to save.

Type: String[]
Parameter Sets: NameParameterSet
Aliases: ModuleName
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PackageCacheDirectory

Optional package cache directory.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Path

Destination module root. Defaults to the current filesystem location.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: DestinationPath, ModuleRoot
Possible values:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Plan

Return an inspectable save plan without writing files.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Prerelease

Include prerelease versions when resolving the latest version.

Type: SwitchParameter
Parameter Sets: NameParameterSet
Aliases: AllowPrerelease
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ProfileName

Saved repository profile name.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Proxy

Optional HTTP proxy used for repository requests.

Type: Uri
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ProxyCredential

Optional proxy credential used with Proxy.

Type: PSCredential
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Quiet

Suppress optional host summaries and progress-style output without changing pipeline result objects.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Repository

Repository URL, NuGet v3 service index, flat-container URL, or local folder feed.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: Source, RepositoryUri
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RepositoryName

Friendly repository name used in output.

Type: String
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RequireTrustedRepository

Require the selected repository profile to be marked trusted.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ShowSummary

Write a compact Spectre.Console summary for each plan or result.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipDependencyCheck

Skip installing dependencies declared by the package.

Type: SwitchParameter
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: SkipDependenciesCheck
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TrustPolicy

Optional typed repository/package trust policy.

Type: ManagedModuleTrustPolicy
Parameter Sets: NameParameterSet, InputObjectParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Version

Exact package version to save. When omitted, the latest repository version is used.

Type: String
Parameter Sets: NameParameterSet
Aliases: RequiredVersion
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-VersionPolicy

NuGet-style version range policy used when Version is omitted.

Type: String
Parameter Sets: NameParameterSet
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

• System.String[] PowerForge.ManagedModuleVersionInfo[]

OUTPUTS

• PowerForge.ManagedModuleInstallResult PowerForge.ManagedModuleInstallPlan

RELATED LINKS

• None