你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.MachineLearning webServices 2016-05-01-preview

Bicep 资源定义

webServices 资源类型可以部署到:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearning/webServices 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.MachineLearning/webServices@2016-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    assets: {}
    commitmentPlan: {
      id: 'string'
    }
    description: 'string'
    diagnostics: {
      expiry: 'string'
      level: 'string'
    }
    exampleRequest: {
      globalParameters: {}
      inputs: {}
    }
    exposeSampleData: bool
    input: {
      description: 'string'
      properties: {}
      title: 'string'
      type: 'string'
    }
    keys: {
      primary: 'string'
      secondary: 'string'
    }
    machineLearningWorkspace: {
      id: 'string'
    }
    output: {
      description: 'string'
      properties: {}
      title: 'string'
      type: 'string'
    }
    parameters: {}
    readOnly: bool
    realtimeConfiguration: {
      maxConcurrentCalls: int
    }
    storageAccount: {
      key: 'string'
      name: 'string'
    }
    title: 'string'
    packageType: 'string'
    // For remaining properties, see WebServiceProperties objects
  }
}

WebServiceProperties 对象

设置 packageType 属性以指定对象的类型。

对于 Graph,请使用:

  packageType: 'Graph'
  package: {
    edges: [
      {
        sourceNodeId: 'string'
        sourcePortId: 'string'
        targetNodeId: 'string'
        targetPortId: 'string'
      }
    ]
    graphParameters: {}
    nodes: {}
  }

属性值

webServices

名称 说明 Value
name 资源名称 字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*%&:?+/\\ 或控制字符

不得以空格结尾。
location 指定资源的位置。 字符串 (必需)
标记 包含定义为键/值对的资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 包含描述 Web 服务的属性有效负载。 需要 webServiceProperties ()

WebServiceProperties

名称 说明 Value
资产 包含描述 Web 服务资产的用户定义属性。 属性表示为键/值对。 object
commitmentPlan 包含与此 Web 服务关联的承诺计划。 在创建时设置。 设置后,无法更改此值。 注意:对 GET 操作的调用不会返回承诺计划。 CommitmentPlanAutoGenerated
description Web 服务的说明。 字符串
诊断 控制 Web 服务的诊断跟踪集合的设置。 DiagnosticsConfiguration
exampleRequest 定义一个或多个服务输入的示例输入数据。 ExampleRequest
exposeSampleData 设置为 true 时,示例数据将包含在 Web 服务的 swagger 定义中。 默认值为 true。 bool
input 包含描述一个或多个 Web 服务输入的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
密钥 包含 Web 服务预配密钥。 如果未指定预配密钥,Azure 机器学习系统将为你生成这些密钥。 注意:密钥不会从对 GET 操作的调用中返回。 WebServiceKeys
machineLearningWorkspace 指定包含试验的机器学习工作区,该试验是 Web 服务的源。 MachineLearningWorkspace
output 包含描述一个或多个 Web 服务的输出的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
parameters 为 Web 服务定义的全局参数值集,作为默认值映射的全局参数名称提供。 如果未指定默认值,则认为参数是必需的。 object
readOnly 当设置为 true 时,指示 Web 服务是只读的,不能再更新或修补,只能删除。 默认值为 false。 注意:设置为 true 后,无法更改其值。 bool
realtimeConfiguration 包含 Web 服务终结点的配置设置。 RealtimeConfiguration
storageAccount 指定 Azure 机器学习用于存储 Web 服务相关信息的存储帐户。 对 GET 操作的调用仅返回存储帐户的名称。 更新存储帐户信息时,必须确保所有必需的资产在新存储帐户中可用,否则对 Web 服务的调用将失败。 StorageAccount
title Web 服务的标题。 字符串
packageType 设置对象类型 图形 (必需)

CommitmentPlanAutoGenerated

名称 说明 Value
id 指定与 Web 服务关联的承诺计划的 Azure 资源管理器 ID。 字符串 (必需)

DiagnosticsConfiguration

