Share via

Microsoft.MachineLearningServices workspaces/outboundRules 2023-06-01-preview

  • 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-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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:

  type: 'FQDN'
  destination: 'string'

For PrivateEndpoint, use:

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

For ServiceTag, use:

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

Property values

workspaces/outboundRules

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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 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 the object type FQDN
PrivateEndpoint
ServiceTag (required)

FqdnOutboundRule

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

PrivateEndpointOutboundRule

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

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

ServiceTagOutboundRule

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

ServiceTagDestination

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

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-06-01-preview",
  "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:

  "type": "FQDN",
  "destination": "string"

For PrivateEndpoint, use:

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

For ServiceTag, use:

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

Property values

workspaces/outboundRules

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/outboundRules'
apiVersion The resource api version '2023-06-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
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 the object type FQDN
PrivateEndpoint
ServiceTag (required)

FqdnOutboundRule

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

PrivateEndpointOutboundRule

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

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

ServiceTagOutboundRule

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

ServiceTagDestination

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

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-06-01-preview"
  name = "string"
  parent_id = "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:

  type = "FQDN"
  destination = "string"

For PrivateEndpoint, use:

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

For ServiceTag, use:

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

Property values

workspaces/outboundRules

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/outboundRules@2023-06-01-preview"
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 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 the object type FQDN
PrivateEndpoint
ServiceTag (required)

FqdnOutboundRule

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

PrivateEndpointOutboundRule

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

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

ServiceTagOutboundRule

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

ServiceTagDestination

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