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

SshPublicKeys interface

包:

@azure/arm-compute

表示 SshPublicKeys 的接口。

方法

create(string, string, SshPublicKeyResource, SshPublicKeysCreateOptionalParams)	创建新的 SSH 公钥资源。
delete(string, string, SshPublicKeysDeleteOptionalParams)	删除 SSH 公钥。
generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)	生成并返回公钥/私钥对，并使用公钥填充 SSH 公钥资源。 密钥的长度将为 3072 位。 此作只能为每个 SSH 公钥资源执行一次。
get(string, string, SshPublicKeysGetOptionalParams)	检索有关 SSH 公钥的信息。
listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)	列出指定资源组中的所有 SSH 公钥。 使用响应中的 nextLink 属性获取 SSH 公钥的下一页。
listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)	列出订阅中的所有 SSH 公钥。 使用响应中的 nextLink 属性获取 SSH 公钥的下一页。
update(string, string, SshPublicKeyUpdateResource, SshPublicKeysUpdateOptionalParams)	更新新的 SSH 公钥资源。

方法详细信息

create(string, string, SshPublicKeyResource, SshPublicKeysCreateOptionalParams)

创建新的 SSH 公钥资源。

function create(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyResource, options?: SshPublicKeysCreateOptionalParams): Promise<SshPublicKeyResource>

参数

resourceGroupName

string

资源组的名称。

sshPublicKeyName

string

SSH 公钥的名称。

parameters

SshPublicKeyResource

提供用于创建 SSH 公钥的参数。

options

SshPublicKeysCreateOptionalParams

选项参数。

返回

Promise<SshPublicKeyResource>

delete(string, string, SshPublicKeysDeleteOptionalParams)

删除 SSH 公钥。

function delete(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

资源组的名称。

sshPublicKeyName

string

SSH 公钥的名称。

options

SshPublicKeysDeleteOptionalParams

选项参数。

返回

Promise<void>

generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)

生成并返回公钥/私钥对，并使用公钥填充 SSH 公钥资源。 密钥的长度将为 3072 位。 此作只能为每个 SSH 公钥资源执行一次。

function generateKeyPair(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGenerateKeyPairOptionalParams): Promise<SshPublicKeyGenerateKeyPairResult>

参数

resourceGroupName

string

资源组的名称。

sshPublicKeyName

string

SSH 公钥的名称。

options

SshPublicKeysGenerateKeyPairOptionalParams

选项参数。

返回

Promise<SshPublicKeyGenerateKeyPairResult>

get(string, string, SshPublicKeysGetOptionalParams)

检索有关 SSH 公钥的信息。

function get(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGetOptionalParams): Promise<SshPublicKeyResource>

参数

resourceGroupName

string

资源组的名称。

sshPublicKeyName

string

SSH 公钥的名称。

options

SshPublicKeysGetOptionalParams

选项参数。

返回

Promise<SshPublicKeyResource>

listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)

列出指定资源组中的所有 SSH 公钥。 使用响应中的 nextLink 属性获取 SSH 公钥的下一页。

function listByResourceGroup(resourceGroupName: string, options?: SshPublicKeysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

参数

resourceGroupName

string

资源组的名称。

options

SshPublicKeysListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)

列出订阅中的所有 SSH 公钥。 使用响应中的 nextLink 属性获取 SSH 公钥的下一页。

function listBySubscription(options?: SshPublicKeysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

参数

options

SshPublicKeysListBySubscriptionOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

update(string, string, SshPublicKeyUpdateResource, SshPublicKeysUpdateOptionalParams)

更新新的 SSH 公钥资源。

function update(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyUpdateResource, options?: SshPublicKeysUpdateOptionalParams): Promise<SshPublicKeyResource>

参数

resourceGroupName

string

资源组的名称。

sshPublicKeyName

string

SSH 公钥的名称。

parameters

SshPublicKeyUpdateResource

提供用于更新 SSH 公钥的参数。

options

SshPublicKeysUpdateOptionalParams

选项参数。

返回

Promise<SshPublicKeyResource>