Edit

Get-AzContainerRegistry

  • Reference
Module:
Az.ContainerRegistry

Gets the properties of the specified container registry.

Syntax

Get-AzContainerRegistry
   [-SubscriptionId <String[]>]
   [-IncludeDetail]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistry
   [-SubscriptionId <String[]>]
   [-IncludeDetail]
   -ResourceGroupName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistry
   [-SubscriptionId <String[]>]
   [-IncludeDetail]
   -Name <String>
   -ResourceGroupName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistry
   [-IncludeDetail]
   -InputObject <IContainerRegistryIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the properties of the specified container registry.

Examples

Example 1: Get a specified container registry

Get-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry"

Name  SkuName LoginServer      CreationDate          ProvisioningState AdminUserEnabled
----  ------- -----------      ------------          ----------------- ----------------
testc Premium testc.azurecr.io 16/01/2023 8:45:50 pm Succeeded         True

This command gets the specified container registry.

Example 2: Get all the container registries in a resource group

Get-AzContainerRegistry -ResourceGroupName "MyResourceGroup"

Name   SkuName LoginServer       CreationDate          ProvisioningState AdminUserEnabled
----   ------- -----------       ------------          ----------------- ----------------
testc2 Premium testc2.azurecr.io 17/01/2023 3:47:50 pm Succeeded         True
testc  Premium testc.azurecr.io  16/01/2023 8:45:50 pm Succeeded         True

This command gets all the container registries in a resource group.

Example 3: Get all the container registries in the subscription

Get-AzContainerRegistry

Name   SkuName LoginServer       CreationDate          ProvisioningState AdminUserEnabled
----   ------- -----------       ------------          ----------------- ----------------
testc2 Premium testc2.azurecr.io 17/01/2023 3:47:50 pm Succeeded         True
testc  Premium testc.azurecr.io  16/01/2023 8:45:50 pm Succeeded         True

This command gets all the container registries in the subscription.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-IncludeDetail

Usage of an azure container registry.

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

-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

-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

-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

Inputs

IContainerRegistryIdentity

Outputs

IRegistry

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.