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

az sphere catalog

注意

此参考是 Azure CLI(版本 2.45.0 或更高版本)的 azure-sphere 扩展的一部分。 该扩展将在首次运行 az sphere catalog 命令时自动安装。 详细了解扩展。

管理目录。

命令

名称 说明 类型 Status
az sphere catalog create

创建目录。

扩展 GA
az sphere catalog delete

删除目录。

扩展 GA
az sphere catalog download-error-report

列出或下载所选目录的可用错误报告。

扩展 GA
az sphere catalog list

列出资源组或订阅中的可用目录。

扩展 GA
az sphere catalog show

显示目录的详细信息。

扩展 GA

az sphere catalog create

创建目录。

az sphere catalog create --name
                         --resource-group

示例

在资源组“MyResourceGroup”中创建新的目录“MyCatalog”。

az sphere catalog create --resource-group MyResourceGroup --name MyCatalog

必需参数

--name -n

目录的名称。 允许字母数字字符、下划线和连字符,并且必须小于 30 个字符。

--resource-group -g

Azure 资源组的名称。 可以使用 az config set defaults.group=<name> 配置默认组。 值来源:az group list。

全局参数
--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 sphere catalog delete

删除目录。

az sphere catalog delete --catalog
                         --resource-group

示例

使用资源组和目录名称删除目录。

az sphere catalog delete --resource-group MyResourceGroup --catalog MyCatalog

必需参数

--catalog -c

目录名称。

值来源: az sphere catalog list
--resource-group -g

Azure 资源组的名称。 可以使用 az config set defaults.group=<name> 配置默认组。 值来源:az group list。

全局参数
--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 sphere catalog download-error-report

列出或下载所选目录的可用错误报告。

az sphere catalog download-error-report --catalog
                                        --resource-group
                                        [--output-file]

示例

使用资源组和目录名称在 csv 文件中下载错误报告。

az sphere catalog download-error-report --resource-group MyResourceGroup --catalog MyCatalog --output-file myErrorReport.csv

必需参数

--catalog -c

要在其中执行此操作的 Azure Sphere 目录。 指定 Azure Sphere 目录名称。 可以使用 配置默认的 Azure Sphere 目录 az config set defaults.sphere.catalog=<name>。 值来源:az sphere catalog list。

--resource-group -g

Azure 资源组的名称。 可以使用 az config set defaults.group=<name> 配置默认组。 值来源:az group list。

可选参数

--output-file -of

要创建的新 csv 文件的路径,其中包含错误报告数据。 你可以提供相对或绝对路径。 如果未设置此参数,该文件将保存在具有默认名称的当前文件夹中。 (路径)。

全局参数
--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 sphere catalog list

列出资源组或订阅中的可用目录。

az sphere catalog list [--all]
                       [--resource-group]

示例

列出资源组中的所有目录。

az sphere catalog list --resource-group MyResourceGroup

列出订阅中所有资源组中的所有目录。

az sphere catalog list --all

可选参数

--all

列出订阅中所有资源组中的所有目录。

默认值: False
--resource-group -g

Azure 资源组的名称。 可以使用 az config set defaults.group=<name> 配置默认组。 值来源:az group list。

全局参数
--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 sphere catalog show

显示目录的详细信息。

az sphere catalog show --catalog
                       --resource-group

示例

使用资源组和目录名称显示目录的详细信息。

az sphere catalog show --resource-group MyResourceGroup --catalog MyCatalog

必需参数

--catalog -c

目录名称。

值来源: az sphere catalog list
--resource-group -g

Azure 资源组的名称。 可以使用 az config set defaults.group=<name> 配置默认组。 值来源:az group list。

全局参数
--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 获取完整的调试日志。