Share via

Microsoft.MachineLearningServices workspaces/privateEndpointConnections 2023-08-01-preview

  • Article

Bicep resource definition

The workspaces/privateEndpointConnections resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2023-08-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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/workspaces/privateEndpointConnections

Name Description Value
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
location Same as workspace location. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces
properties Private endpoint connection properties. PrivateEndpointConnectionProperties
sku Optional. This field is required to be implemented by the RP because AML is supporting more than one tier Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The Private Endpoint resource. WorkspacePrivateEndpointResource
privateLinkServiceConnectionState The connection state. PrivateLinkServiceConnectionState
provisioningState The current provisioning state. 'Creating'
'Deleting'
'Failed'
'Succeeded'

PrivateEndpointConnectionTags

Name Description Value

PrivateLinkServiceConnectionState

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

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'

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

WorkspacePrivateEndpointResource

Name Description Value

ARM template resource definition

The workspaces/privateEndpointConnections resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "privateEndpoint": {
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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/workspaces/privateEndpointConnections

Name Description Value
apiVersion The api version '2023-08-01-preview'
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
location Same as workspace location. string
name The resource name string (required)
properties Private endpoint connection properties. PrivateEndpointConnectionProperties
sku Optional. This field is required to be implemented by the RP because AML is supporting more than one tier Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MachineLearningServices/workspaces/privateEndpointConnections'

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The Private Endpoint resource. WorkspacePrivateEndpointResource
privateLinkServiceConnectionState The connection state. PrivateLinkServiceConnectionState
provisioningState The current provisioning state. 'Creating'
'Deleting'
'Failed'
'Succeeded'

PrivateEndpointConnectionTags

Name Description Value

PrivateLinkServiceConnectionState

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

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'

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

WorkspacePrivateEndpointResource

Name Description Value

Terraform (AzAPI provider) resource definition

The workspaces/privateEndpointConnections 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/workspaces/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2023-08-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  })
}

Property values

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/workspaces/privateEndpointConnections

Name Description Value
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
location Same as workspace location. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Private endpoint connection properties. PrivateEndpointConnectionProperties
sku Optional. This field is required to be implemented by the RP because AML is supporting more than one tier Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2023-08-01-preview"

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The Private Endpoint resource. WorkspacePrivateEndpointResource
privateLinkServiceConnectionState The connection state. PrivateLinkServiceConnectionState
provisioningState The current provisioning state. 'Creating'
'Deleting'
'Failed'
'Succeeded'

PrivateEndpointConnectionTags

Name Description Value

PrivateLinkServiceConnectionState

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

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'

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

WorkspacePrivateEndpointResource

Name Description Value