Import-AzContainerRegistryImage
Copies an image to this container registry from the specified container registry.
Syntax
ImportExpanded (Default)
Import-AzContainerRegistryImage
-RegistryName <String>
-ResourceGroupName <String>
-SourceImage <String>
[-SubscriptionId <String>]
[-Mode <ImportMode>]
[-Password <String>]
[-SourceRegistryUri <String>]
[-SourceResourceId <String>]
[-TargetTag <String[]>]
[-UntaggedTargetRepository <String[]>]
[-Username <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Import
Import-AzContainerRegistryImage
-RegistryName <String>
-ResourceGroupName <String>
-Parameter <IImportImageParameters>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Copies an image to this container registry from the specified container registry.
Examples
Example 1: Import image from a public/azure registry to an azure container registry.
Import-AzContainerRegistryImage -SourceImage library/busybox:latest -ResourceGroupName $resourceGroupName -RegistryName $RegistryName -SourceRegistryUri docker.io -TargetTag busybox:latest
Import busybox to ACR.
Note:
"library/" need to be add before source image.
"busybox:latest" => "library/busybox:latest"
Credential needed if source registry is not publicly available
SourceRegistryResourceId or SourceRegistryUri is required for this cmdlet
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Mode
When Force, any existing target tags will be overwritten.
When NoForce, any existing target tags will fail the operation before any copying begins.
Parameter properties
Type: ImportMode
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Parameter
.
To construct, see NOTES section for PARAMETER properties and create a hash table.
Parameter properties
Parameter sets
Import
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns true when the command succeeds
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Password
The password used to authenticate with the source registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RegistryName
The name of the container registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SourceImage
Repository name of the source image.Specify an image by repository ('hello-world').
This will use the 'latest' tag.Specify an image by tag ('hello-world:latest').Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123').
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SourceRegistryUri
The address of the source registry (e.g.
'mcr.microsoft.com').
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SourceResourceId
The resource identifier of the source Azure Container Registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SourceRegistryResourceId
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetTag
List of strings of the form repo[:tag].
When tag is omitted the source will be used (or 'latest' if source tag is also omitted).
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UntaggedTargetRepository
List of strings of repository names to do a manifest only copy.
No tag will be created.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Username
The username to authenticate with the source registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImportExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
