SshPublicKeys interface
Interface representing a SshPublicKeys.
Methods
| create(string, string, Ssh |
Creates a new SSH public key resource. |
| delete(string, string, Ssh |
Delete an SSH public key. |
| generate |
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, Ssh |
Retrieves information about an SSH public key. |
| list |
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. |
| list |
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, Ssh |
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.
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.
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.
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.
The options parameters.
Returns
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
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<SshPublicKeyResource>