名称 说明 Value
expiry 指定日志记录将停止的日期和时间。 如果为 null,则诊断收集不受时间限制。 字符串
level 指定诊断输出的详细程度。 有效值为:无 - 禁用跟踪;错误 - 仅收集 stderr) 跟踪 (错误;All - 收集 stdout 和 stderr) (的所有跟踪。 “All”
“错误”
“None” (必需)

ExampleRequest

名称 说明 Value
globalParameters Web 服务的全局参数的示例输入数据 object
inputs Web 服务的输入 (的示例输入数据) 作为输入名称提供给示例输入值矩阵映射。 object

ServiceInputOutputSpecification

名称 说明 Value
description Swagger 架构的说明。 string
properties 指定包含 Web 服务每个输入或输出的列架构的集合。 有关详细信息,请参阅 Swagger 规范。 对象 (必需)
title Swagger 架构的标题。 字符串
type swagger 中所述的实体的类型。 始终为“object”。 字符串 (必需)

WebServiceKeys

名称 说明 Value
角色实体 主访问密钥。 字符串
次要区域。 辅助访问密钥。 字符串

MachineLearningWorkspace

名称 说明 Value
id 指定与 Web 服务关联的机器学习工作区的工作区 ID 字符串 (必需)

RealtimeConfiguration

名称 说明 Value
maxConcurrentCalls 指定可以对 Web 服务进行的最大并发调用。 最小值:4,最大值:200。 int

StorageAccount

名称 说明
指定用于访问存储帐户的密钥。 字符串
name 指定存储帐户的名称。 字符串

WebServicePropertiesForGraph

名称 说明 Value
packageType 指定包类型。 有效值为 Graph (指定通过机器学习工作室) 发布的 Web 服务,代码 (指定使用 Python) 等代码发布的 Web 服务。 注意:目前不支持代码。 “Graph” (必需)
组成此 Web 服务的图形包的定义。 GraphPackage

GraphPackage

名称 说明 Value
边缘 组成图形的边缘列表。 GraphEdge[]
graphParameters 图形的全局参数集合,作为 GraphParameter 映射的全局参数名称提供。 此处的每个参数都有一个 1:1 匹配项,该匹配项与在 WebServiceProperties 级别声明的全局参数值映射。 object
nodes 组成图形的节点集,作为 nodeId 提供给 GraphNode 映射 object

GraphEdge

名称 说明 Value
sourceNodeId 源图节点的标识符。 字符串
sourcePortId 边缘从其连接的源节点端口的标识符。 字符串
targetNodeId 目标图节点的标识符。 字符串
targetPortId 边缘连接到的目标节点端口的标识符。 字符串

ARM 模板资源定义

WebServices 资源类型可部署到:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearning/webServices 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.MachineLearning/webServices",
  "apiVersion": "2016-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "assets": {},
    "commitmentPlan": {
      "id": "string"
    },
    "description": "string",
    "diagnostics": {
      "expiry": "string",
      "level": "string"
    },
    "exampleRequest": {
      "globalParameters": {},
      "inputs": {}
    },
    "exposeSampleData": "bool",
    "input": {
      "description": "string",
      "properties": {},
      "title": "string",
      "type": "string"
    },
    "keys": {
      "primary": "string",
      "secondary": "string"
    },
    "machineLearningWorkspace": {
      "id": "string"
    },
    "output": {
      "description": "string",
      "properties": {},
      "title": "string",
      "type": "string"
    },
    "parameters": {},
    "readOnly": "bool",
    "realtimeConfiguration": {
      "maxConcurrentCalls": "int"
    },
    "storageAccount": {
      "key": "string",
      "name": "string"
    },
    "title": "string",
    "packageType": "string"
    // For remaining properties, see WebServiceProperties objects
  }
}

WebServiceProperties 对象

设置 packageType 属性以指定对象的类型。

对于 Graph,请使用:

  "packageType": "Graph",
  "package": {
    "edges": [
      {
        "sourceNodeId": "string",
        "sourcePortId": "string",
        "targetNodeId": "string",
        "targetPortId": "string"
      }
    ],
    "graphParameters": {},
    "nodes": {}
  }

