Microsoft.MachineLearningServices registries 2022-10-01-preview

• Latest
• 2024-10-01
• 2024-10-01-preview
• 2024-07-01-preview
• 2024-04-01
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-10-01
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01-preview

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' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    discoveryUrl: 'string'
    intellectualPropertyPublisher: 'string'
    managedResourceGroup: {
      resourceId: 'string'
    }
    mlFlowRegistryUri: 'string'
    privateLinkCount: int
    properties: {
      {customized property}: 'string'
    }
    publicNetworkAccess: 'string'
    regionDetails: [
      {
        acrDetails: [
          {
            systemCreatedAcrAccount: {
              acrAccountSku: 'string'
              armResourceId: {
                resourceId: 'string'
              }
            }
          }
        ]
        location: 'string'
        storageAccountDetails: [
          {
            systemCreatedStorageAccount: {
              armResourceId: {
                resourceId: 'string'
              }
              storageAccountHnsEnabled: bool
              storageAccountType: 'string'
            }
          }
        ]
      }
    ]
    tags: {
      {customized property}: 'string'
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount

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

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

Microsoft.MachineLearningServices/registries

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

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.	ResourceBaseTags

RegistryRegionArmDetails

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

ResourceBaseProperties

Name	Description	Value

ResourceBaseTags

Name	Description	Value

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'

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount

SystemCreatedAcrAccount

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

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

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

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",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "discoveryUrl": "string",
    "intellectualPropertyPublisher": "string",
    "managedResourceGroup": {
      "resourceId": "string"
    },
    "mlFlowRegistryUri": "string",
    "privateLinkCount": "int",
    "properties": {
      "{customized property}": "string"
    },
    "publicNetworkAccess": "string",
    "regionDetails": [
      {
        "acrDetails": [
          {
            "systemCreatedAcrAccount": {
              "acrAccountSku": "string",
              "armResourceId": {
                "resourceId": "string"
              }
            }
          }
        ],
        "location": "string",
        "storageAccountDetails": [
          {
            "systemCreatedStorageAccount": {
              "armResourceId": {
                "resourceId": "string"
              },
              "storageAccountHnsEnabled": "bool",
              "storageAccountType": "string"
            }
          }
        ]
      }
    ],
    "tags": {
      "{customized property}": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount

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

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

Microsoft.MachineLearningServices/registries

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

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.	ResourceBaseTags

RegistryRegionArmDetails

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

ResourceBaseProperties

Name	Description	Value

ResourceBaseTags

Name	Description	Value

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'

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount

SystemCreatedAcrAccount

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

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

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

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"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      discoveryUrl = "string"
      intellectualPropertyPublisher = "string"
      managedResourceGroup = {
        resourceId = "string"
      }
      mlFlowRegistryUri = "string"
      privateLinkCount = int
      properties = {
        {customized property} = "string"
      }
      publicNetworkAccess = "string"
      regionDetails = [
        {
          acrDetails = [
            {
              systemCreatedAcrAccount = {
                acrAccountSku = "string"
                armResourceId = {
                  resourceId = "string"
                }
              }
            }
          ]
          location = "string"
          storageAccountDetails = [
            {
              systemCreatedStorageAccount = {
                armResourceId = {
                  resourceId = "string"
                }
                storageAccountHnsEnabled = bool
                storageAccountType = "string"
              }
            }
          ]
        }
      ]
      tags = {
        {customized property} = "string"
      }
    }
  })
}

Property values

AcrDetails

Name	Description	Value
systemCreatedAcrAccount		SystemCreatedAcrAccount

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

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

Microsoft.MachineLearningServices/registries

Name	Description	Value
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
properties	[Required] Additional attributes of the entity.	RegistryProperties (required)
sku	Sku details required for ARM contract for Autoscaling.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.MachineLearningServices/registries@2022-10-01-preview"

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.	ResourceBaseTags

RegistryRegionArmDetails

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

ResourceBaseProperties

Name	Description	Value

ResourceBaseTags

Name	Description	Value

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'

StorageAccountDetails

Name	Description	Value
systemCreatedStorageAccount		SystemCreatedStorageAccount

SystemCreatedAcrAccount

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

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

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value