ssh_public_keys

Creates, updates, deletes, gets or lists a ssh_public_keys resource.

Overview

Name	ssh_public_keys
Type	Resource
Id	azure.compute.ssh_public_keys

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Properties of the SSH public key.
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Properties of the SSH public key.
tags	object	Resource tags
type	string	Resource type

list_by_subscription

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Properties of the SSH public key.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sshPublicKeyName, subscriptionId		Retrieves information about an SSH public key.
list_by_resource_group	select	resourceGroupName, subscriptionId		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_by_subscription	select	subscriptionId		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.
create	insert	resourceGroupName, sshPublicKeyName, subscriptionId		Creates a new SSH public key resource.
update	update	resourceGroupName, sshPublicKeyName, subscriptionId		Updates a new SSH public key resource.
delete	delete	resourceGroupName, sshPublicKeyName, subscriptionId		Delete an SSH public key.
generate_key_pair	exec	resourceGroupName, sshPublicKeyName, subscriptionId		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group.
sshPublicKeyName	string	The name of the SSH public key.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieves information about an SSH public key.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.ssh_public_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sshPublicKeyName = '{{ sshPublicKeyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.ssh_public_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

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.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.ssh_public_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new SSH public key resource.

INSERT INTO azure.compute.ssh_public_keys (
data__properties,
data__location,
data__tags,
resourceGroupName,
sshPublicKeyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ sshPublicKeyName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ssh_public_keys
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ssh_public_keys resource.
    - name: sshPublicKeyName
      value: string
      description: Required parameter for the ssh_public_keys resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the ssh_public_keys resource.
    - name: properties
      value: object
      description: |
        Properties of the SSH public key.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Updates a new SSH public key resource.

UPDATE azure.compute.ssh_public_keys
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND sshPublicKeyName = '{{ sshPublicKeyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete an SSH public key.

DELETE FROM azure.compute.ssh_public_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sshPublicKeyName = '{{ sshPublicKeyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

generate_key_pair

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.

EXEC azure.compute.ssh_public_keys.generate_key_pair 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sshPublicKeyName='{{ sshPublicKeyName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"encryptionType": "{{ encryptionType }}"
}'
;