exec.azurerm.compute.ssh_public_key

Azure Resource Manager (ARM) Compute SSH Public Key Execution Module

New in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.compute.ssh_public_key.create(hub, ctx, name, resource_group, public_key=None, tags=None, **kwargs)

New in version 4.0.0.

Creates a new SSH public key resource.

Parameters:
  • name – The name of the SSH public key.
  • resource_group – The name of the resource group name assigned to the SSH public key.
  • public_key – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the public_key parameter will be populated when the generate_key_pair module is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
  • tags – A dictionary of strings can be passed as tag metadata to the SSH public key resource object.

CLI Example:

azurerm.compute.ssh_public_key.create test_name test_group
idem_azurerm.exec.azurerm.compute.ssh_public_key.delete(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Delete an SSH public key.

Parameters:
  • name – The SSH public key to delete.
  • resource_group – The resource group name assigned to the SSH public key.

CLI Example:

azurerm.compute.ssh_public_key.delete test_name test_group
idem_azurerm.exec.azurerm.compute.ssh_public_key.generate_key_pair(hub, ctx, name, resource_group, public_key=None, tags=None, **kwargs)

New in version 4.0.0.

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:
  • name – The name of the SSH public key.
  • resource_group – The name of the resource group name assigned to the SSH public key.

CLI Example:

azurerm.compute.ssh_public_key.generate_key_pair test_name test_group
idem_azurerm.exec.azurerm.compute.ssh_public_key.get(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Retrieves information about an SSH public key.

Parameters:
  • name – The SSH public key to get.
  • resource_group – The resource group name assigned to the SSH public key.

CLI Example:

azurerm.compute.ssh_public_key.get test_name test_group
idem_azurerm.exec.azurerm.compute.ssh_public_key.list_(hub, ctx, resource_group=None, **kwargs)

New in version 4.0.0.

Lists all of the SSH public keys in the subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.compute.ssh_public_key.list
idem_azurerm.exec.azurerm.compute.ssh_public_key.update(hub, ctx, name, resource_group, public_key=None, tags=None, **kwargs)

New in version 4.0.0.

Creates a new SSH public key resource.

Parameters:
  • name – The name of the SSH public key.
  • resource_group – The name of the resource group name assigned to the SSH public key.
  • public_key – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the public_key parameter will be populated when the generate_key_pair module is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
  • tags – A dictionary of strings can be passed as tag metadata to the SSH public key resource object.

CLI Example:

azurerm.compute.ssh_public_key.create test_name test_group