Update-AzureRmContainerRegistry

Updates a container registry.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Update-AzureRmContainerRegistry
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmContainerRegistry
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-EnableAdminUser]
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmContainerRegistry
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-DisableAdminUser]
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmContainerRegistry
      [-EnableAdminUser]
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmContainerRegistry
      [-DisableAdminUser]
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmContainerRegistry
      [-Tag <Hashtable>]
      [-StorageAccountName <String>]
      [-Sku <String>]
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzureRmContainerRegistry cmdlet updates a container registry.

Examples

Example 1: Enable admin user for a specified container registry

PS C:\>Update-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -EnableAdminUser

  Container registry location: eastus

Registry Name        Sku        LoginServer                    CreationDate         Provisioni AdminUserE StorageAccountName
                                                                                    ngState    nabled
-------------        ---        -----------                    ------------         ---------- ---------- ------------------
MyRegistry           Basic      myregistry.azurecr.io          11/20/2017 10:05:... Succeeded  True

This command enables admin user for the specified container registry.

Example 2: Set the storage account used by a specified container registry

PS C:\>Update-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -StorageAccountName "mystorageaccount"

  Container registry location: eastus

Registry Name        Sku        LoginServer                    CreationDate         Provisioni AdminUserE StorageAccountName
                                                                                    ngState    nabled
-------------        ---        -----------                    ------------         ---------- ---------- ------------------
MyRegistry           Basic      myregistry.azurecr.io          11/20/2017 10:05:... Succeeded  True       mystorageaccount

This command sets the specified container registry to use an existing storage account `mystorageaccount` in the same subscription.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAdminUser

Enable admin user for the container registry.

Type:SwitchParameter
Aliases:DisableAdmin
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EnableAdminUser

Enable admin user for the container registry.

Type:SwitchParameter
Aliases:EnableAdmin
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Container Registry Name.

Type:String
Aliases:ContainerRegistryName, RegistryName, ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Resource Group Name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

The container registry resource id

Type:String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Sku

Container Registry SKU.

Type:String
Aliases:ContainerRegistrySku, RegistrySku
Accepted values:Classic, Basic, Premium, Standard
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageAccountName

The name of an existing storage account.

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

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSContainerRegistry