Registries - List

Reference

Service:: Container Registry

API Version:: 2023-01-01-preview

Lists all the container registries under the specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries?api-version=2023-01-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RegistryListResult	The request was successful; the request was well-formed and received properly.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RegistryList

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerRegistry/registries?api-version=2023-01-01-preview

package armcontainerregistry_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerregistry/armcontainerregistry"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryList.json
func ExampleRegistriesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRegistriesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RegistryListResult = armcontainerregistry.RegistryListResult{
		// 	Value: []*armcontainerregistry.Registry{
		// 		{
		// 			Name: to.Ptr("myRegistry"),
		// 			Type: to.Ptr("Microsoft.ContainerRegistry/registries"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armcontainerregistry.RegistryProperties{
		// 				AdminUserEnabled: to.Ptr(false),
		// 				AnonymousPullEnabled: to.Ptr(false),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-15T21:38:26.1537861Z"); return t}()),
		// 				DataEndpointEnabled: to.Ptr(false),
		// 				DataEndpointHostNames: []*string{
		// 				},
		// 				Encryption: &armcontainerregistry.EncryptionProperty{
		// 					Status: to.Ptr(armcontainerregistry.EncryptionStatusDisabled),
		// 				},
		// 				LoginServer: to.Ptr("myRegistry.azurecr-test.io"),
		// 				NetworkRuleBypassOptions: to.Ptr(armcontainerregistry.NetworkRuleBypassOptionsAzureServices),
		// 				NetworkRuleSet: &armcontainerregistry.NetworkRuleSet{
		// 					DefaultAction: to.Ptr(armcontainerregistry.DefaultActionAllow),
		// 					IPRules: []*armcontainerregistry.IPRule{
		// 					},
		// 				},
		// 				Policies: &armcontainerregistry.Policies{
		// 					ExportPolicy: &armcontainerregistry.ExportPolicy{
		// 						Status: to.Ptr(armcontainerregistry.ExportPolicyStatusEnabled),
		// 					},
		// 					QuarantinePolicy: &armcontainerregistry.QuarantinePolicy{
		// 						Status: to.Ptr(armcontainerregistry.PolicyStatusDisabled),
		// 					},
		// 					RetentionPolicy: &armcontainerregistry.RetentionPolicy{
		// 						Days: to.Ptr[int32](7),
		// 						LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-15T21:40:12.8506835+00:00"); return t}()),
		// 						Status: to.Ptr(armcontainerregistry.PolicyStatusDisabled),
		// 					},
		// 					TrustPolicy: &armcontainerregistry.TrustPolicy{
		// 						Type: to.Ptr(armcontainerregistry.TrustPolicyTypeNotary),
		// 						Status: to.Ptr(armcontainerregistry.PolicyStatusDisabled),
		// 					},
		// 				},
		// 				PrivateEndpointConnections: []*armcontainerregistry.PrivateEndpointConnection{
		// 				},
		// 				ProvisioningState: to.Ptr(armcontainerregistry.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armcontainerregistry.PublicNetworkAccessEnabled),
		// 				ZoneRedundancy: to.Ptr(armcontainerregistry.ZoneRedundancyDisabled),
		// 			},
		// 			SKU: &armcontainerregistry.SKU{
		// 				Name: to.Ptr(armcontainerregistry.SKUNameStandard),
		// 				Tier: to.Ptr(armcontainerregistry.SKUTierStandard),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerRegistryManagementClient } = require("@azure/arm-containerregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all the container registries under the specified subscription.
 *
 * @summary Lists all the container registries under the specified subscription.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryList.json
 */
async function registryList() {
  const subscriptionId =
    process.env["CONTAINERREGISTRY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.registries.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
      "name": "myRegistry",
      "type": "Microsoft.ContainerRegistry/registries",
      "location": "westus",
      "tags": {
        "key": "value"
      },
      "sku": {
        "name": "Standard",
        "tier": "Standard"
      },
      "properties": {
        "loginServer": "myRegistry.azurecr-test.io",
        "creationDate": "2021-06-15T21:38:26.1537861Z",
        "provisioningState": "Succeeded",
        "adminUserEnabled": false,
        "networkRuleSet": {
          "defaultAction": "Allow",
          "ipRules": []
        },
        "policies": {
          "quarantinePolicy": {
            "status": "disabled"
          },
          "trustPolicy": {
            "type": "Notary",
            "status": "disabled"
          },
          "retentionPolicy": {
            "days": 7,
            "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
            "status": "disabled"
          },
          "exportPolicy": {
            "status": "enabled"
          }
        },
        "encryption": {
          "status": "disabled"
        },
        "status": null,
        "dataEndpointEnabled": false,
        "dataEndpointHostNames": [],
        "privateEndpointConnections": [],
        "publicNetworkAccess": "Enabled",
        "networkRuleBypassOptions": "AzureServices",
        "zoneRedundancy": "Disabled",
        "anonymousPullEnabled": false
      }
    }
  ]
}

