Share via

Microsoft.MachineLearningServices workspaces/outboundRules 2023-10-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/outboundRules@2023-10-01' = {
  name: 'string'
  properties: {
    category: 'string'
    status: 'string'
    type: 'string'
    // For remaining properties, see OutboundRule objects
  }
}

OutboundRule objects

Set the type property to specify the type of object.

For FQDN, use:

{
  destination: 'string'
  type: 'FQDN'
}

For PrivateEndpoint, use:

{
  destination: {
    serviceResourceId: 'string'
    sparkEnabled: bool
    sparkStatus: 'string'
    subresourceTarget: 'string'
  }
  type: 'PrivateEndpoint'
}

For ServiceTag, use:

{
  destination: {
    action: 'string'
    portRanges: 'string'
    protocol: 'string'
    serviceTag: 'string'
  }
  type: 'ServiceTag'
}

Property values

FqdnOutboundRule

Name Description Value
destination string
type Type of a managed network Outbound Rule of a machine learning workspace. 'FQDN' (required)

Microsoft.MachineLearningServices/workspaces/outboundRules

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (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 Outbound Rule for the managed network of a machine learning workspace. OutboundRule (required)

OutboundRule

Name Description Value
category Category of a managed network Outbound Rule of a machine learning workspace. 'Recommended'
'Required'
'UserDefined'
status Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
type Set to 'FQDN' for type FqdnOutboundRule. Set to 'PrivateEndpoint' for type PrivateEndpointOutboundRule. Set to 'ServiceTag' for type ServiceTagOutboundRule. 'FQDN'
'PrivateEndpoint'
'ServiceTag' (required)

PrivateEndpointDestination

Name Description Value
serviceResourceId string
sparkEnabled bool
sparkStatus Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
subresourceTarget string

PrivateEndpointOutboundRule

Name Description Value
destination Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. PrivateEndpointDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'PrivateEndpoint' (required)

ServiceTagDestination

Name Description Value
action The action enum for networking rule. 'Allow'
'Deny'
portRanges string
protocol string
serviceTag string

ServiceTagOutboundRule

Name Description Value
destination Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. ServiceTagDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'ServiceTag' (required)

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/outboundRules",
  "apiVersion": "2023-10-01",
  "name": "string",
  "properties": {
    "category": "string",
    "status": "string",
    "type": "string"
    // For remaining properties, see OutboundRule objects
  }
}

OutboundRule objects

Set the type property to specify the type of object.

For FQDN, use:

{
  "destination": "string",
  "type": "FQDN"
}

For PrivateEndpoint, use:

{
  "destination": {
    "serviceResourceId": "string",
    "sparkEnabled": "bool",
    "sparkStatus": "string",
    "subresourceTarget": "string"
  },
  "type": "PrivateEndpoint"
}

For ServiceTag, use:

{
  "destination": {
    "action": "string",
    "portRanges": "string",
    "protocol": "string",
    "serviceTag": "string"
  },
  "type": "ServiceTag"
}

Property values

FqdnOutboundRule

Name Description Value
destination string
type Type of a managed network Outbound Rule of a machine learning workspace. 'FQDN' (required)

Microsoft.MachineLearningServices/workspaces/outboundRules

Name Description Value
apiVersion The api version '2023-10-01'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
properties Outbound Rule for the managed network of a machine learning workspace. OutboundRule (required)
type The resource type 'Microsoft.MachineLearningServices/workspaces/outboundRules'

OutboundRule

Name Description Value
category Category of a managed network Outbound Rule of a machine learning workspace. 'Recommended'
'Required'
'UserDefined'
status Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
type Set to 'FQDN' for type FqdnOutboundRule. Set to 'PrivateEndpoint' for type PrivateEndpointOutboundRule. Set to 'ServiceTag' for type ServiceTagOutboundRule. 'FQDN'
'PrivateEndpoint'
'ServiceTag' (required)

PrivateEndpointDestination

Name Description Value
serviceResourceId string
sparkEnabled bool
sparkStatus Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
subresourceTarget string

PrivateEndpointOutboundRule

Name Description Value
destination Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. PrivateEndpointDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'PrivateEndpoint' (required)

ServiceTagDestination

Name Description Value
action The action enum for networking rule. 'Allow'
'Deny'
portRanges string
protocol string
serviceTag string

ServiceTagOutboundRule

Name Description Value
destination Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. ServiceTagDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'ServiceTag' (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/outboundRules@2023-10-01"
  name = "string"
  body = jsonencode({
    properties = {
      category = "string"
      status = "string"
      type = "string"
      // For remaining properties, see OutboundRule objects
    }
  })
}

OutboundRule objects

Set the type property to specify the type of object.

For FQDN, use:

{
  destination = "string"
  type = "FQDN"
}

For PrivateEndpoint, use:

{
  destination = {
    serviceResourceId = "string"
    sparkEnabled = bool
    sparkStatus = "string"
    subresourceTarget = "string"
  }
  type = "PrivateEndpoint"
}

For ServiceTag, use:

{
  destination = {
    action = "string"
    portRanges = "string"
    protocol = "string"
    serviceTag = "string"
  }
  type = "ServiceTag"
}

Property values

FqdnOutboundRule

Name Description Value
destination string
type Type of a managed network Outbound Rule of a machine learning workspace. 'FQDN' (required)

Microsoft.MachineLearningServices/workspaces/outboundRules

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Outbound Rule for the managed network of a machine learning workspace. OutboundRule (required)
type The resource type "Microsoft.MachineLearningServices/workspaces/outboundRules@2023-10-01"

OutboundRule

Name Description Value
category Category of a managed network Outbound Rule of a machine learning workspace. 'Recommended'
'Required'
'UserDefined'
status Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
type Set to 'FQDN' for type FqdnOutboundRule. Set to 'PrivateEndpoint' for type PrivateEndpointOutboundRule. Set to 'ServiceTag' for type ServiceTagOutboundRule. 'FQDN'
'PrivateEndpoint'
'ServiceTag' (required)

PrivateEndpointDestination

Name Description Value
serviceResourceId string
sparkEnabled bool
sparkStatus Type of a managed network Outbound Rule of a machine learning workspace. 'Active'
'Inactive'
subresourceTarget string

PrivateEndpointOutboundRule

Name Description Value
destination Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. PrivateEndpointDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'PrivateEndpoint' (required)

ServiceTagDestination

Name Description Value
action The action enum for networking rule. 'Allow'
'Deny'
portRanges string
protocol string
serviceTag string

ServiceTagOutboundRule

Name Description Value
destination Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. ServiceTagDestination
type Type of a managed network Outbound Rule of a machine learning workspace. 'ServiceTag' (required)