Share via

Microsoft.MachineLearning webServices 2016-05-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearning/webServices@2016-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    assets: {
      {customized property}: {
        id: 'string'
        inputPorts: {
          {customized property}: {
            type: 'string'
          }
        }
        locationInfo: {
          credentials: 'string'
          uri: 'string'
        }
        metadata: {
          {customized property}: 'string'
        }
        name: 'string'
        outputPorts: {
          {customized property}: {
            type: 'string'
          }
        }
        parameters: [
          {
            modeValuesInfo: {
              {customized property}: {
                interfaceString: 'string'
                parameters: [
                  ...
                ]
              }
            }
            name: 'string'
            parameterType: 'string'
          }
        ]
        type: 'string'
      }
    }
    commitmentPlan: {
      id: 'string'
    }
    description: 'string'
    diagnostics: {
      expiry: 'string'
      level: 'string'
    }
    exampleRequest: {
      globalParameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      inputs: {
        {customized property}: [
          [
            any(Azure.Bicep.Types.Concrete.AnyType)
          ]
        ]
      }
    }
    exposeSampleData: bool
    input: {
      description: 'string'
      properties: {
        {customized property}: {
          description: 'string'
          format: 'string'
          properties: {
            {customized property}: {
              enum: [
                any(Azure.Bicep.Types.Concrete.AnyType)
              ]
              format: 'string'
              type: 'string'
              x-ms-isnullable: bool
              x-ms-isordered: bool
            }
          }
          title: 'string'
          type: 'string'
        }
      }
      title: 'string'
      type: 'string'
    }
    keys: {
      primary: 'string'
      secondary: 'string'
    }
    machineLearningWorkspace: {
      id: 'string'
    }
    output: {
      description: 'string'
      properties: {
        {customized property}: {
          description: 'string'
          format: 'string'
          properties: {
            {customized property}: {
              enum: [
                any(Azure.Bicep.Types.Concrete.AnyType)
              ]
              format: 'string'
              type: 'string'
              x-ms-isnullable: bool
              x-ms-isordered: bool
            }
          }
          title: 'string'
          type: 'string'
        }
      }
      title: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: 'string'
    }
    readOnly: bool
    realtimeConfiguration: {
      maxConcurrentCalls: int
    }
    storageAccount: {
      key: 'string'
      name: 'string'
    }
    title: 'string'
    packageType: 'string'
    // For remaining properties, see WebServiceProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

WebServiceProperties objects

Set the packageType property to specify the type of object.

For Graph, use:

{
  package: {
    edges: [
      {
        sourceNodeId: 'string'
        sourcePortId: 'string'
        targetNodeId: 'string'
        targetPortId: 'string'
      }
    ]
    graphParameters: {
      {customized property}: {
        description: 'string'
        links: [
          {
            nodeId: 'string'
            parameterKey: 'string'
          }
        ]
        type: 'string'
      }
    }
    nodes: {
      {customized property}: {
        assetId: 'string'
        inputId: 'string'
        outputId: 'string'
        parameters: {
          {customized property}: 'string'
        }
      }
    }
  }
  packageType: 'Graph'
}

Property values

AssetItem

Name Description Value
id Asset's Id. string
inputPorts Information about the asset's input ports. AssetItemInputPorts
locationInfo Access information for the asset. AssetLocation (required)
metadata If the asset is a custom module, this holds the module's metadata. AssetItemMetadata
name Asset's friendly name. string (required)
outputPorts Information about the asset's output ports. AssetItemOutputPorts
parameters If the asset is a custom module, this holds the module's parameters. ModuleAssetParameter[]
type Asset's type. 'Module'
'Resource' (required)

AssetItemInputPorts

Name Description Value

AssetItemMetadata

Name Description Value

AssetItemOutputPorts

Name Description Value

AssetLocation

Name Description Value
credentials Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) string
uri The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets string (required)

ColumnSpecification

