Install-DockerImage

SYNOPSIS

Install image

SYNTAX

Install-DockerImage [[-Registry] <String>] [-Repository] <String> [[-Tag] <String>] [-AllTags]
 [[-Digest] <String>] [[-Timeout] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Installs a docker image in the service from a repository. Wraps the command `docker pull`.

EXAMPLES

EXAMPLE 1

Install-DockerImage -Repository 'microsoft/nanoserver'

PARAMETERS

-Registry

Specifies the registry that contains the repository or image.

Type: String
Parameter Sets: (All)
Aliases:

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

-Repository

Specifies the name of the repository of the image to install.

Type: String
Parameter Sets: (All)
Aliases: Name, ImageName

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

-Tag

Specifies the tag of the image to install.

Type: String
Parameter Sets: (All)
Aliases:

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

-AllTags

Specifies if the images for all tags should be installed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Digest

Specifies the digest of the specific image that should be installed.

Type: String
Parameter Sets: (All)
Aliases:

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

-Timeout

Specifies the number of seconds to wait for the command to finish.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 300
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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.

INPUTS

OUTPUTS

Image: Returns `Image` objects for the images that are installed and match the parameter.

NOTES

https://docs.docker.com/engine/reference/commandline/pull/

Uninstall-Image