Microsoft.MachineLearningServices workspaces/privateEndpointConnections 2020-04-01

Template format

To create a Microsoft.MachineLearningServices/workspaces/privateEndpointConnections resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections",
  "apiVersion": "2020-04-01",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string",
    "tier": "string"
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionsRequired": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.MachineLearningServices/workspaces/privateEndpointConnections object

Name Type Required Value
name string Yes The name of the private endpoint connection associated with the workspace
type enum Yes privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes 2020-04-01
identity object No The identity of the resource. - Identity object
location string No Specifies the location of the resource.
tags object No Contains resource tags defined as key/value pairs.
sku object No The sku of the workspace. - Sku object
properties object Yes Resource properties. - PrivateEndpointConnectionProperties object

Identity object

Name Type Required Value
type enum Yes The identity type. - SystemAssigned, UserAssigned, SystemAssigned,UserAssigned, None
userAssignedIdentities object No The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Sku object

Name Type Required Value
name string No Name of the sku
tier string No Tier of the sku like Basic or Enterprise

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No The resource of private end point. - PrivateEndpoint object
privateLinkServiceConnectionState object Yes A collection of information about the state of the connection between service consumer and provider. - PrivateLinkServiceConnectionState object

PrivateLinkServiceConnectionState object

Name Type Required Value
status enum No Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. - Pending, Approved, Rejected, Disconnected, Timeout
description string No The reason for approval/rejection of the connection.
actionsRequired string No A message indicating if changes on the service provider require any updates on the consumer.