Name Description Value
enum If the data type is categorical, this provides the list of accepted categories. any[]
format Additional format information for the data type. 'Byte'
'Char'
'Complex128'
'Complex64'
'Date-time'
'Date-timeOffset'
'Double'
'Duration'
'Float'
'Int16'
'Int32'
'Int64'
'Int8'
'Uint16'
'Uint32'
'Uint64'
'Uint8'
type Data type of the column. 'Boolean'
'Integer'
'Number'
'String' (required)
x-ms-isnullable Flag indicating if the type supports null values or not. bool
x-ms-isordered Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. bool

CommitmentPlanAutoGenerated

Name Description Value
id Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. string (required)

DiagnosticsConfiguration

Name Description Value
expiry Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. string
level Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). 'All'
'Error'
'None' (required)

ExampleRequest

Name Description Value
globalParameters Sample input data for the web service's global parameters ExampleRequestGlobalParameters
inputs Sample input data for the web service's input(s) given as an input name to sample input values matrix map. ExampleRequestInputs

ExampleRequestGlobalParameters

Name Description Value

ExampleRequestInputs

Name Description Value

GraphEdge

Name Description Value
sourceNodeId The source graph node's identifier. string
sourcePortId The identifier of the source node's port that the edge connects from. string
targetNodeId The destination graph node's identifier. string
targetPortId The identifier of the destination node's port that the edge connects into. string

GraphNode

Name Description Value
assetId The id of the asset represented by this node. string
inputId The id of the input element represented by this node. string
outputId The id of the output element represented by this node. string
parameters If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. GraphNodeParameters

GraphNodeParameters

Name Description Value

GraphPackage

Name Description Value
edges The list of edges making up the graph. GraphEdge[]
graphParameters The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level. GraphPackageGraphParameters
nodes The set of nodes making up the graph, provided as a nodeId to GraphNode map GraphPackageNodes

GraphPackageGraphParameters

Name Description Value

GraphPackageNodes

Name Description Value

GraphParameter

Name Description Value
description Description of this graph parameter. string
links Association links for this parameter to nodes in the graph. GraphParameterLink[] (required)
type Graph parameter's type. 'Boolean'
'ColumnPicker'
'Credential'
'DataGatewayName'
'Double'
'Enumerated'
'Float'
'Int'
'Mode'
'ParameterRange'
'Script'
'String' (required)
Name Description Value
nodeId The graph node's identifier string (required)
parameterKey The identifier of the node parameter that the global parameter maps to. string (required)

InputPort

Name Description Value
type Port data type. 'Dataset'

MachineLearningWorkspace

Name Description Value
id Specifies the workspace ID of the machine learning workspace associated with the web service string (required)

Microsoft.MachineLearning/webServices

Name Description Value
location Specifies the location of the resource. string (required)
name The resource name string (required)
properties Contains the property payload that describes the web service. WebServiceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

ModeValueInfo

Name Description Value
interfaceString The interface string name for the nested parameter. string
parameters The definition of the parameter. ModuleAssetParameter[]

ModuleAssetParameter

Name Description Value
modeValuesInfo Definitions for nested interface parameters if this is a complex module parameter. ModuleAssetParameterModeValuesInfo
name Parameter name. string
parameterType Parameter type. string

ModuleAssetParameterModeValuesInfo

Name Description Value

OutputPort

Name Description Value
type Port data type. 'Dataset'

RealtimeConfiguration

Name Description Value
maxConcurrentCalls Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. int

Constraints:
Min value = 4
Max value = 200

ResourceTags

Name Description Value

ServiceInputOutputSpecification

Name Description Value
description The description of the Swagger schema. string
properties Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. ServiceInputOutputSpecificationProperties (required)
title The title of your Swagger schema. string
type The type of the entity described in swagger. Always 'object'. string (required)

ServiceInputOutputSpecificationProperties

Name Description Value

StorageAccount

Name Description Value
key Specifies the key used to access the storage account. string
name Specifies the name of the storage account. string

TableSpecification

Name Description Value
description Swagger schema description. string
format The format, if 'type' is not 'object' string
properties The set of columns within the data table. TableSpecificationProperties
title Swagger schema title. string
type The type of the entity described in swagger. string (required)

