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

az sshkey

  • 参考

使用 vm 管理 ssh 公钥。

命令

名称 说明 类型 状态
az sshkey create

创建新的 SSH 公钥资源。

 核心 GA
az sshkey delete

删除 SSH 公钥。

 核心 GA
az sshkey list

列出所有 SSH 公钥。

 核心 GA
az sshkey show

检索有关 SSH 公钥的信息。

 核心 GA
az sshkey update

更新 SSH 公钥资源。

 核心 GA

az sshkey create

创建新的 SSH 公钥资源。

az sshkey create --name
                 --resource-group
                 [--encryption-type {Ed25519, RSA}]
                 [--location]
                 [--public-key]
                 [--tags]

示例

创建新的 SSH 公钥资源。

az sshkey create --location "westus" --public-key "{ssh-rsa public key}" --resource-group "myResourceGroup" --name "mySshPublicKeyName"

使用文件中的公钥创建新的 SSH 公钥资源。

az sshkey create --location "westus" --public-key "@filename" --resource-group "myResourceGroup" --name "mySshPublicKeyName"

使用自动生成的值创建新的 SSH 公钥资源。

az sshkey create --location "westus" --resource-group "myResourceGroup" --name "mySshPublicKeyName"

使用 Ed25519 加密创建新的 SSH 公钥资源。

az sshkey create --location "westus" --resource-group "myResourceGroup" --name "mySshPublicKeyName" --encryption-type "Ed25519"

必需参数

--name --ssh-public-key-name -n

SSH 公钥的名称。

--resource-group -g

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

可选参数

--encryption-type

要生成的 SSH 密钥的加密类型。

接受的值: Ed25519, RSA
默认值: RSA
--location -l

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

--public-key

用于通过 ssh 向虚拟机进行身份验证的 SSH 公钥。 如果在创建资源时最初未提供此属性，则会在调用 generateKeyPair 时填充 publicKey 属性。 如果在创建资源时提供了公钥，则提供的公钥必须至少为 2048 位且采用 ssh-rsa 格式。

--tags

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

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

删除 SSH 公钥。

az sshkey delete [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]
                 [--yes]

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --ssh-public-key-name -n

SSH 公钥的名称。

--resource-group -g

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

--subscription

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

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

列出所有 SSH 公钥。

az sshkey list [--resource-group]

可选参数

--resource-group -g

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

检索有关 SSH 公钥的信息。

az sshkey show [--ids]
               [--name]
               [--resource-group]
               [--subscription]

示例

获取 ssh 公钥。

az sshkey show --resource-group "myResourceGroup" --name "mySshPublicKeyName"

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --ssh-public-key-name -n

SSH 公钥的名称。

--resource-group -g

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

--subscription

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

全局参数
--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 sshkey update

更新 SSH 公钥资源。

az sshkey update [--ids]
                 [--name]
                 [--public-key]
                 [--resource-group]
                 [--subscription]
                 [--tags]

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --ssh-public-key-name -n

SSH 公钥的名称。

--public-key

用于通过 ssh 向虚拟机进行身份验证的 SSH 公钥。 如果在创建资源时最初未提供此属性，则会在调用 generateKeyPair 时填充 publicKey 属性。 如果在创建资源时提供了公钥，则提供的公钥必须至少为 2048 位且采用 ssh-rsa 格式。

--resource-group -g

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

--subscription

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

--tags

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

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