Microsoft.MachineLearningServices registries 2022-10-01-preview

Article
01/12/2024

Bicep resource definition

The registries resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/registries@2022-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    description: 'string'
    discoveryUrl: 'string'
    intellectualPropertyPublisher: 'string'
    managedResourceGroup: {
      resourceId: 'string'
    }
    mlFlowRegistryUri: 'string'
    privateLinkCount: int
    properties: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
    publicNetworkAccess: 'string'
    regionDetails: [
      {
        acrDetails: [
          {
            systemCreatedAcrAccount: {
              acrAccountSku: 'string'
              armResourceId: {
                resourceId: 'string'
              }
            }
            userCreatedAcrAccount: {
              armResourceId: {
                resourceId: 'string'
              }
            }
          }
        ]
        location: 'string'
        storageAccountDetails: [
          {
            systemCreatedStorageAccount: {
              armResourceId: {
                resourceId: 'string'
              }
              storageAccountHnsEnabled: bool
              storageAccountType: 'string'
            }
            userCreatedStorageAccount: {
              armResourceId: {
                resourceId: 'string'
              }
            }
          }
        ]
      }
    ]
    tags: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
  }
}

Property values

registries

Name	Description	Value
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
sku	Sku details required for ARM contract for Autoscaling.	Sku
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
properties	[Required] Additional attributes of the entity.	RegistryProperties (required)

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	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.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

RegistryProperties

Name	Description	Value
description	The asset description text.	string
discoveryUrl		string
intellectualPropertyPublisher		string
managedResourceGroup	Managed resource group created for the registry	ArmResourceId
mlFlowRegistryUri		string
privateLinkCount		int
properties	The asset property dictionary.	ResourceBaseProperties
publicNetworkAccess		string
regionDetails	Details of each region the registry is in	RegistryRegionArmDetails[]
tags	Tag dictionary. Tags can be added, removed, and updated.	object

ArmResourceId

Name	Description	Value
resourceId	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}"	string

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string

RegistryRegionArmDetails

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

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount
userCreatedAcrAccount		UserCreatedAcrAccount

SystemCreatedAcrAccount

Name	Description	Value
acrAccountSku		string
armResourceId	ARM ResourceId of a resource	ArmResourceId

UserCreatedAcrAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount
userCreatedStorageAccount		UserCreatedStorageAccount

SystemCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId
storageAccountHnsEnabled		bool
storageAccountType	Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS"	string

UserCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

Sku

Name	Description	Value
capacity	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.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	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.	'Basic' 'Free' 'Premium' 'Standard'

ARM template resource definition

The registries resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/registries",
  "apiVersion": "2022-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "description": "string",
    "discoveryUrl": "string",
    "intellectualPropertyPublisher": "string",
    "managedResourceGroup": {
      "resourceId": "string"
    },
    "mlFlowRegistryUri": "string",
    "privateLinkCount": "int",
    "properties": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    },
    "publicNetworkAccess": "string",
    "regionDetails": [
      {
        "acrDetails": [
          {
            "systemCreatedAcrAccount": {
              "acrAccountSku": "string",
              "armResourceId": {
                "resourceId": "string"
              }
            },
            "userCreatedAcrAccount": {
              "armResourceId": {
                "resourceId": "string"
              }
            }
          }
        ],
        "location": "string",
        "storageAccountDetails": [
          {
            "systemCreatedStorageAccount": {
              "armResourceId": {
                "resourceId": "string"
              },
              "storageAccountHnsEnabled": "bool",
              "storageAccountType": "string"
            },
            "userCreatedStorageAccount": {
              "armResourceId": {
                "resourceId": "string"
              }
            }
          }
        ]
      }
    ],
    "tags": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    }
  }
}

Property values

registries

Name	Description	Value
type	The resource type	'Microsoft.MachineLearningServices/registries'
apiVersion	The resource api version	'2022-10-01-preview'
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
sku	Sku details required for ARM contract for Autoscaling.	Sku
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
properties	[Required] Additional attributes of the entity.	RegistryProperties (required)

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	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.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

RegistryProperties

Name	Description	Value
description	The asset description text.	string
discoveryUrl		string
intellectualPropertyPublisher		string
managedResourceGroup	Managed resource group created for the registry	ArmResourceId
mlFlowRegistryUri		string
privateLinkCount		int
properties	The asset property dictionary.	ResourceBaseProperties
publicNetworkAccess		string
regionDetails	Details of each region the registry is in	RegistryRegionArmDetails[]
tags	Tag dictionary. Tags can be added, removed, and updated.	object