TableSpecificationProperties

Name Description Value

WebServiceKeys

Name Description Value
primary The primary access key. string
secondary The secondary access key. string

WebServiceProperties

Name Description Value
assets Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. WebServicePropertiesAssets
commitmentPlan Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations. CommitmentPlanAutoGenerated
description The description of the web service. string
diagnostics Settings controlling the diagnostics traces collection for the web service. DiagnosticsConfiguration
exampleRequest Defines sample input data for one or more of the service's inputs. ExampleRequest
exposeSampleData When set to true, sample data is included in the web service's swagger definition. The default value is true. bool
input Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
keys Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations. WebServiceKeys
machineLearningWorkspace Specifies the Machine Learning workspace containing the experiment that is source for the web service. MachineLearningWorkspace
output Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
packageType Set to 'Graph' for type WebServicePropertiesForGraph. 'Graph' (required)
parameters The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required. WebServicePropertiesParameters
readOnly When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value. bool
realtimeConfiguration Contains the configuration settings for the web service endpoint. RealtimeConfiguration
storageAccount Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail. StorageAccount
title The title of the web service. string

WebServicePropertiesAssets

Name Description Value

WebServicePropertiesForGraph

Name Description Value
package The definition of the graph package making up this web service. GraphPackage
packageType Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. 'Graph' (required)

WebServicePropertiesParameters

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearning/webServices",
  "apiVersion": "2016-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "assets": {
      "{customized property}": {
        "id": "string",
        "inputPorts": {
          "{customized property}": {
            "type": "string"
          }
        },
        "locationInfo": {
          "credentials": "string",
          "uri": "string"
        },
        "metadata": {
          "{customized property}": "string"
        },
        "name": "string",
        "outputPorts": {
          "{customized property}": {
            "type": "string"
          }
        },
        "parameters": [
          {
            "modeValuesInfo": {
              "{customized property}": {
                "interfaceString": "string",
                "parameters": [
                  ...
                ]
              }
            },
            "name": "string",
            "parameterType": "string"
          }
        ],
        "type": "string"
      }
    },
    "commitmentPlan": {
      "id": "string"
    },
    "description": "string",
    "diagnostics": {
      "expiry": "string",
      "level": "string"
    },
    "exampleRequest": {
      "globalParameters": {
        "{customized property}": {}
      },
      "inputs": {
        "{customized property}": [
          [ {} ]
        ]
      }
    },
    "exposeSampleData": "bool",
    "input": {
      "description": "string",
      "properties": {
        "{customized property}": {
          "description": "string",
          "format": "string",
          "properties": {
            "{customized property}": {
              "enum": [ {} ],
              "format": "string",
              "type": "string",
              "x-ms-isnullable": "bool",
              "x-ms-isordered": "bool"
            }
          },
          "title": "string",
          "type": "string"
        }
      },
      "title": "string",
      "type": "string"
    },
    "keys": {
      "primary": "string",
      "secondary": "string"
    },
    "machineLearningWorkspace": {
      "id": "string"
    },
    "output": {
      "description": "string",
      "properties": {
        "{customized property}": {
          "description": "string",
          "format": "string",
          "properties": {
            "{customized property}": {
              "enum": [ {} ],
              "format": "string",
              "type": "string",
              "x-ms-isnullable": "bool",
              "x-ms-isordered": "bool"
            }
          },
          "title": "string",
          "type": "string"
        }
      },
      "title": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": "string"
    },
    "readOnly": "bool",
    "realtimeConfiguration": {
      "maxConcurrentCalls": "int"
    },
    "storageAccount": {
      "key": "string",
      "name": "string"
    },
    "title": "string",
    "packageType": "string"
    // For remaining properties, see WebServiceProperties objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

WebServiceProperties objects

Set the packageType property to specify the type of object.

For Graph, use:

