Edit

Share via


New-AzContainerRegistry

Creates a container registry with the specified parameters.

Syntax

Default (Default)

New-AzContainerRegistry
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    -Location <String>
    -Sku <SkuName>
    [-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>]
    [-SoftDeletePolicyRetentionDay <Int32>]
    [-SoftDeletePolicyStatus <PolicyStatus>]
    [-Tag <Hashtable>]
    [-TrustPolicyStatus <PolicyStatus>]
    [-TrustPolicyType <TrustPolicyType>]
    [-ZoneRedundancy <ZoneRedundancy>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Creates a container registry with the specified parameters.

Examples

Example 1: Create a container registry with a new storage account.

New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -Sku "Basic" -Location "west us"
Name             SkuName LoginServer                 CreationDate         ProvisioningState AdminUserEnabled
----             ------- -----------                 ------------         ----------------- ----------------
RegistryExample Basic   registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded         False

Create a container registry with a new storage account.

Example 2: Create a container registry with admin user enabled.

New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -Sku "Basic" -Location "west us" -EnableAdminUser
Name             SkuName LoginServer                 CreationDate         ProvisioningState AdminUserEnabled
----             ------- -----------                 ------------         ----------------- ----------------
RegistryExample Basic   registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded         True

Create a container registry with admin user enabled.

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:AzureAdAuthenticationAsArmPolicyStatus
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

-EncryptionStatus

Indicates whether or not the encryption is enabled for container registry.

Parameter properties

Type:EncryptionStatus
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:ExportPolicyStatus
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

-IdentityType

The identity type.

Parameter properties

Type:ResourceIdentityType
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

-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}'.

Parameter properties

Type:Hashtable
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

-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

-Location

The ___location of the resource. This cannot be changed after the resource is created.

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

-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

(All)
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:NetworkRuleBypassOptions
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:DefaultAction
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. To construct, see NOTES section for NETWORKRULESETIPRULE properties and create a hash table.

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:PublicNetworkAccess
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:PolicyStatus
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

(All)
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:PolicyStatus
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:SkuName
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

-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:PolicyStatus
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

(All)
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:PolicyStatus
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:TrustPolicyType
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:ZoneRedundancy
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

IRegistry