ArmResourceId

Name	Description	Value
resourceId	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}"	string

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string

RegistryRegionArmDetails

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

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount
userCreatedAcrAccount		UserCreatedAcrAccount

SystemCreatedAcrAccount

Name	Description	Value
acrAccountSku		string
armResourceId	ARM ResourceId of a resource	ArmResourceId

UserCreatedAcrAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount
userCreatedStorageAccount		UserCreatedStorageAccount

SystemCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId
storageAccountHnsEnabled		bool
storageAccountType	Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS"	string

UserCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

Sku

Name	Description	Value
capacity	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.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	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.	'Basic' 'Free' 'Premium' 'Standard'

Terraform (AzAPI provider) resource definition

The registries resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/registries@2022-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      description = "string"
      discoveryUrl = "string"
      intellectualPropertyPublisher = "string"
      managedResourceGroup = {
        resourceId = "string"
      }
      mlFlowRegistryUri = "string"
      privateLinkCount = int
      properties = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
      publicNetworkAccess = "string"
      regionDetails = [
        {
          acrDetails = [
            {
              systemCreatedAcrAccount = {
                acrAccountSku = "string"
                armResourceId = {
                  resourceId = "string"
                }
              }
              userCreatedAcrAccount = {
                armResourceId = {
                  resourceId = "string"
                }
              }
            }
          ]
          location = "string"
          storageAccountDetails = [
            {
              systemCreatedStorageAccount = {
                armResourceId = {
                  resourceId = "string"
                }
                storageAccountHnsEnabled = bool
                storageAccountType = "string"
              }
              userCreatedStorageAccount = {
                armResourceId = {
                  resourceId = "string"
                }
              }
            }
          ]
        }
      ]
      tags = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Property values

registries

Name	Description	Value
type	The resource type	"Microsoft.MachineLearningServices/registries@2022-10-01-preview"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
sku	Sku details required for ARM contract for Autoscaling.	Sku
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
properties	[Required] Additional attributes of the entity.	RegistryProperties (required)

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required)
identity_ids	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.	Array of user identity IDs.

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

RegistryProperties

Name	Description	Value
description	The asset description text.	string
discoveryUrl		string
intellectualPropertyPublisher		string
managedResourceGroup	Managed resource group created for the registry	ArmResourceId
mlFlowRegistryUri		string
privateLinkCount		int
properties	The asset property dictionary.	ResourceBaseProperties
publicNetworkAccess		string
regionDetails	Details of each region the registry is in	RegistryRegionArmDetails[]
tags	Tag dictionary. Tags can be added, removed, and updated.	object

ArmResourceId

Name	Description	Value
resourceId	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}"	string

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string

RegistryRegionArmDetails

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

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount
userCreatedAcrAccount		UserCreatedAcrAccount

SystemCreatedAcrAccount

Name	Description	Value
acrAccountSku		string
armResourceId	ARM ResourceId of a resource	ArmResourceId

UserCreatedAcrAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount
userCreatedStorageAccount		UserCreatedStorageAccount

SystemCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId
storageAccountHnsEnabled		bool
storageAccountType	Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS"	string

UserCreatedStorageAccount

Name	Description	Value
armResourceId	ARM ResourceId of a resource	ArmResourceId

Sku

Name	Description	Value
capacity	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.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	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.	"Basic" "Free" "Premium" "Standard"

Microsoft.MachineLearningServices registries 2022-10-01-preview

Bicep resource definition

Resource format

Property values

registries

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

RegistryProperties

ArmResourceId

ResourceBaseProperties

RegistryRegionArmDetails

AcrDetails

SystemCreatedAcrAccount

UserCreatedAcrAccount

StorageAccountDetails

SystemCreatedStorageAccount

UserCreatedStorageAccount

Sku

ARM template resource definition

Resource format

Property values

registries

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

RegistryProperties

ArmResourceId

ResourceBaseProperties

RegistryRegionArmDetails

AcrDetails

SystemCreatedAcrAccount

UserCreatedAcrAccount

StorageAccountDetails

SystemCreatedStorageAccount

UserCreatedStorageAccount

Sku

Terraform (AzAPI provider) resource definition

Resource format

Property values

registries

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

RegistryProperties

ArmResourceId

ResourceBaseProperties

RegistryRegionArmDetails

AcrDetails

SystemCreatedAcrAccount

UserCreatedAcrAccount

StorageAccountDetails

SystemCreatedStorageAccount

UserCreatedStorageAccount

Sku

Feedback

Feedback

Additional resources