{
  "package": {
    "edges": [
      {
        "sourceNodeId": "string",
        "sourcePortId": "string",
        "targetNodeId": "string",
        "targetPortId": "string"
      }
    ],
    "graphParameters": {
      "{customized property}": {
        "description": "string",
        "links": [
          {
            "nodeId": "string",
            "parameterKey": "string"
          }
        ],
        "type": "string"
      }
    },
    "nodes": {
      "{customized property}": {
        "assetId": "string",
        "inputId": "string",
        "outputId": "string",
        "parameters": {
          "{customized property}": "string"
        }
      }
    }
  },
  "packageType": "Graph"
}

Property values

AssetItem

Name Description Value
id Asset's Id. string
inputPorts Information about the asset's input ports. AssetItemInputPorts
locationInfo Access information for the asset. AssetLocation (required)
metadata If the asset is a custom module, this holds the module's metadata. AssetItemMetadata
name Asset's friendly name. string (required)
outputPorts Information about the asset's output ports. AssetItemOutputPorts
parameters If the asset is a custom module, this holds the module's parameters. ModuleAssetParameter[]
type Asset's type. 'Module'
'Resource' (required)

AssetItemInputPorts

Name Description Value

AssetItemMetadata

Name Description Value

AssetItemOutputPorts

Name Description Value

AssetLocation

Name Description Value
credentials Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) string
uri The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets string (required)

ColumnSpecification

Name Description Value
enum If the data type is categorical, this provides the list of accepted categories. any[]
format Additional format information for the data type. 'Byte'
'Char'
'Complex128'
'Complex64'
'Date-time'
'Date-timeOffset'
'Double'
'Duration'
'Float'
'Int16'
'Int32'
'Int64'
'Int8'
'Uint16'
'Uint32'
'Uint64'
'Uint8'
type Data type of the column. 'Boolean'
'Integer'
'Number'
'String' (required)
x-ms-isnullable Flag indicating if the type supports null values or not. bool
x-ms-isordered Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. bool

CommitmentPlanAutoGenerated

Name Description Value
id Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. string (required)

DiagnosticsConfiguration

Name Description Value
expiry Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. string
level Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). 'All'
'Error'
'None' (required)

ExampleRequest

Name Description Value
globalParameters Sample input data for the web service's global parameters ExampleRequestGlobalParameters
inputs Sample input data for the web service's input(s) given as an input name to sample input values matrix map. ExampleRequestInputs

ExampleRequestGlobalParameters

Name Description Value

ExampleRequestInputs

Name Description Value

GraphEdge

Name Description Value
sourceNodeId The source graph node's identifier. string
sourcePortId The identifier of the source node's port that the edge connects from. string
targetNodeId The destination graph node's identifier. string
targetPortId The identifier of the destination node's port that the edge connects into. string

GraphNode

Name Description Value
assetId The id of the asset represented by this node. string
inputId The id of the input element represented by this node. string
outputId The id of the output element represented by this node. string
parameters If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. GraphNodeParameters

GraphNodeParameters

Name Description Value

GraphPackage

Name Description Value
edges The list of edges making up the graph. GraphEdge[]
graphParameters The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level. GraphPackageGraphParameters
nodes The set of nodes making up the graph, provided as a nodeId to GraphNode map GraphPackageNodes

GraphPackageGraphParameters

Name Description Value

GraphPackageNodes

Name Description Value

GraphParameter

Name Description Value
description Description of this graph parameter. string
links Association links for this parameter to nodes in the graph. GraphParameterLink[] (required)
type Graph parameter's type. 'Boolean'
'ColumnPicker'
'Credential'
'DataGatewayName'
'Double'
'Enumerated'
'Float'
'Int'
'Mode'
'ParameterRange'
'Script'
'String' (required)
Name Description Value
nodeId The graph node's identifier string (required)
parameterKey The identifier of the node parameter that the global parameter maps to. string (required)

InputPort

Name Description Value
type Port data type. 'Dataset'

MachineLearningWorkspace

Name Description Value
id Specifies the workspace ID of the machine learning workspace associated with the web service string (required)

Microsoft.MachineLearning/webServices

Name Description Value
apiVersion The api version '2016-05-01-preview'
location Specifies the location of the resource. string (required)
name The resource name string (required)
properties Contains the property payload that describes the web service. WebServiceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MachineLearning/webServices'

