SshPublicKeysOperations interface

Package:
@azure/arm-compute

Interface representing a SshPublicKeys operations.

Properties

create

Creates a new SSH public key resource.
delete
generateKeyPair

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

Retrieves information about an SSH public key.
listByResourceGroup

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

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

Updates a new SSH public key resource.

Property Details

create

Creates a new SSH public key resource.

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

Property Value

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

delete 

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

Property Value

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

generateKeyPair

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.

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

Property Value

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

get

Retrieves information about an SSH public key.

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

Property Value

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

listByResourceGroup

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.

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

Property Value

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

listBySubscription

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.

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

Property Value

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

update

Updates a new SSH public key resource.

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

Property Value

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