Definitions

Name	Description
Action	The action of IP ACL rule.
ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
AzureADAuthenticationAsArmPolicy	The policy for using ARM audience token for a container registry.
AzureADAuthenticationAsArmPolicyStatus	The value that indicates whether the policy is enabled or not.
ConnectionStatus	The private link service connection status.
createdByType	The type of identity that created the resource.
DefaultAction	The default action of allow or deny when no other rules match.
EncryptionProperty
EncryptionStatus	Indicates whether or not the encryption is enabled for container registry.
ExportPolicy	The export policy for a container registry.
ExportPolicyStatus	The value that indicates whether the policy is enabled or not.
IdentityProperties	Managed identity for the resource.
IPRule	IP rule with specific IP or IP range in CIDR format.
KeyVaultProperties
lastModifiedByType	The type of identity that last modified the resource.
NetworkRuleBypassOptions	Whether to allow trusted Azure services to access a network restricted registry.
NetworkRuleSet	The network rule set for a container registry.
Policies	The policies for a container registry.
PolicyStatus	The value that indicates whether the policy is enabled or not.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	An object that represents a private endpoint connection for a container registry.
PrivateLinkServiceConnectionState	The state of a private link service connection.
ProvisioningState	Provisioning state of the resource.
PublicNetworkAccess	Whether or not public network access is allowed for the container registry.
QuarantinePolicy	The quarantine policy for a container registry.
Registry	An object that represents a container registry.
RegistryListResult	The result of a request to list container registries.
ResourceIdentityType	The identity type.
RetentionPolicy	The retention policy for a container registry.
Sku	The SKU of a container registry.
SkuName	The SKU name of the container registry. Required for registry creation.
SkuTier	The SKU tier based on the SKU name.
SoftDeletePolicy	The soft delete policy for a container registry
Status	The status of an Azure resource at the time the operation was called.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrustPolicy	The content trust policy for a container registry.
TrustPolicyType	The type of trust policy.
UserIdentityProperties
ZoneRedundancy	Whether or not zone redundancy is enabled for this container registry

Action

The action of IP ACL rule.

Name	Type	Description
Allow	string

ActionsRequired

A message indicating if changes on the service provider require any updates on the consumer.

Name	Type	Description
None	string
Recreate	string

AzureADAuthenticationAsArmPolicy

The policy for using ARM audience token for a container registry.

Name	Type	Default Value	Description
status	AzureADAuthenticationAsArmPolicyStatus	enabled	The value that indicates whether the policy is enabled or not.

AzureADAuthenticationAsArmPolicyStatus

The value that indicates whether the policy is enabled or not.

Name	Type	Description
disabled	string
enabled	string

ConnectionStatus

The private link service connection status.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

The default action of allow or deny when no other rules match.

Name	Type	Description
Allow	string
Deny	string

EncryptionProperty

Name	Type	Description
keyVaultProperties	KeyVaultProperties	Key vault properties.
status	EncryptionStatus	Indicates whether or not the encryption is enabled for container registry.