ModeValueInfo

Name Description Value
interfaceString The interface string name for the nested parameter. string
parameters The definition of the parameter. ModuleAssetParameter[]

ModuleAssetParameter

Name Description Value
modeValuesInfo Definitions for nested interface parameters if this is a complex module parameter. ModuleAssetParameterModeValuesInfo
name Parameter name. string
parameterType Parameter type. string

ModuleAssetParameterModeValuesInfo

Name Description Value

OutputPort

Name Description Value
type Port data type. 'Dataset'

RealtimeConfiguration

Name Description Value
maxConcurrentCalls Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. int

Constraints:
Min value = 4
Max value = 200

ResourceTags

Name Description Value

ServiceInputOutputSpecification

Name Description Value
description The description of the Swagger schema. string
properties Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. ServiceInputOutputSpecificationProperties (required)
title The title of your Swagger schema. string
type The type of the entity described in swagger. Always 'object'. string (required)

ServiceInputOutputSpecificationProperties

Name Description Value

StorageAccount

Name Description Value
key Specifies the key used to access the storage account. string
name Specifies the name of the storage account. string

TableSpecification

Name Description Value
description Swagger schema description. string
format The format, if 'type' is not 'object' string
properties The set of columns within the data table. TableSpecificationProperties
title Swagger schema title. string
type The type of the entity described in swagger. string (required)

TableSpecificationProperties

Name Description Value

WebServiceKeys

Name Description Value
primary The primary access key. string
secondary The secondary access key. string

WebServiceProperties

Name Description Value
assets Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. WebServicePropertiesAssets
commitmentPlan Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations. CommitmentPlanAutoGenerated
description The description of the web service. string
diagnostics Settings controlling the diagnostics traces collection for the web service. DiagnosticsConfiguration
exampleRequest Defines sample input data for one or more of the service's inputs. ExampleRequest
exposeSampleData When set to true, sample data is included in the web service's swagger definition. The default value is true. bool
input Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
keys Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations. WebServiceKeys
machineLearningWorkspace Specifies the Machine Learning workspace containing the experiment that is source for the web service. MachineLearningWorkspace
output Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
packageType Set to 'Graph' for type WebServicePropertiesForGraph. 'Graph' (required)
parameters The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required. WebServicePropertiesParameters
readOnly When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value. bool
realtimeConfiguration Contains the configuration settings for the web service endpoint. RealtimeConfiguration
storageAccount Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail. StorageAccount
title The title of the web service. string

WebServicePropertiesAssets

Name Description Value

WebServicePropertiesForGraph

Name Description Value
package The definition of the graph package making up this web service. GraphPackage
packageType Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. 'Graph' (required)

WebServicePropertiesParameters

Name Description Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearning/webServices@2016-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      assets = {
        {customized property} = {
          id = "string"
          inputPorts = {
            {customized property} = {
              type = "string"
            }
          }
          locationInfo = {
            credentials = "string"
            uri = "string"
          }
          metadata = {
            {customized property} = "string"
          }
          name = "string"
          outputPorts = {
            {customized property} = {
              type = "string"
            }
          }
          parameters = [
            {
              modeValuesInfo = {
                {customized property} = {
                  interfaceString = "string"
                  parameters = [
                    ...
                  ]
                }
              }
              name = "string"
              parameterType = "string"
            }
          ]
          type = "string"
        }
      }
      commitmentPlan = {
        id = "string"
      }
      description = "string"
      diagnostics = {
        expiry = "string"
        level = "string"
      }
      exampleRequest = {
        globalParameters = {
          {customized property} = ?
        }
        inputs = {
          {customized property} = [
            [
              ?
            ]
          ]
        }
      }
      exposeSampleData = bool
      input = {
        description = "string"
        properties = {
          {customized property} = {
            description = "string"
            format = "string"
            properties = {
              {customized property} = {
                enum = [
                  ?
                ]
                format = "string"
                type = "string"
                x-ms-isnullable = bool
                x-ms-isordered = bool
              }
            }
            title = "string"
            type = "string"
          }
        }
        title = "string"
        type = "string"
      }
      keys = {
        primary = "string"
        secondary = "string"
      }
      machineLearningWorkspace = {
        id = "string"
      }
      output = {
        description = "string"
        properties = {
          {customized property} = {
            description = "string"
            format = "string"
            properties = {
              {customized property} = {
                enum = [
                  ?
                ]
                format = "string"
                type = "string"
                x-ms-isnullable = bool
                x-ms-isordered = bool
              }
            }
            title = "string"
            type = "string"
          }
        }
        title = "string"
        type = "string"
      }
      parameters = {
        {customized property} = "string"
      }
      readOnly = bool
      realtimeConfiguration = {
        maxConcurrentCalls = int
      }
      storageAccount = {
        key = "string"
        name = "string"
      }
      title = "string"
      packageType = "string"
      // For remaining properties, see WebServiceProperties objects
    }
  })
}

