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

az ml online-endpoint

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的 ml 扩展的一部分。 该扩展将在首次运行 az ml online-endpoint 命令时自动安装。 详细了解扩展。

管理 Azure ML 联机终结点。

Azure ML 终结点提供用于创建和管理模型部署的简单界面。 每个终结点可以有一个或多个部署，使来自单个评分终结点的流量能够在需要时提供给多个部署。 这对于受控推出等方案非常有用。

Azure ML 支持两种类型的终结点：联机和批处理。 联机终结点支持实时推理，而批处理终结点则用于脱机批处理评分。

命令

名称	说明	类型	状态
az ml online-endpoint create	创建终结点。	扩展	GA
az ml online-endpoint delete	删除终结点。	扩展	GA
az ml online-endpoint get-credentials	列出联机终结点的令牌/密钥。	扩展	GA
az ml online-endpoint invoke	调用终结点。	扩展	GA
az ml online-endpoint list	列出工作区中的终结点。	扩展	GA
az ml online-endpoint regenerate-keys	重新生成联机终结点的密钥。	扩展	GA
az ml online-endpoint show	显示终结点的详细信息。	扩展	GA
az ml online-endpoint update	更新终结点。	扩展	GA

az ml online-endpoint create

创建终结点。

若要创建终结点，请提供具有联机终结点配置的 YAML 文件。 如果终结点已存在，它将失败。 如果要更新现有终结点，请使用 az ml online-endpoint update。

az ml online-endpoint create --resource-group
                             --workspace-name
                             [--auth-mode]
                             [--file]
                             [--local {false, true}]
                             [--name]
                             [--no-wait]
                             [--set]
                             [--web]

示例

从 YAML 规范文件创建终结点

az ml online-endpoint create --file endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--auth-mode

终结点的身份验证方法。 允许的值：键、aml_token。 默认值：键。

--file -f

包含 Azure ML 联机终结点规范的 YAML 文件的本地路径。 可在以下位置找到联机终结点的 YAML 参考文档。 https://aka.ms/ml-cli-v2-endpoint-online-yaml-reference

--local

在本地创建终结点。 注意：本地不支持流量和身份验证。 可以直接使用“az ml online-deployment create --local”。 如果终结点不存在，它将创建一个终结点。

接受的值: false, true

默认值: False

--name -n

联机终结点的名称。

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示终结点的详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint delete

删除终结点。

az ml online-endpoint delete --name
                             --resource-group
                             --workspace-name
                             [--local {false, true}]
                             [--no-wait]
                             [--yes]

示例

删除联机终结点，包括其所有部署

az ml online-endpoint delete --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

联机终结点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--local

删除本地终结点。

接受的值: false, true

默认值: False

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint get-credentials

列出联机终结点的令牌/密钥。

az ml online-endpoint get-credentials --name
                                      --resource-group
                                      --workspace-name

示例

列出联机终结点的密钥

az ml online-endpoint get-credentials --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

联机终结点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint invoke

调用终结点。

可以使用某些请求数据调用联机终结点。 这是实时推理，评分结果将立即返回。

az ml online-endpoint invoke --name
                             --resource-group
                             --workspace-name
                             [--deployment-name]
                             [--local {false, true}]
                             [--request-file]

示例

使用某些请求数据调用联机终结点

az ml online-endpoint invoke --name my-online-endpoint --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

调用联机终结点，以特定部署为目标

az ml online-endpoint invoke --name my-online-endpoint --deployment my-deployment --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

联机终结点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--deployment-name -d

要面向的部署的名称。

--local

调用本地终结点。 仅当为此终结点创建了本地部署时，此操作才起作用。

接受的值: false, true

默认值: False

--request-file -r

包含请求数据的 JSON 文件的本地路径。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint list

列出工作区中的终结点。

az ml online-endpoint list --resource-group
                           --workspace-name
                           [--local {false, true}]

示例

列出工作区中的所有联机终结点

az ml online-endpoint list --resource-group my-resource-group --workspace-name my-workspace

列出工作区中的所有批处理终结点

az ml online-endpoint list  --resource-group my-resource-group --workspace-name my-workspace

使用 --query 参数对命令结果执行 JMESPath 查询，列出工作区中的所有联机终结点。

az ml online-endpoint list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--local

列出所有本地终结点。

接受的值: false, true

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint regenerate-keys

重新生成联机终结点的密钥。

az ml online-endpoint regenerate-keys --name
                                      --resource-group
                                      --workspace-name
                                      [--key-type]
                                      [--no-wait]

示例

重新生成联机终结点的密钥

az ml online-endpoint regenerate-keys --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

联机终结点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--key-type

要重新生成的密钥的类型。 允许的值：主要值、辅助值。

默认值: primary

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint show

显示终结点的详细信息。

az ml online-endpoint show --name
                           --resource-group
                           --workspace-name
                           [--local {false, true}]
                           [--web]

示例

显示批处理终结点的详细信息

az ml online-endpoint show --name my-online-endpoint  --resource-group my-resource-group --workspace-name my-workspace

使用 --query 参数对命令结果执行 JMESPath 查询，显示终结点的预配状态。

az ml online-endpoint show -n my-endpoint --query "{Name:name,State:provisioning_state}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

联机终结点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--local

显示本地终结点。

接受的值: false, true

默认值: False

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示终结点的详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml online-endpoint update

更新终结点。

可以更新终结点的“description”、“tags”和“traffic”属性。 此外，可以将新部署添加到终结点，并且可以更新现有部署。

az ml online-endpoint update --resource-group
                             --workspace-name
                             [--add]
                             [--file]
                             [--force-string]
                             [--local {false, true}]
                             [--mirror-traffic]
                             [--name]
                             [--no-wait]
                             [--remove]
                             [--set]
                             [--traffic]
                             [--web]

示例

从 YAML 规范文件更新终结点

az ml online-endpoint update --file updated_endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

更新终结点的流量设置

az ml online-endpoint update --name my-online-endpoint  --traffic "my-new-deployment=100" --resource-group my-resource-group --workspace-name my-workspace

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--file -f

包含 Azure ML 联机终结点规范的 YAML 文件的本地路径。 可在以下位置找到联机终结点的 YAML 参考文档。 https://aka.ms/ml-cli-v2-endpoint-online-yaml-reference

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--local

更新本地终结点。

接受的值: false, true

默认值: False

--mirror-traffic

将实时流量的重复百分比定向到训练部署。

--name -n

联机终结点的名称。

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

默认值: []

--traffic -r

终结点的流量设置的空格分隔键值对（以引号为单位）。

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示终结点的详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。