Skip to content

Install UniversalModuleFromRepository

github-actions[bot] edited this page Jul 19, 2026 · 1 revision

Install-UniversalModuleFromRepository

SYNOPSIS

Installs a module on PowerShell Universal from a resource repository.

SYNTAX

Install-UniversalModuleFromRepository [-ServerUrl] <String> [-AppToken] <String> [-ModuleName] <String>
 [-ModuleVersion] <String> [-RepositoryName] <String> [-RepositoryUrl] <String>
 [[-RepositoryAutoRemove] <Boolean>] [<CommonParameters>]

DESCRIPTION

Reconciles the requested PowerShell resource repository, triggers a synchronous module deployment, and optionally removes the repository.

EXAMPLES

EXAMPLE 1

Install-UniversalModuleFromRepository @installParameters

PARAMETERS

-AppToken

Application token used to authenticate API requests.

Type: String
Parameter Sets: (All)
Aliases:

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

-ModuleName

Name of the module to install.

Type: String
Parameter Sets: (All)
Aliases:

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

-ModuleVersion

Version of the module to install.

Type: String
Parameter Sets: (All)
Aliases:

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

-RepositoryAutoRemove

Whether to remove the repository after the deployment attempt.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RepositoryName

Name of the PowerShell resource repository on the server.

Type: String
Parameter Sets: (All)
Aliases:

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

-RepositoryUrl

URL or local path used by the PowerShell resource repository.

Type: String
Parameter Sets: (All)
Aliases:

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

-ServerUrl

Base URL of the PowerShell Universal server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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.

INPUTS

OUTPUTS

System.Void

NOTES

RELATED LINKS