Package version:

Interface SshPublicKeys

Interface representing a SshPublicKeys.

interface SshPublicKeys {
    create(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyResource, options?: SshPublicKeysCreateOptionalParams): Promise<SshPublicKeyResource>;
    delete(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysDeleteOptionalParams): Promise<void>;
    generateKeyPair(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGenerateKeyPairOptionalParams): Promise<SshPublicKeyGenerateKeyPairResult>;
    get(resourceGroupName: string, sshPublicKeyName: string, options?: SshPublicKeysGetOptionalParams): Promise<SshPublicKeyResource>;
    listByResourceGroup(resourceGroupName: string, options?: SshPublicKeysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource>;
    listBySubscription(options?: SshPublicKeysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SshPublicKeyResource>;
    update(resourceGroupName: string, sshPublicKeyName: string, parameters: SshPublicKeyUpdateResource, options?: SshPublicKeysUpdateOptionalParams): Promise<SshPublicKeyResource>;
}

Methods

create(resourceGroupName, sshPublicKeyName, parameters, options?): Promise<SshPublicKeyResource>
Creates a new SSH public key resource.
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.
- Optionaloptions: SshPublicKeysCreateOptionalParams
  The options parameters.
Returns Promise<SshPublicKeyResource>
- Defined in operationsInterfaces/sshPublicKeys.ts:54

generateKeyPair(resourceGroupName, sshPublicKeyName, options?): Promise<SshPublicKeyGenerateKeyPairResult>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- sshPublicKeyName: string
  The name of the SSH public key.
- Optionaloptions: SshPublicKeysGenerateKeyPairOptionalParams
  The options parameters.
Returns Promise<SshPublicKeyGenerateKeyPairResult>
- Defined in operationsInterfaces/sshPublicKeys.ts:103

get(resourceGroupName, sshPublicKeyName, options?): Promise<SshPublicKeyResource>
Retrieves information about an SSH public key.
Parameters
- resourceGroupName: string
  The name of the resource group.
- sshPublicKeyName: string
  The name of the SSH public key.
- Optionaloptions: SshPublicKeysGetOptionalParams
  The options parameters.
Returns Promise<SshPublicKeyResource>
- Defined in operationsInterfaces/sshPublicKeys.ts:90

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<SshPublicKeyResource>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: SshPublicKeysListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<SshPublicKeyResource>
- Defined in operationsInterfaces/sshPublicKeys.ts:43

update(resourceGroupName, sshPublicKeyName, parameters, options?): Promise<SshPublicKeyResource>
Updates a new SSH public key resource.
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.
- Optionaloptions: SshPublicKeysUpdateOptionalParams
  The options parameters.
Returns Promise<SshPublicKeyResource>
- Defined in operationsInterfaces/sshPublicKeys.ts:67