Update-AzContainerRegistry
Update a container registry with the specified parameters.
Syntax
UpdateExpanded (Default)
Update-AzContainerRegistry
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AnonymousPullEnabled]
[-AzureAdAuthenticationAsArmPolicyStatus <String>]
[-DataEndpointEnabled]
[-EnableAdminUser]
[-EnableSystemAssignedIdentity <Boolean>]
[-EncryptionStatus <String>]
[-ExportPolicyStatus <String>]
[-IdentityPrincipalId <String>]
[-IdentityTenantId <String>]
[-KeyVaultPropertyIdentity <String>]
[-KeyVaultPropertyKeyIdentifier <String>]
[-NetworkRuleBypassOption <String>]
[-NetworkRuleSetDefaultAction <String>]
[-NetworkRuleSetIPRule <IIPRule[]>]
[-PublicNetworkAccess <String>]
[-QuarantinePolicyStatus <String>]
[-RetentionPolicyDay <Int32>]
[-RetentionPolicyStatus <String>]
[-Sku <String>]
[-SoftDeletePolicyRetentionDay <Int32>]
[-SoftDeletePolicyStatus <String>]
[-Tag <Hashtable>]
[-TrustPolicyStatus <String>]
[-TrustPolicyType <String>]
[-UserAssignedIdentity <String[]>]
[-ZoneRedundancy <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzContainerRegistry
-InputObject <IContainerRegistryIdentity>
[-AnonymousPullEnabled]
[-AzureAdAuthenticationAsArmPolicyStatus <String>]
[-DataEndpointEnabled]
[-EnableAdminUser]
[-EnableSystemAssignedIdentity <Boolean>]
[-EncryptionStatus <String>]
[-ExportPolicyStatus <String>]
[-IdentityPrincipalId <String>]
[-IdentityTenantId <String>]
[-KeyVaultPropertyIdentity <String>]
[-KeyVaultPropertyKeyIdentifier <String>]
[-NetworkRuleBypassOption <String>]
[-NetworkRuleSetDefaultAction <String>]
[-NetworkRuleSetIPRule <IIPRule[]>]
[-PublicNetworkAccess <String>]
[-QuarantinePolicyStatus <String>]
[-RetentionPolicyDay <Int32>]
[-RetentionPolicyStatus <String>]
[-Sku <String>]
[-SoftDeletePolicyRetentionDay <Int32>]
[-SoftDeletePolicyStatus <String>]
[-Tag <Hashtable>]
[-TrustPolicyStatus <String>]
[-TrustPolicyType <String>]
[-UserAssignedIdentity <String[]>]
[-ZoneRedundancy <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update a container registry with the specified parameters.
Examples
Example 1: Enable admin user for a specified container registry
Update-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -EnableAdminUser
Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled
---- ------- ----------- ------------ ----------------- ----------------
RegistryExample Basic registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded True
This command enables admin user for the specified container registry.
Parameters
-AnonymousPullEnabled
Enables registry-wide pull from unauthenticated clients.
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
-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
-AzureAdAuthenticationAsArmPolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-DataEndpointEnabled
Enable a single data endpoint per region for serving data.
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
-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
-EnableAdminUser
The value that indicates whether the admin user is enabled.
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
-EnableSystemAssignedIdentity
Determines whether to enable a system-assigned identity for the resource.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionStatus
Indicates whether or not the encryption is enabled for container registry.
Parameter properties
Type: String
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
-ExportPolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-IdentityPrincipalId
The principal ID of resource identity.
Parameter properties
Type: String
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
-IdentityTenantId
The tenant ID of resource.
Parameter properties
Type: String
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
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPropertyIdentity
The client id of the identity which will be used to access key vault.
Parameter properties
Type: String
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
-KeyVaultPropertyKeyIdentifier
Key vault uri to access the encryption key.
Parameter properties
Type: String
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
-Name
The name of the container registry.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: RegistryName, ResourceName, ContainerRegistryName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NetworkRuleBypassOption
Whether to allow trusted Azure services to access a network restricted registry.
Parameter properties
Type: String
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
-NetworkRuleSetDefaultAction
The default action of allow or deny when no other rules match.
Parameter properties
Type: String
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
-NetworkRuleSetIPRule
The IP ACL rules.
Parameter properties
Type: IIPRule [ ]
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
-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
-PublicNetworkAccess
Whether or not public network access is allowed for the container registry.
Parameter properties
Type: String
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
-QuarantinePolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-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
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RetentionPolicyDay
The number of days to retain an untagged manifest after which it gets purged.
Parameter properties
Type: Int32
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
-RetentionPolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-Sku
The SKU name of the container registry.
Required for registry creation.
Parameter properties
Type: String
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
-SoftDeletePolicyRetentionDay
The number of days after which a soft-deleted item is permanently deleted.
Parameter properties
Type: Int32
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
-SoftDeletePolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-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
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
The tags of the resource.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False Aliases: Tags
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TrustPolicyStatus
The value that indicates whether the policy is enabled or not.
Parameter properties
Type: String
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
-TrustPolicyType
The type of trust policy.
Parameter properties
Type: String
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
-UserAssignedIdentity
The array of user assigned identities associated with the resource.
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
Parameter properties
Type: String [ ]
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
-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
-ZoneRedundancy
Whether or not zone redundancy is enabled for this container registry
Parameter properties
Type: String
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
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
