Save-PSFResourceModule
SYNOPSIS
Short description
SYNTAX
ByName
Save-PSFResourceModule [-Name] <String[]> [-Path] <PathDirectoryParameter> [-Repository <String[]>]
[-Version <String>] [-Prerelease] [-SkipDependency] [-AuthenticodeCheck] [-Force] [-Credential <PSCredential>]
[-TrustRepository] [-Type <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
ByObject
Save-PSFResourceModule [-Path] <PathDirectoryParameter> [-Repository <String[]>] [-SkipDependency]
[-AuthenticodeCheck] [-Force] [-Credential <PSCredential>] [-TrustRepository] [-Type <String>]
-InputObject <Object[]> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Long description
EXAMPLES
EXAMPLE 1
Save-PSFResourceModule -Name Psmd.Templates.MiniModule -Path .
Downloads the resource module "Psmd.Templates.MiniModule" and extracts its resources into the current path.
PARAMETERS
-Name
Name of the module to download.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Where to store the resource.
Type: PathDirectoryParameter
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Repository
Repositories to install from. Respects the priority order of repositories. See Get-PSFRepository for available repositories (and their priority). Lower numbers are installed from first.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: ((Get-PSFrepository).Name | Sort-Object -Unique)
Accept pipeline input: False
Accept wildcard characters: False
-Version
Version constrains for the resource to save. Will use the latest version available within the limits. Examples:
- "1.0.0": EXACTLY this one version
- "1.0.0-1.999.999": Any version between the two limits (including the limit values)
- "[1.0.0-2.0.0)": Any version greater or equal to 1.0.0 but less than 2.0.0
- "2.3.0-": Any version greater or equal to 2.3.0.
Supported Syntax: <Prefix><Version><Connector><Version><Suffix>
Prefix: "[" (-ge) or "(" (-gt) or nothing (-ge) Version: A valid version of 2-4 elements or nothing Connector: A "," or a "-" Suffix: "]" (-le) or ")" (-lt) or nothing (-le)
Type: String
Parameter Sets: ByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Prerelease
Whether to include prerelease versions in the potential results.
Type: SwitchParameter
Parameter Sets: ByName
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SkipDependency
Do not include any dependencies. Works with PowerShellGet V1/V2 as well.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AuthenticodeCheck
Whether resource modules must be correctly signed by a trusted source. Uses "Get-PSFModuleSignature" for validation. Defaults to: $false Default can be configured under the 'PSFramework.NuGet.Install.AuthenticodeSignature.Check' setting.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-PSFConfigValue -FullName 'PSFramework.NuGet.Install.AuthenticodeSignature.Check')
Accept pipeline input: False
Accept wildcard characters: False
-Force
Overwrite files and folders that already exist in the target path. By default it will skip modules that do already exist in the target path.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Credential
The credentials to use for connecting to the Repository.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TrustRepository
Whether we should trust the repository installed from and NOT ask users for confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Type
What type of repository to download from. V2 uses classic Save-Module. V3 uses Save-PSResource. Availability depends on the installed PSGet module versions and configured repositories. Use Install-PSFPowerShellGet to deploy the latest versions of the package modules.
Only the version on the local computer matters, even when deploying to remote computers.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The resource module to install. Takes the output of Get-Module, Find-Module, Find-PSResource and Find-PSFModule, to specify the exact version and name of the resource module. Even when providing a locally available version, the resource module will still be downloaded from the repositories chosen.
Type: Object[]
Parameter Sets: ByObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-WhatIf
If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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.