属性值

webServices

名称 说明 Value
type 资源类型 “Microsoft.MachineLearning/webServices”
apiVersion 资源 API 版本 “2016-05-01-preview”
name 资源名称 字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*%&:?+/\\ 或控制字符

不得以空格结尾。
location 指定资源的位置。 字符串 (必需)
标记 包含定义为键/值对的资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 包含描述 Web 服务的属性有效负载。 需要 WebServiceProperties ()

WebServiceProperties

名称 说明 Value
资产 包含描述 Web 服务资产的用户定义属性。 属性表示为键/值对。 object
commitmentPlan 包含与此 Web 服务关联的承诺计划。 在创建时设置。 设置后,无法更改此值。 注意:对 GET 操作的调用不会返回承诺计划。 CommitmentPlanAutoGenerated
description Web 服务的说明。 字符串
诊断 控制 Web 服务的诊断跟踪集合的设置。 DiagnosticsConfiguration
exampleRequest 定义一个或多个服务输入的示例输入数据。 ExampleRequest
exposeSampleData 设置为 true 时,示例数据将包含在 Web 服务的 swagger 定义中。 默认值为 true。 bool
input 包含描述一个或多个 Web 服务的输入的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
密钥 包含 Web 服务预配密钥。 如果未指定预配密钥,Azure 机器学习系统会为你生成这些密钥。 注意:密钥不会从对 GET 操作的调用返回。 WebServiceKeys
machineLearningWorkspace 指定机器学习工作区,其中包含 Web 服务的源试验。 MachineLearningWorkspace
output 包含描述一个或多个 Web 服务的输出的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
parameters 为 Web 服务定义的一组全局参数值,作为全局参数名称提供给默认值映射。 如果未指定默认值,则将 参数视为必需参数。 object
readOnly 如果设置为 true,则表示 Web 服务是只读的,不能再更新或修补,只能删除。 默认值为 false。 注意:设置为 true 后,无法更改其值。 bool
realtimeConfiguration 包含 Web 服务终结点的配置设置。 RealtimeConfiguration
storageAccount 指定 Azure 机器学习用于存储有关 Web 服务的信息的存储帐户。 对 GET 操作的调用仅返回存储帐户的名称。 更新存储帐户信息时,必须确保所有必需的资产在新存储帐户中可用,否则对 Web 服务的调用将失败。 StorageAccount
title Web 服务的标题。 字符串
packageType 设置对象类型 图形 (必需)

CommitmentPlanAutoGenerated

名称 说明 Value
id 指定与 Web 服务关联的承诺计划的 Azure 资源管理器 ID。 字符串 (必需)

DiagnosticsConfiguration

