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

SshPublicKeys interface

Package:

@azure/arm-compute

Interface representing a SshPublicKeys.

Methods

create(string, string, SshPublicKeyResource, SshPublicKeysCreateOptionalParams)	Creates a new SSH public key resource.
delete(string, string, SshPublicKeysDeleteOptionalParams)	Delete an SSH public key.
generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)	Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.
get(string, string, SshPublicKeysGetOptionalParams)	Retrieves information about an SSH public key.
listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)	Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.
listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)	Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.
update(string, string, SshPublicKeyUpdateResource, SshPublicKeysUpdateOptionalParams)	Updates a new SSH public key resource.

Method Details

create(string, string, SshPublicKeyResource, SshPublicKeysCreateOptionalParams)

Creates a new SSH public key resource.

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

Parameters

resourceGroupName

string

The name of the resource group.

sshPublicKeyName

string

The name of the SSH public key.

parameters

SshPublicKeyResource

Parameters supplied to create the SSH public key.

options

SshPublicKeysCreateOptionalParams

The options parameters.

Returns

Promise<SshPublicKeyResource>

delete(string, string, SshPublicKeysDeleteOptionalParams)

Delete an SSH public key.

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

Parameters

resourceGroupName

string

The name of the resource group.

sshPublicKeyName

string

The name of the SSH public key.

options

SshPublicKeysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

generateKeyPair(string, string, SshPublicKeysGenerateKeyPairOptionalParams)

Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.

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

Parameters

resourceGroupName

string

The name of the resource group.

sshPublicKeyName

string

The name of the SSH public key.

options

SshPublicKeysGenerateKeyPairOptionalParams

The options parameters.

Returns

Promise<SshPublicKeyGenerateKeyPairResult>

get(string, string, SshPublicKeysGetOptionalParams)

Retrieves information about an SSH public key.

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

Parameters

resourceGroupName

string

The name of the resource group.

sshPublicKeyName

string

The name of the SSH public key.

options

SshPublicKeysGetOptionalParams

The options parameters.

Returns

Promise<SshPublicKeyResource>

listByResourceGroup(string, SshPublicKeysListByResourceGroupOptionalParams)

Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

SshPublicKeysListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

listBySubscription(SshPublicKeysListBySubscriptionOptionalParams)

Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.

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

Parameters

options

SshPublicKeysListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SshPublicKeyResource, SshPublicKeyResource[], PageSettings>

update(string, string, SshPublicKeyUpdateResource, SshPublicKeysUpdateOptionalParams)

Updates a new SSH public key resource.

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

Parameters

resourceGroupName

string

The name of the resource group.

sshPublicKeyName

string

The name of the SSH public key.

parameters

SshPublicKeyUpdateResource

Parameters supplied to update the SSH public key.

options

SshPublicKeysUpdateOptionalParams

The options parameters.

Returns

Promise<SshPublicKeyResource>