WebServiceProperties objects

Set the packageType property to specify the type of object.

For Graph, use:

{
  package = {
    edges = [
      {
        sourceNodeId = "string"
        sourcePortId = "string"
        targetNodeId = "string"
        targetPortId = "string"
      }
    ]
    graphParameters = {
      {customized property} = {
        description = "string"
        links = [
          {
            nodeId = "string"
            parameterKey = "string"
          }
        ]
        type = "string"
      }
    }
    nodes = {
      {customized property} = {
        assetId = "string"
        inputId = "string"
        outputId = "string"
        parameters = {
          {customized property} = "string"
        }
      }
    }
  }
  packageType = "Graph"
}

Property values

AssetItem

Name Description Value
id Asset's Id. string
inputPorts Information about the asset's input ports. AssetItemInputPorts
locationInfo Access information for the asset. AssetLocation (required)
metadata If the asset is a custom module, this holds the module's metadata. AssetItemMetadata
name Asset's friendly name. string (required)
outputPorts Information about the asset's output ports. AssetItemOutputPorts
parameters If the asset is a custom module, this holds the module's parameters. ModuleAssetParameter[]
type Asset's type. 'Module'
'Resource' (required)

AssetItemInputPorts

Name Description Value

AssetItemMetadata

Name Description Value

AssetItemOutputPorts

Name Description Value

AssetLocation

Name Description Value
credentials Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) string
uri The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets string (required)

ColumnSpecification

Name Description Value
enum If the data type is categorical, this provides the list of accepted categories. any[]
format Additional format information for the data type. 'Byte'
'Char'
'Complex128'
'Complex64'
'Date-time'
'Date-timeOffset'
'Double'
'Duration'
'Float'
'Int16'
'Int32'
'Int64'
'Int8'
'Uint16'
'Uint32'
'Uint64'
'Uint8'
type Data type of the column. 'Boolean'
'Integer'
'Number'
'String' (required)
x-ms-isnullable Flag indicating if the type supports null values or not. bool
x-ms-isordered Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. bool

CommitmentPlanAutoGenerated

Name Description Value
id Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. string (required)

DiagnosticsConfiguration

Name Description Value
expiry Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. string
level Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). 'All'
'Error'
'None' (required)

ExampleRequest

Name Description Value
globalParameters Sample input data for the web service's global parameters ExampleRequestGlobalParameters
inputs Sample input data for the web service's input(s) given as an input name to sample input values matrix map. ExampleRequestInputs

ExampleRequestGlobalParameters

Name Description Value

ExampleRequestInputs

Name Description Value

GraphEdge

Name Description Value
sourceNodeId The source graph node's identifier. string
sourcePortId The identifier of the source node's port that the edge connects from. string
targetNodeId The destination graph node's identifier. string
targetPortId The identifier of the destination node's port that the edge connects into. string

GraphNode

Name Description Value
assetId The id of the asset represented by this node. string
inputId The id of the input element represented by this node. string
outputId The id of the output element represented by this node. string
parameters If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. GraphNodeParameters

GraphNodeParameters

Name Description Value