名称 说明 Value
expiry 指定日志记录将停止的日期和时间。 如果为 null,则诊断收集不受时间限制。 字符串
level 指定诊断输出的详细程度。 有效值为:无 - 禁用跟踪;错误 - 仅收集 stderr) 跟踪 (错误;All - 收集 stdout 和 stderr) (的所有跟踪。 “All”
“错误”
“None” (必需)

ExampleRequest

名称 说明 Value
globalParameters Web 服务的全局参数的示例输入数据 object
inputs Web 服务的输入 (的示例输入数据) 作为输入名称提供给示例输入值矩阵映射。 object

ServiceInputOutputSpecification

名称 说明 Value
description Swagger 架构的说明。 string
properties 指定包含 Web 服务每个输入或输出的列架构的集合。 有关详细信息,请参阅 Swagger 规范。 对象 (必需)
title Swagger 架构的标题。 字符串
type swagger 中所述的实体的类型。 始终为“object”。 字符串 (必需)

WebServiceKeys

名称 说明 Value
角色实体 主访问密钥。 字符串
次要区域。 辅助访问密钥。 字符串

MachineLearningWorkspace

名称 说明 Value
id 指定与 Web 服务关联的机器学习工作区的工作区 ID 字符串 (必需)

RealtimeConfiguration

名称 说明 Value
maxConcurrentCalls 指定可以对 Web 服务进行的最大并发调用。 最小值:4,最大值:200。 int

StorageAccount

名称 说明
指定用于访问存储帐户的密钥。 字符串
name 指定存储帐户的名称。 字符串

WebServicePropertiesForGraph

名称 说明 Value
packageType 指定包类型。 有效值为 Graph (指定通过机器学习工作室) 发布的 Web 服务,代码 (指定使用 Python) 等代码发布的 Web 服务。 注意:目前不支持代码。 “Graph” (必需)
组成此 Web 服务的图形包的定义。 GraphPackage

GraphPackage

名称 说明 Value
边缘 组成图形的边缘列表。 GraphEdge[]
graphParameters 图形的全局参数集合,作为 GraphParameter 映射的全局参数名称提供。 此处的每个参数都有一个 1:1 匹配项,该匹配项与在 WebServiceProperties 级别声明的全局参数值映射。 object
nodes 组成图形的节点集,作为 nodeId 提供给 GraphNode 映射 object

GraphEdge

名称 说明 Value
sourceNodeId 源图节点的标识符。 字符串
sourcePortId 边缘从其连接的源节点端口的标识符。 字符串
targetNodeId 目标图节点的标识符。 字符串
targetPortId 边缘连接到的目标节点端口的标识符。 字符串

Terraform (AzAPI 提供程序) 资源定义

WebServices 资源类型可部署到:

  • 资源组

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearning/webServices 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearning/webServices@2016-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      assets = {}
      commitmentPlan = {
        id = "string"
      }
      description = "string"
      diagnostics = {
        expiry = "string"
        level = "string"
      }
      exampleRequest = {
        globalParameters = {}
        inputs = {}
      }
      exposeSampleData = bool
      input = {
        description = "string"
        properties = {}
        title = "string"
        type = "string"
      }
      keys = {
        primary = "string"
        secondary = "string"
      }
      machineLearningWorkspace = {
        id = "string"
      }
      output = {
        description = "string"
        properties = {}
        title = "string"
        type = "string"
      }
      parameters = {}
      readOnly = bool
      realtimeConfiguration = {
        maxConcurrentCalls = int
      }
      storageAccount = {
        key = "string"
        name = "string"
      }
      title = "string"
      packageType = "string"
      // For remaining properties, see WebServiceProperties objects
    }
  })
}

WebServiceProperties 对象

设置 packageType 属性以指定对象的类型。

对于 Graph,请使用:

  packageType = "Graph"
  package = {
    edges = [
      {
        sourceNodeId = "string"
        sourcePortId = "string"
        targetNodeId = "string"
        targetPortId = "string"
      }
    ]
    graphParameters = {}
    nodes = {}
  }

属性值

webServices

名称 说明 Value
type 资源类型 “Microsoft.MachineLearning/webServices@2016-05-01-preview”
name 资源名称 字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*%&:?+/\\ 或控制字符

不得以空格结尾。
location 指定资源的位置。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 包含定义为键/值对的资源标记。 标记名称和值的字典。
properties 包含描述 Web 服务的属性有效负载。 需要 WebServiceProperties ()

WebServiceProperties