EncryptionStatus

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

Name	Type	Description
disabled	string
enabled	string

ExportPolicy

The export policy for a container registry.

Name	Type	Default Value	Description
status	ExportPolicyStatus	enabled	The value that indicates whether the policy is enabled or not.

ExportPolicyStatus

The value that indicates whether the policy is enabled or not.

Name	Type	Description
disabled	string
enabled	string

IdentityProperties

Managed identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.
userAssignedIdentities	<string, UserIdentityProperties>	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}'.

IPRule

IP rule with specific IP or IP range in CIDR format.

Name	Type	Default Value	Description
action	Action	Allow	The action of IP ACL rule.
value	string		Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

KeyVaultProperties

Name	Type	Description
identity	string	The client id of the identity which will be used to access key vault.
keyIdentifier	string	Key vault uri to access the encryption key.
keyRotationEnabled	boolean	Auto key rotation status for a CMK enabled registry.
lastKeyRotationTimestamp	string	Timestamp of the last successful key rotation.
versionedKeyIdentifier	string	The fully qualified key identifier that includes the version of the key that is actually used for encryption.

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

NetworkRuleBypassOptions

Whether to allow trusted Azure services to access a network restricted registry.

Name	Type	Description
AzureServices	string
None	string

NetworkRuleSet

The network rule set for a container registry.

Name	Type	Default Value	Description
defaultAction	DefaultAction	Allow	The default action of allow or deny when no other rules match.
ipRules	IPRule[]		The IP ACL rules.

Policies

The policies for a container registry.

Name	Type	Description
azureADAuthenticationAsArmPolicy	AzureADAuthenticationAsArmPolicy	The policy for using ARM audience token for a container registry.
exportPolicy	ExportPolicy	The export policy for a container registry.
quarantinePolicy	QuarantinePolicy	The quarantine policy for a container registry.
retentionPolicy	RetentionPolicy	The retention policy for a container registry.
softDeletePolicy	SoftDeletePolicy	The soft delete policy for a container registry.
trustPolicy	TrustPolicy	The content trust policy for a container registry.

PolicyStatus

The value that indicates whether the policy is enabled or not.

Name	Type	Description
disabled	string
enabled	string

PrivateEndpoint

The Private Endpoint resource.

Name	Type	Description
id	string	This is private endpoint resource created with Microsoft.Network resource provider.

PrivateEndpointConnection

An object that represents a private endpoint connection for a container registry.

Name	Type	Description
id	string	The resource ID.
name	string	The name of the resource.
properties.privateEndpoint	PrivateEndpoint	The resource of private endpoint.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	ProvisioningState	The provisioning state of private endpoint connection resource.
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

PrivateLinkServiceConnectionState

The state of a private link service connection.

Name	Type	Description
actionsRequired	ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The description for connection status. For example if connection is rejected it can indicate reason for rejection.
status	ConnectionStatus	The private link service connection status.

ProvisioningState

Provisioning state of the resource.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PublicNetworkAccess

Whether or not public network access is allowed for the container registry.

Name	Type	Description
Disabled	string
Enabled	string

QuarantinePolicy

The quarantine policy for a container registry.

Name	Type	Default Value	Description
status	PolicyStatus	disabled	The value that indicates whether the policy is enabled or not.

Registry

An object that represents a container registry.

