Update-AzContainerRegistry
Updates a container registry with the specified parameters.
Syntax
Update-AzContainerRegistry
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AnonymousPullEnabled]
[-AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus>]
[-DataEndpointEnabled]
[-EnableAdminUser]
[-EncryptionStatus <EncryptionStatus>]
[-ExportPolicyStatus <ExportPolicyStatus>]
[-IdentityPrincipalId <String>]
[-IdentityTenantId <String>]
[-IdentityType <ResourceIdentityType>]
[-IdentityUserAssignedIdentity <Hashtable>]
[-KeyVaultPropertyIdentity <String>]
[-KeyVaultPropertyKeyIdentifier <String>]
[-NetworkRuleBypassOption <NetworkRuleBypassOptions>]
[-NetworkRuleSetDefaultAction <DefaultAction>]
[-NetworkRuleSetIPRule <IIPRule[]>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-QuarantinePolicyStatus <PolicyStatus>]
[-RetentionPolicyDay <Int32>]
[-RetentionPolicyStatus <PolicyStatus>]
[-Sku <SkuName>]
[-SoftDeletePolicyRetentionDay <Int32>]
[-SoftDeletePolicyStatus <PolicyStatus>]
[-Tag <Hashtable>]
[-TrustPolicyStatus <PolicyStatus>]
[-TrustPolicyType <TrustPolicyType>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzContainerRegistry
-InputObject <IContainerRegistryIdentity>
[-AnonymousPullEnabled]
[-AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus>]
[-DataEndpointEnabled]
[-EnableAdminUser]
[-EncryptionStatus <EncryptionStatus>]
[-ExportPolicyStatus <ExportPolicyStatus>]
[-IdentityPrincipalId <String>]
[-IdentityTenantId <String>]
[-IdentityType <ResourceIdentityType>]
[-IdentityUserAssignedIdentity <Hashtable>]
[-KeyVaultPropertyIdentity <String>]
[-KeyVaultPropertyKeyIdentifier <String>]
[-NetworkRuleBypassOption <NetworkRuleBypassOptions>]
[-NetworkRuleSetDefaultAction <DefaultAction>]
[-NetworkRuleSetIPRule <IIPRule[]>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-QuarantinePolicyStatus <PolicyStatus>]
[-RetentionPolicyDay <Int32>]
[-RetentionPolicyStatus <PolicyStatus>]
[-Sku <SkuName>]
[-SoftDeletePolicyRetentionDay <Int32>]
[-SoftDeletePolicyStatus <PolicyStatus>]
[-Tag <Hashtable>]
[-TrustPolicyStatus <PolicyStatus>]
[-TrustPolicyType <TrustPolicyType>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Updates 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 TrueThis command enables admin user for the specified container registry.
Parameters
-AnonymousPullEnabled
Enables registry-wide pull from unauthenticated clients.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureAdAuthenticationAsArmPolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | AzureAdAuthenticationAsArmPolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataEndpointEnabled
Enable a single data endpoint per region for serving data.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableAdminUser
The value that indicates whether the admin user is enabled.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionStatus
Indicates whether or not the encryption is enabled for container registry.
| Type: | EncryptionStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExportPolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | ExportPolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityPrincipalId
The principal ID of resource identity.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityTenantId
The tenant ID of resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityType
The identity type.
| Type: | ResourceIdentityType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityUserAssignedIdentity
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IContainerRegistryIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-KeyVaultPropertyIdentity
The client id of the identity which will be used to access key vault.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyVaultPropertyKeyIdentifier
Key vault uri to access the encryption key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the container registry.
| Type: | String |
| Aliases: | RegistryName, ResourceName, ContainerRegistryName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetworkRuleBypassOption
Whether to allow trusted Azure services to access a network restricted registry.
| Type: | NetworkRuleBypassOptions |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetworkRuleSetDefaultAction
The default action of allow or deny when no other rules match.
| Type: | DefaultAction |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetworkRuleSetIPRule
The IP ACL rules. To construct, see NOTES section for NETWORKRULESETIPRULE properties and create a hash table.
| Type: | IIPRule[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublicNetworkAccess
Whether or not public network access is allowed for the container registry.
| Type: | PublicNetworkAccess |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-QuarantinePolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | PolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetentionPolicyDay
The number of days to retain an untagged manifest after which it gets purged.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetentionPolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | PolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sku
The SKU name of the container registry. Required for registry creation.
| Type: | SkuName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SoftDeletePolicyRetentionDay
The number of days after which a soft-deleted item is permanently deleted.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SoftDeletePolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | PolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
The tags for the container registry.
| Type: | Hashtable |
| Aliases: | Tags |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrustPolicyStatus
The value that indicates whether the policy is enabled or not.
| Type: | PolicyStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrustPolicyType
The type of trust policy.
| Type: | TrustPolicyType |
| 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IContainerRegistryIdentity>: Identity Parameter
[AgentPoolName <String>]: The name of the agent pool.[CacheRuleName <String>]: The name of the cache rule.[ConnectedRegistryName <String>]: The name of the connected registry.[CredentialSetName <String>]: The name of the credential set.[ExportPipelineName <String>]: The name of the export pipeline.[GroupName <String>]: The name of the private link resource.[Id <String>]: Resource identity path[ImportPipelineName <String>]: The name of the import pipeline.[PipelineRunName <String>]: The name of the pipeline run.[PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.[RegistryName <String>]: The name of the container registry.[ReplicationName <String>]: The name of the replication.[ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.[RunId <String>]: The run ID.[ScopeMapName <String>]: The name of the scope map.[SubscriptionId <String>]: The ID of the target subscription. The value must be an UUID.[TaskName <String>]: The name of the container registry task.[TaskRunName <String>]: The name of the task run.[TokenName <String>]: The name of the token.[WebhookName <String>]: The name of the webhook.
NETWORKRULESETIPRULE <IIPRule[]>: The IP ACL rules.
IPAddressOrRange <String>: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.[Action <Action?>]: The action of IP ACL rule.
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for