az customlocation

Note

This reference is part of the customlocation extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az customlocation command. Learn more about extensions.

用于创建、获取、列出和删除 CustomLocations 的命令。

命令

名称	说明	类型	Status
az customlocation create	创建自定义位置。	Extension	GA
az customlocation delete	删除 Customlocation。	Extension	GA
az customlocation list	用于列出 CustomLocations 的命令。	Extension	GA
az customlocation list-enabled-resource-types	获取 CustomLocation 的已启用资源类型的详细信息。	Extension	GA
az customlocation patch	修补自定义位置。	Extension	GA
az customlocation show	获取 Customlocation 的详细信息。	Extension	GA
az customlocation update	更新自定义位置。	Extension	GA

az customlocation create

创建自定义位置。

az customlocation create --cluster-extension-ids
                         --host-resource-id
                         --name
                         --namespace
                         --resource-group
                         [--assign-identity]
                         [--kubeconfig]
                         [--location]
                         [--tags]

必需参数

--cluster-extension-ids -c

群集扩展 ID 的空间分隔列表 - 采用 /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--host-resource-id

连接的群集的主机资源 ID。

--name -n

Customlocation 的名称。

--namespace

自定义位置的命名空间。 对于命名空间范围的扩展，这应与与群集扩展运算符关联的命名空间匹配。

--resource-group -g

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

可选参数

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

--assign-identity

使用“SystemAssigned”或“None”类型标识创建自定义分配资源。

--kubeconfig -k

群集的管理员 Kubeconfig。 如果群集是未启用 AAD 的群集，则需要作为文件传入。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 customlocation delete

删除 Customlocation。

az customlocation delete --name
                         --resource-group
                         [--yes]

必需参数

--name -n

Customlocation 的名称。

--resource-group -g

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

可选参数

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

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--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 customlocation list

用于列出 CustomLocations 的命令。

az customlocation list [--resource-group]

可选参数

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

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 customlocation list-enabled-resource-types

获取 CustomLocation 的已启用资源类型的详细信息。

az customlocation list-enabled-resource-types --name
                                              --resource-group

必需参数

--name -n

Customlocation 的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 customlocation patch

修补自定义位置。

az customlocation patch --name
                        --resource-group
                        [--assign-identity]
                        [--cluster-extension-ids]
                        [--display-name]
                        [--host-resource-id]
                        [--namespace]
                        [--tags]

必需参数

--name -n

Customlocation 的名称。

--resource-group -g

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

可选参数

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

--assign-identity

使用“SystemAssigned”或“None”类型标识创建自定义分配资源。

--cluster-extension-ids -c

群集扩展 ID 的空间分隔列表 - 采用 /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--display-name -d

自定义位置的显示名称。

--host-resource-id

连接的群集的主机资源 ID。

--namespace

自定义位置的命名空间。 对于命名空间范围的扩展，这应与与群集扩展运算符关联的命名空间匹配。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 customlocation show

获取 Customlocation 的详细信息。

az customlocation show --name
                       --resource-group

必需参数

--name -n

Customlocation 的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 customlocation update

更新自定义位置。

az customlocation update --cluster-extension-ids
                         --host-resource-id
                         --name
                         --namespace
                         --resource-group
                         [--assign-identity]
                         [--location]
                         [--tags]

必需参数

--cluster-extension-ids -c

群集扩展 ID 的空间分隔列表 - 采用 /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--host-resource-id

连接的群集的主机资源 ID。

--name -n

Customlocation 的名称。

--namespace

自定义位置的命名空间。 对于命名空间范围的扩展，这应与与群集扩展运算符关联的命名空间匹配。

--resource-group -g

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

可选参数

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

--assign-identity

使用“SystemAssigned”或“None”类型标识创建自定义分配资源。

--location -l

自定义位置资源的位置。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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