az ml index

Note

This reference is part of the ml extension for the Azure CLI (version 2.15.0 or higher). 该扩展将在首次运行 az ml index 命令时自动安装。 Learn more about extensions.

此命令组处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

管理 Azure ML 索引。

命令

名称	说明	类型	Status
az ml index create	创建索引。	Extension	Preview
az ml index list	列出工作区中的索引。	Extension	Preview
az ml index show	显示工作区中索引的详细信息。	Extension	Preview

az ml index create

预览

命令组“ml index”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

创建索引。

可以从本地文件、本地目录、数据存储或远程 URI 创建索引。 创建的索引将在工作区中跟踪指定的名称和版本。

az ml index create [--datastore]
                   [--description]
                   [--file]
                   [--name]
                   [--path]
                   [--registry-name]
                   [--resource-group]
                   [--set]
                   [--stage]
                   [--tags]
                   [--version]
                   [--workspace-name]

示例

从 YAML 规范文件创建索引

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

从指向本地文件夹的路径创建索引

az ml index create --name my-index --version 1 --path ./my-index --resource-group my-resource-group --workspace-name my-workspace

从数据存储的路径创建索引

az ml index create --name my-index --version 1 --path azureml://datastores/myblobstore/paths/indexes/MLIndex --resource-group my-resource-group --workspace-name my-workspace

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--datastore

要将本地项目上传到的数据存储。

--description

索引的说明。

--file -f

包含 Azure ML 索引规范的 YAML 文件的本地路径。 可以在以下位置找到索引的 YAML 参考文档。

--name -n

索引的名称。

--path -p

索引文件的路径。 这可以是本地位置，也可以是远程位置。 如果指定，还必须提供 --name/-n。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--set

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

--stage -s

索引的阶段。

--tags

对象的标记的空间分隔键值对。

--version -v

索引的版本。

--workspace-name -w

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az ml index list

预览

命令组“ml index”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

列出工作区中的索引。

az ml index list [--max-results]
                 [--name]
                 [--registry-name]
                 [--resource-group]
                 [--workspace-name]

示例

列出工作区中的所有索引

az ml index list --resource-group my-resource-group --workspace-name my-workspace

列出工作区中指定名称的所有索引版本

az ml index list --name my-index --resource-group my-resource-group --workspace-name my-workspace

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

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-results -r

要返回的最大结果数。

--name -n

索引的名称。 如果提供，将返回此名称下的所有索引版本。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--workspace-name -w

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az ml index show

预览

命令组“ml index”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

显示工作区中索引的详细信息。

az ml index show --name
                 [--label]
                 [--registry-name]
                 [--resource-group]
                 [--version]
                 [--workspace-name]

示例

显示具有指定名称和版本的索引的详细信息

az ml index show --name my-index --version 1 --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

索引的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--label -l

索引的标签。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--version -v

索引的版本。

--workspace-name -w

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False