Name	Type	Default Value	Description
id	string		The resource ID.
identity	IdentityProperties		The identity of the container registry.
location	string		The location of the resource. This cannot be changed after the resource is created.
name	string		The name of the resource.
properties.adminUserEnabled	boolean	False	The value that indicates whether the admin user is enabled.
properties.anonymousPullEnabled	boolean	False	Enables registry-wide pull from unauthenticated clients.
properties.creationDate	string		The creation date of the container registry in ISO8601 format.
properties.dataEndpointEnabled	boolean		Enable a single data endpoint per region for serving data.
properties.dataEndpointHostNames	string[]		List of host names that will serve data when dataEndpointEnabled is true.
properties.encryption	EncryptionProperty		The encryption settings of container registry.
properties.loginServer	string		The URL that can be used to log into the container registry.
properties.networkRuleBypassOptions	NetworkRuleBypassOptions	AzureServices	Whether to allow trusted Azure services to access a network restricted registry.
properties.networkRuleSet	NetworkRuleSet		The network rule set for a container registry.
properties.policies	Policies		The policies for a container registry.
properties.privateEndpointConnections	PrivateEndpointConnection[]		List of private endpoint connections for a container registry.
properties.provisioningState	ProvisioningState		The provisioning state of the container registry at the time the operation was called.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Whether or not public network access is allowed for the container registry.
properties.status	Status		The status of the container registry at the time the operation was called.
properties.zoneRedundancy	ZoneRedundancy	Disabled	Whether or not zone redundancy is enabled for this container registry
sku	Sku		The SKU of the container registry.
systemData	SystemData		Metadata pertaining to creation and last modification of the resource.
tags	object		The tags of the resource.
type	string		The type of the resource.

RegistryListResult

The result of a request to list container registries.

Name	Type	Description
nextLink	string	The URI that can be used to request the next list of container registries.
value	Registry[]	The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.

ResourceIdentityType

The identity type.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicy

The retention policy for a container registry.

Name	Type	Default Value	Description
days	integer	7	The number of days to retain an untagged manifest after which it gets purged.
lastUpdatedTime	string		The timestamp when the policy was last updated.
status	PolicyStatus	disabled	The value that indicates whether the policy is enabled or not.

Sku

The SKU of a container registry.

Name	Type	Description
name	SkuName	The SKU name of the container registry. Required for registry creation.
tier	SkuTier	The SKU tier based on the SKU name.

SkuName

The SKU name of the container registry. Required for registry creation.

Name	Type	Description
Basic	string
Classic	string
Premium	string
Standard	string

SkuTier

The SKU tier based on the SKU name.

Name	Type	Description
Basic	string
Classic	string
Premium	string
Standard	string

SoftDeletePolicy

The soft delete policy for a container registry

Name	Type	Default Value	Description
lastUpdatedTime	string		The timestamp when the policy was last updated.
retentionDays	integer	7	The number of days after which a soft-deleted item is permanently deleted.
status	PolicyStatus	disabled	The value that indicates whether the policy is enabled or not.

Status

The status of an Azure resource at the time the operation was called.

Name	Type	Description
displayStatus	string	The short label for the status.
message	string	The detailed message for the status, including alerts and error messages.
timestamp	string	The timestamp when the status was changed to the current value.

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource modification (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

TrustPolicy

The content trust policy for a container registry.

Name	Type	Default Value	Description
status	PolicyStatus	disabled	The value that indicates whether the policy is enabled or not.
type	TrustPolicyType	Notary	The type of trust policy.

TrustPolicyType

The type of trust policy.

Name	Type	Description
Notary	string

UserIdentityProperties

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

ZoneRedundancy

Whether or not zone redundancy is enabled for this container registry

Name	Type	Description
Disabled	string
Enabled	string

Registries - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

RegistryList

Sample Request

Sample Response

Definitions

Action

ActionsRequired

AzureADAuthenticationAsArmPolicy

AzureADAuthenticationAsArmPolicyStatus

ConnectionStatus

createdByType

DefaultAction

EncryptionProperty

EncryptionStatus

ExportPolicy

ExportPolicyStatus

IdentityProperties

IPRule

KeyVaultProperties

lastModifiedByType

NetworkRuleBypassOptions

NetworkRuleSet

Policies

PolicyStatus

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

QuarantinePolicy

Registry

RegistryListResult

ResourceIdentityType

RetentionPolicy

Sku

SkuName

SkuTier

SoftDeletePolicy

Status

SystemData

TrustPolicy

TrustPolicyType

UserIdentityProperties

ZoneRedundancy

Additional resources