Azure ML Registry [Microsoft.MachineLearningServices/registries]

This module deploys an Azure Machine Learning Registry.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/ml-registry/main.bicep.

• Using only defaults for AML Registry
• Using large parameter set
• WAF-aligned

Example 1: Using only defaults for AML Registry

This test deploys the AML Registry module with the minimum required parameters and mocked values.

module registry './packages/ml-registry/main.bicep' = {
  name: 'registryDeployment'
  params: {
    name: 'mlsrmin001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "mlsrmin001"
    }
  }
}

using './packages/ml-registry/main.bicep'

param name = 'mlsrmin001'

Example 2: Using large parameter set

This instance deploys the module with most of its features enabled.

module registry './packages/ml-registry/main.bicep' = {
  name: 'registryDeployment'
  params: {
    // Required parameters
    name: 'mlsrmax001'
    // Non-required parameters
    acrAccountName: '<acrAccountName>'
    acrSku: 'Premium'
    location: '<location>'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    managedIdentities: {
      systemAssigned: true
      userAssignedResourceIds: [
        '<managedIdentityResourceId>'
      ]
    }
    privateEndpoints: [
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
        tags: {
          Environment: 'Non-Prod'
          'hidden-title': 'This is visible in the resource name'
          Role: 'DeploymentValidation'
        }
      }
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
      }
    ]
    roleAssignments: [
      {
        name: '8f8b1c39-827f-43e6-a457-98bb15b5dbdf'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    storageAccountAllowBlobPublicAccess: false
    storageAccountHnsEnabled: true
    storageAccountName: '<storageAccountName>'
    storageAccountType: 'Standard_ZRS'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "mlsrmax001"
    },
    // Non-required parameters
    "acrAccountName": {
      "value": "<acrAccountName>"
    },
    "acrSku": {
      "value": "Premium"
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "managedIdentities": {
      "value": {
        "systemAssigned": true,
        "userAssignedResourceIds": [
          "<managedIdentityResourceId>"
        ]
      }
    },
    "privateEndpoints": {
      "value": [
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>",
          "tags": {
            "Environment": "Non-Prod",
            "hidden-title": "This is visible in the resource name",
            "Role": "DeploymentValidation"
          }
        },
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>"
        }
      ]
    },
    "roleAssignments": {
      "value": [
        {
          "name": "8f8b1c39-827f-43e6-a457-98bb15b5dbdf",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "storageAccountAllowBlobPublicAccess": {
      "value": false
    },
    "storageAccountHnsEnabled": {
      "value": true
    },
    "storageAccountName": {
      "value": "<storageAccountName>"
    },
    "storageAccountType": {
      "value": "Standard_ZRS"
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/ml-registry/main.bicep'

// Required parameters
param name = 'mlsrmax001'
// Non-required parameters
param acrAccountName = '<acrAccountName>'
param acrSku = 'Premium'
param location = '<location>'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param managedIdentities = {
  systemAssigned: true
  userAssignedResourceIds: [
    '<managedIdentityResourceId>'
  ]
}
param privateEndpoints = [
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
  }
]
param roleAssignments = [
  {
    name: '8f8b1c39-827f-43e6-a457-98bb15b5dbdf'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param storageAccountAllowBlobPublicAccess = false
param storageAccountHnsEnabled = true
param storageAccountName = '<storageAccountName>'
param storageAccountType = 'Standard_ZRS'
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Example 3: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module registry './packages/ml-registry/main.bicep' = {
  name: 'registryDeployment'
  params: {
    // Required parameters
    name: 'mlsrwaf001'
    // Non-required parameters
    privateEndpoints: [
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "mlsrwaf001"
    },
    // Non-required parameters
    "privateEndpoints": {
      "value": [
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/ml-registry/main.bicep'

// Required parameters
param name = 'mlsrwaf001'
// Non-required parameters
param privateEndpoints = [
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Optional parameters

Parameter: name

Name of the Azure ML Registry.

• Required: Yes
• Type: string

Parameter: acrAccountName

The Azure Container Registry account name to use for the Azure ML Registry. If not specified, a default name will be automatically generated.

• Required: No
• Type: string

Parameter: acrSku

Tier of your Azure container registry.

• Required: No
• Type: string
• Allowed:

  [
    'Basic'
    'Premium'
    'Standard'
  ]
  

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: location

Location for the Azure ML Registry.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: locations

Additional locations for the Azure ML Registry.

• Required: No
• Type: array
• Default: []

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: managedIdentities

The managed identity definition for this resource.

• Required: No
• Type: object

Optional parameters

Parameter: managedIdentities.systemAssigned

Enables system assigned managed identity on the resource.

• Required: No
• Type: bool

Parameter: managedIdentities.userAssignedResourceIds

The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.

• Required: No
• Type: array

Parameter: privateEndpoints

Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.subnetResourceId

Resource ID of the subnet where the endpoint needs to be created.

• Required: Yes
• Type: string

Parameter: privateEndpoints.applicationSecurityGroupResourceIds

Application security groups in which the Private Endpoint IP configuration is included.

• Required: No
• Type: array

Parameter: privateEndpoints.customDnsConfigs

Custom DNS configurations.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.customDnsConfigs.ipAddresses

A list of private IP addresses of the private endpoint.

• Required: Yes
• Type: array

Parameter: privateEndpoints.customDnsConfigs.fqdn

FQDN that resolves to private endpoint IP address.

• Required: No
• Type: string

Parameter: privateEndpoints.customNetworkInterfaceName

The custom name of the network interface attached to the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool

Parameter: privateEndpoints.ipConfigurations

A list of IP configurations of the Private Endpoint. This will be used to map to the first-party Service endpoints.

• Required: No
• Type: array

Required parameters

Parameter: privateEndpoints.ipConfigurations.name

The name of the resource that is unique within a resource group.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties

Properties of private endpoint IP configurations.

• Required: Yes
• Type: object

Required parameters

Parameter: privateEndpoints.ipConfigurations.properties.groupId

The ID of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.memberName

The member name of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.privateIPAddress

A private IP address obtained from the private endpoint's subnet.

• Required: Yes
• Type: string

Parameter: privateEndpoints.isManualConnection

If Manual Private Link Connection is required.

• Required: No
• Type: bool

Parameter: privateEndpoints.location

The location to deploy the Private Endpoint to.

• Required: No
• Type: string

Parameter: privateEndpoints.lock

Specify the type of lock.

• Required: No
• Type: object

Optional parameters

Parameter: privateEndpoints.lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: privateEndpoints.lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: privateEndpoints.manualConnectionRequestMessage

A message passed to the owner of the remote resource with the manual connection request.

• Required: No
• Type: string

Parameter: privateEndpoints.name

The name of the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup

The private DNS Zone Group to configure for the Private Endpoint.

• Required: No
• Type: object

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs

The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group can support up to 5 DNS zones.

• Required: Yes
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.privateDnsZoneResourceId

The resource id of the private DNS zone.

• Required: Yes
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name

The name of the private DNS Zone Group config.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.name

The name of the Private DNS Zone Group.

• Required: No
• Type: string

Parameter: privateEndpoints.privateLinkServiceConnectionName

The name of the private link connection to create.

• Required: No
• Type: string

Parameter: privateEndpoints.resourceGroupResourceId

The resource ID of the Resource Group the Private Endpoint will be created in. If not specified, the Resource Group of the provided Virtual Network Subnet is used.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'DNS Resolver Contributor'
  • 'DNS Zone Contributor'
  • 'Domain Services Contributor'
  • 'Domain Services Reader'
  • 'Network Contributor'
  • 'Owner'
  • 'Private DNS Zone Contributor'
  • 'Reader'
  • 'Role Based Access Control Administrator'

Required parameters

Optional parameters

Parameter: privateEndpoints.roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: privateEndpoints.service

The subresource to deploy the Private Endpoint for. For example "vault" for a Key Vault Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.tags

Tags to be applied on all resources/Resource Groups in this deployment.

• Required: No
• Type: object

Parameter: publicNetworkAccess

Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set and networkRuleSetIpRules are not set.

• Required: No
• Type: string
• Allowed:

  [
    'Disabled'
    'Enabled'
  ]
  

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'AzureML Compute Operator'
  • 'AzureML Data Scientist'
  • 'AzureML Metrics Writer (preview)'
  • 'AzureML Registry User'
  • 'Contributor'
  • 'Owner'
  • 'Reader'
  • 'Role Based Access Control Administrator'
  • 'User Access Administrator'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: storageAccountAllowBlobPublicAccess

Storage account blob public access setting. If not specified, it will be set to false by default.

• Required: No
• Type: bool

Parameter: storageAccountHnsEnabled

Storage account hierarchical namespace (HNS) enabled setting. If not specified, it will be set to true by default.

• Required: No
• Type: bool

Parameter: storageAccountName

The name of the storage account to use for the Azure ML Registry. If not specified, a default name will be generated based on the registry name and location.

• Required: No
• Type: string

Parameter: storageAccountType

The type of storage account to use for the Azure ML Registry. Default is Standard_LRS.

• Required: No
• Type: string
• Allowed:

  [
    'Premium_LRS'
    'Premium_ZRS'
    'Standard_GRS'
    'Standard_GZRS'
    'Standard_LRS'
    'Standard_RAGRS'
    'Standard_RAGZRS'
    'Standard_ZRS'
  ]
  

Parameter: tags

Tags of the resource.

• Required: No
• Type: object

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.