名称 说明 Value
资产 包含描述 Web 服务资产的用户定义属性。 属性表示为键/值对。 object
commitmentPlan 包含与此 Web 服务关联的承诺计划。 在创建时设置。 设置后,无法更改此值。 注意:对 GET 操作的调用不会返回承诺计划。 CommitmentPlanAutoGenerated
description Web 服务的说明。 字符串
诊断 控制 Web 服务的诊断跟踪集合的设置。 DiagnosticsConfiguration
exampleRequest 定义一个或多个服务输入的示例输入数据。 ExampleRequest
exposeSampleData 设置为 true 时,示例数据将包含在 Web 服务的 swagger 定义中。 默认值为 true。 bool
input 包含描述一个或多个 Web 服务输入的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
密钥 包含 Web 服务预配密钥。 如果未指定预配密钥,Azure 机器学习系统将为你生成这些密钥。 注意:密钥不会从对 GET 操作的调用中返回。 WebServiceKeys
machineLearningWorkspace 指定包含试验的机器学习工作区,该试验是 Web 服务的源。 MachineLearningWorkspace
output 包含描述一个或多个 Web 服务的输出的 Swagger 2.0 架构。 有关详细信息,请参阅 Swagger 规范。 ServiceInputOutputSpecification
parameters 为 Web 服务定义的全局参数值集,作为默认值映射的全局参数名称提供。 如果未指定默认值,则认为参数是必需的。 object
readOnly 当设置为 true 时,指示 Web 服务是只读的,不能再更新或修补,只能删除。 默认值为 false。 注意:设置为 true 后,无法更改其值。 bool
realtimeConfiguration 包含 Web 服务终结点的配置设置。 RealtimeConfiguration
storageAccount 指定 Azure 机器学习用于存储 Web 服务相关信息的存储帐户。 对 GET 操作的调用仅返回存储帐户的名称。 更新存储帐户信息时,必须确保所有必需的资产在新存储帐户中可用,否则对 Web 服务的调用将失败。 StorageAccount
title Web 服务的标题。 字符串
packageType 设置对象类型 需要图形 ()

CommitmentPlanAutoGenerated

名称 说明 Value
id 指定与 Web 服务关联的承诺计划的 Azure 资源管理器 ID。 字符串 (必需)

DiagnosticsConfiguration

名称 说明 Value
expiry 指定日志记录停止的日期和时间。 如果为 null,则诊断收集不受时间限制。 字符串
level 指定诊断输出的详细程度。 有效值为:None - 禁用跟踪;Error - 仅收集 stderr) 跟踪 (错误;All - 收集 stdout 和 stderr) (的所有跟踪。 “全部”
“错误”
“None” (必需)

ExampleRequest

名称 说明 Value
globalParameters Web 服务的全局参数的示例输入数据 object
inputs Web 服务输入的示例输入数据 () 作为输入名称提供给示例输入值矩阵映射。 object

ServiceInputOutputSpecification

名称 说明 Value
description Swagger 架构的说明。 string
properties 指定包含 Web 服务每个输入或输出的列架构的集合。 有关详细信息,请参阅 Swagger 规范。 对象 (必需)
title Swagger 架构的标题。 字符串
type swagger 中所述的实体的类型。 始终为“object”。 字符串 (必需)

WebServiceKeys

名称 说明 Value
角色实体 主访问密钥。 字符串
次要区域。 辅助访问密钥。 字符串

MachineLearningWorkspace

名称 说明 Value
id 指定与 Web 服务关联的机器学习工作区的工作区 ID 字符串 (必需)

RealtimeConfiguration

名称 说明 Value
maxConcurrentCalls 指定可以对 Web 服务进行的最大并发调用。 最小值:4,最大值:200。 int

StorageAccount

名称 说明
指定用于访问存储帐户的密钥。 字符串
name 指定存储帐户的名称。 字符串

WebServicePropertiesForGraph

名称 说明 Value
packageType 指定包类型。 有效值为 Graph (指定通过机器学习工作室) 发布的 Web 服务,代码 (指定使用 Python) 等代码发布的 Web 服务。 注意:目前不支持代码。 “Graph” (必需)
组成此 Web 服务的图形包的定义。 GraphPackage

GraphPackage

名称 说明 Value
边缘 组成图形的边缘列表。 GraphEdge[]
graphParameters 图形的全局参数集合,作为 GraphParameter 映射的全局参数名称提供。 此处的每个参数都有一个 1:1 匹配项,该匹配项与在 WebServiceProperties 级别声明的全局参数值映射。 object
nodes 组成图形的节点集,作为 nodeId 提供给 GraphNode 映射 object

GraphEdge

名称 说明 Value
sourceNodeId 源图节点的标识符。 字符串
sourcePortId 边缘从其连接的源节点端口的标识符。 字符串
targetNodeId 目标图节点的标识符。 字符串
targetPortId 边缘连接到的目标节点端口的标识符。 字符串