GraphPackage

Name Description Value
edges The list of edges making up the graph. GraphEdge[]
graphParameters The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level. GraphPackageGraphParameters
nodes The set of nodes making up the graph, provided as a nodeId to GraphNode map GraphPackageNodes

GraphPackageGraphParameters

Name Description Value

GraphPackageNodes

Name Description Value

GraphParameter

Name Description Value
description Description of this graph parameter. string
links Association links for this parameter to nodes in the graph. GraphParameterLink[] (required)
type Graph parameter's type. 'Boolean'
'ColumnPicker'
'Credential'
'DataGatewayName'
'Double'
'Enumerated'
'Float'
'Int'
'Mode'
'ParameterRange'
'Script'
'String' (required)
Name Description Value
nodeId The graph node's identifier string (required)
parameterKey The identifier of the node parameter that the global parameter maps to. string (required)

InputPort

Name Description Value
type Port data type. 'Dataset'

MachineLearningWorkspace

Name Description Value
id Specifies the workspace ID of the machine learning workspace associated with the web service string (required)

Microsoft.MachineLearning/webServices

Name Description Value
location Specifies the location of the resource. string (required)
name The resource name string (required)
properties Contains the property payload that describes the web service. WebServiceProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MachineLearning/webServices@2016-05-01-preview"

ModeValueInfo

Name Description Value
interfaceString The interface string name for the nested parameter. string
parameters The definition of the parameter. ModuleAssetParameter[]

ModuleAssetParameter

Name Description Value
modeValuesInfo Definitions for nested interface parameters if this is a complex module parameter. ModuleAssetParameterModeValuesInfo
name Parameter name. string
parameterType Parameter type. string

ModuleAssetParameterModeValuesInfo

Name Description Value

OutputPort

Name Description Value
type Port data type. 'Dataset'

RealtimeConfiguration

Name Description Value
maxConcurrentCalls Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. int

Constraints:
Min value = 4
Max value = 200

ResourceTags

Name Description Value

ServiceInputOutputSpecification

Name Description Value
description The description of the Swagger schema. string
properties Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. ServiceInputOutputSpecificationProperties (required)
title The title of your Swagger schema. string
type The type of the entity described in swagger. Always 'object'. string (required)

ServiceInputOutputSpecificationProperties

Name Description Value

StorageAccount

Name Description Value
key Specifies the key used to access the storage account. string
name Specifies the name of the storage account. string

TableSpecification

Name Description Value
description Swagger schema description. string
format The format, if 'type' is not 'object' string
properties The set of columns within the data table. TableSpecificationProperties
title Swagger schema title. string
type The type of the entity described in swagger. string (required)

TableSpecificationProperties

Name Description Value

WebServiceKeys

Name Description Value
primary The primary access key. string
secondary The secondary access key. string

WebServiceProperties

Name Description Value
assets Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. WebServicePropertiesAssets
commitmentPlan Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations. CommitmentPlanAutoGenerated
description The description of the web service. string
diagnostics Settings controlling the diagnostics traces collection for the web service. DiagnosticsConfiguration
exampleRequest Defines sample input data for one or more of the service's inputs. ExampleRequest
exposeSampleData When set to true, sample data is included in the web service's swagger definition. The default value is true. bool
input Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
keys Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations. WebServiceKeys
machineLearningWorkspace Specifies the Machine Learning workspace containing the experiment that is source for the web service. MachineLearningWorkspace
output Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification. ServiceInputOutputSpecification
packageType Set to 'Graph' for type WebServicePropertiesForGraph. 'Graph' (required)
parameters The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required. WebServicePropertiesParameters
readOnly When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value. bool
realtimeConfiguration Contains the configuration settings for the web service endpoint. RealtimeConfiguration
storageAccount Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail. StorageAccount
title The title of the web service. string

WebServicePropertiesAssets

Name Description Value

WebServicePropertiesForGraph

Name Description Value
package The definition of the graph package making up this web service. GraphPackage
packageType Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. 'Graph' (required)

WebServicePropertiesParameters

Name Description Value