Registries - Get

Service:: Machine Learning

API Version:: 2024-10-01

Get registry

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
registryName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{2,32}$	Name of Azure Machine Learning registry. This is case-insensitive
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RegistryTrackedResource	Success
Other Status Codes	ErrorResponse	Error

Examples

Get Registry with system created accounts.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/registries/string?api-version=2024-10-01

Sample response

Status code:: 200

{
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "principalId": "00000000-1111-2222-3333-444444444444",
        "clientId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  },
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "regionDetails": [
      {
        "location": "string",
        "storageAccountDetails": [
          {
            "systemCreatedStorageAccount": {
              "storageAccountName": "string",
              "storageAccountType": "string",
              "storageAccountHnsEnabled": false,
              "armResourceId": {
                "resourceId": "string"
              },
              "allowBlobPublicAccess": false
            }
          }
        ],
        "acrDetails": [
          {
            "systemCreatedAcrAccount": {
              "acrAccountName": "string",
              "acrAccountSku": "string",
              "armResourceId": {
                "resourceId": "string"
              }
            }
          }
        ]
      }
    ],
    "intellectualPropertyPublisher": "string",
    "publicNetworkAccess": "string",
    "discoveryUrl": "string",
    "managedResourceGroup": {
      "resourceId": "string"
    },
    "mlFlowRegistryUri": "string",
    "registryPrivateEndpointConnections": [
      {
        "id": "string",
        "location": "string",
        "properties": {
          "provisioningState": "string",
          "privateEndpoint": {
            "id": "string",
            "subnetArmId": "string"
          },
          "registryPrivateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "string",
            "actionsRequired": "string"
          },
          "groupIds": [
            "string"
          ]
        }
      }
    ]
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999+00:40",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999+00:40",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Definitions

Name	Description
AcrDetails	Details of ACR account to be used for the Registry
ArmResourceId	ARM ResourceId of a resource
createdByType	The type of identity that created the resource.
EndpointServiceConnectionStatus	Connection status of the service consumer with the service provider
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
PrivateEndpointResource	The PE network resource that is linked to this PE connection.
RegistryPrivateEndpointConnection	Private endpoint connection definition.
RegistryPrivateLinkServiceConnectionState	The connection state.
RegistryRegionArmDetails	Details for each region the registry is in
RegistryTrackedResource
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
StorageAccountDetails	Details of storage account to be used for the Registry
SystemCreatedAcrAccount
SystemCreatedStorageAccount
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

AcrDetails

Object

Details of ACR account to be used for the Registry

Name	Type	Description
systemCreatedAcrAccount	SystemCreatedAcrAccount	Details of system created ACR account to be used for the Registry

ArmResourceId

Object

ARM ResourceId of a resource

Name	Type	Description
resourceId	string	Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EndpointServiceConnectionStatus

Enumeration

Connection status of the service consumer with the service provider

Value	Description
Approved
Pending
Rejected
Disconnected

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PrivateEndpointResource

Object

The PE network resource that is linked to this PE connection.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint
subnetArmId	string	The subnetId that the private endpoint is connected to.

RegistryPrivateEndpointConnection

Object

Private endpoint connection definition.

Name	Type	Description
id	string	This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName}
location	string	Same as workspace location.
properties.groupIds	string[]	The group ids
properties.privateEndpoint	PrivateEndpointResource	The PE network resource that is linked to this PE connection.
properties.provisioningState	string	One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null.
properties.registryPrivateLinkServiceConnectionState	RegistryPrivateLinkServiceConnectionState	The connection state.

RegistryPrivateLinkServiceConnectionState

Object

The connection state.

Name	Type	Description
actionsRequired	string	Some RP chose "None". Other RPs use this for region expansion.
description	string	User-defined message that, per NRP doc, may be used for approval-related message.
status	EndpointServiceConnectionStatus	Connection status of the service consumer with the service provider

RegistryRegionArmDetails

Object

Details for each region the registry is in

Name	Type	Description
acrDetails	AcrDetails[]	List of ACR accounts
location	string	The location where the registry exists
storageAccountDetails	StorageAccountDetails[]	List of storage accounts

RegistryTrackedResource

Object

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.discoveryUrl	string	Discovery URL for the Registry
properties.intellectualPropertyPublisher	string	IntellectualPropertyPublisher for the registry
properties.managedResourceGroup	ArmResourceId	ResourceId of the managed RG if the registry has system created resources
properties.mlFlowRegistryUri	string	MLFlow Registry URI for the Registry
properties.publicNetworkAccess	string	Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled"
properties.regionDetails	RegistryRegionArmDetails[]	Details of each region the registry is in
properties.registryId	string	RegistryId Guid for this registry
properties.registryPrivateEndpointConnections	RegistryPrivateEndpointConnection[]	Private endpoint connections info used for pending connections in private link portal
sku	Sku	Sku details required for ARM contract for Autoscaling.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Free
Basic
Standard
Premium

StorageAccountDetails

Object

Details of storage account to be used for the Registry

Name	Type	Description
systemCreatedStorageAccount	SystemCreatedStorageAccount	Details of system created storage account to be used for the registry

SystemCreatedAcrAccount

Object

Name	Type	Description
acrAccountName	string	Name of the ACR account
acrAccountSku	string	SKU of the ACR account
armResourceId	ArmResourceId	This is populated once the ACR account is created.

SystemCreatedStorageAccount

Object

Name	Type	Description
allowBlobPublicAccess	boolean	Public blob access allowed
armResourceId	ArmResourceId	This is populated once the storage account is created.
storageAccountHnsEnabled	boolean	HNS enabled for storage account
storageAccountName	string	Name of the storage account
storageAccountType	string	Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

Registries - Get

URI Parameters

Responses

Examples

Get Registry with system created accounts.

Sample request

Sample response

Definitions

AcrDetails

ArmResourceId

createdByType

EndpointServiceConnectionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpointResource

RegistryPrivateEndpointConnection

RegistryPrivateLinkServiceConnectionState

RegistryRegionArmDetails

RegistryTrackedResource

Sku

SkuTier

StorageAccountDetails

SystemCreatedAcrAccount

SystemCreatedStorageAccount

systemData

UserAssignedIdentity